org.scijava.ui.UIService Maven / Gradle / Ivy
/*
* #%L
* SciJava Common shared library for SciJava software.
* %%
* Copyright (C) 2009 - 2017 Board of Regents of the University of
* Wisconsin-Madison, Broad Institute of MIT and Harvard, Max Planck
* Institute of Molecular Cell Biology and Genetics, University of
* Konstanz, and KNIME GmbH.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
* #L%
*/
package org.scijava.ui;
import java.io.File;
import java.io.FileFilter;
import java.util.List;
import org.scijava.app.StatusService;
import org.scijava.app.event.StatusEvent;
import org.scijava.display.Display;
import org.scijava.plugin.PluginInfo;
import org.scijava.service.SciJavaService;
import org.scijava.ui.viewer.DisplayViewer;
import org.scijava.widget.FileWidget;
/**
* Interface for service that handles user interfaces.
*
* @author Curtis Rueden
*/
public interface UIService extends SciJavaService {
// CTR TODO: Extend SingletonService.
/** System property to set for overriding the default UI. */
String UI_PROPERTY = "scijava.ui";
/**
* Adds the given UI to those managed by the service.
*
* Note that a UI added explicitly via this method will never be considered
* the default UI unless {@link #setDefaultUI(UserInterface)} is also called.
*
*
* @param ui The UI to add.
*/
void addUI(UserInterface ui);
/**
* Adds the given UI to those managed by the service.
*
* Note that a UI added explicitly via this method will never be considered
* the default UI unless {@link #setDefaultUI(UserInterface)} is also called.
*
*
* @param name The nickname for the UI.
* @param ui The UI to add.
*/
void addUI(String name, UserInterface ui);
/**
* Displays the UI for the default user interface.
*
* @see #getDefaultUI()
* @see #setDefaultUI(UserInterface)
*/
void showUI();
/** Displays the UI with the given name (or class name). */
void showUI(String name);
/** Displays the given UI. */
void showUI(UserInterface ui);
/**
* Gets whether the default UI is visible.
*
* @see #getDefaultUI()
* @see #setDefaultUI(UserInterface)
*/
boolean isVisible();
/** Gets whether the UI with the given name or class name is visible. */
boolean isVisible(String name);
/** Sets whether the application is running in headless mode (no UI). */
void setHeadless(boolean isHeadless);
/** Gets whether the UI is running in headless mode (no UI). */
boolean isHeadless();
/**
* Gets the default user interface.
*
* @see #showUI()
* @see #isVisible()
*/
UserInterface getDefaultUI();
/**
* Sets the default user interface.
*
* @see #showUI()
*/
void setDefaultUI(UserInterface ui);
/**
* Gets whether the UI with the given name (or class name) is the default one.
*/
boolean isDefaultUI(String name);
/** Gets the UI with the given name (or class name). */
UserInterface getUI(String name);
/** Gets the user interfaces available to the service. */
List getAvailableUIs();
/** Gets the user interfaces that are currently visible. */
List getVisibleUIs();
/** Gets the list of known viewer plugins. */
List>> getViewerPlugins();
/** Registers the given viewer with the service. */
void addDisplayViewer(DisplayViewer viewer);
/** Gets the UI widget being used to visualize the given {@link Display}. */
DisplayViewer getDisplayViewer(Display display);
/**
* Creates a {@link Display} for the given object, and shows it using an
* appropriate UI widget of the default user interface.
*/
void show(Object o);
/**
* Creates a {@link Display} for the given object, and shows it using an
* appropriate UI widget of the default user interface.
*
* @param name The name to use when displaying the object.
* @param o The object to be displayed.
*/
void show(String name, Object o);
/**
* Creates and shows the given {@link Display} using an appropriate UI widget
* of the default user interface.
*/
void show(Display display);
/**
* Displays a dialog prompt.
*
* The prompt is displayed in the default user interface.
*
*
* @param message The message in the dialog itself.
* @return The choice selected by the user when dismissing the dialog.
*/
DialogPrompt.Result showDialog(String message);
/**
* Displays a dialog prompt.
*
* The prompt is displayed in the default user interface.
*
*
* @param message The message in the dialog itself.
* @param messageType The type of message. This typically is rendered as an
* icon next to the message. For example,
* {@link DialogPrompt.MessageType#WARNING_MESSAGE} typically appears
* as an exclamation point.
* @return The choice selected by the user when dismissing the dialog.
*/
DialogPrompt.Result showDialog(String message,
DialogPrompt.MessageType messageType);
/**
* Displays a dialog prompt.
*
* The prompt is displayed in the default user interface.
*
*
* @param message The message in the dialog itself.
* @param messageType The type of message. This typically is rendered as an
* icon next to the message. For example,
* {@link DialogPrompt.MessageType#WARNING_MESSAGE} typically appears
* as an exclamation point.
* @param optionType The choices available when dismissing the dialog. These
* choices are typically rendered as buttons for the user to click.
* @return The choice selected by the user when dismissing the dialog.
*/
DialogPrompt.Result showDialog(String message,
DialogPrompt.MessageType messageType, DialogPrompt.OptionType optionType);
/**
* Displays a dialog prompt.
*
* The prompt is displayed in the default user interface.
*
*
* @param message The message in the dialog itself.
* @param title The title of the dialog.
* @return The choice selected by the user when dismissing the dialog.
*/
DialogPrompt.Result showDialog(String message, String title);
/**
* Displays a dialog prompt.
*
* The prompt is displayed in the default user interface.
*
*
* @param message The message in the dialog itself.
* @param title The title of the dialog.
* @param messageType The type of message. This typically is rendered as an
* icon next to the message. For example,
* {@link DialogPrompt.MessageType#WARNING_MESSAGE} typically appears
* as an exclamation point.
* @return The choice selected by the user when dismissing the dialog.
*/
DialogPrompt.Result showDialog(String message, String title,
DialogPrompt.MessageType messageType);
/**
* Displays a dialog prompt.
*
* The prompt is displayed in the default user interface.
*
*
* @param message The message in the dialog itself.
* @param title The title of the dialog.
* @param messageType The type of message. This typically is rendered as an
* icon next to the message. For example,
* {@link DialogPrompt.MessageType#WARNING_MESSAGE} typically appears
* as an exclamation point.
* @param optionType The choices available when dismissing the dialog. These
* choices are typically rendered as buttons for the user to click.
* @return The choice selected by the user when dismissing the dialog.
*/
DialogPrompt.Result showDialog(String message, String title,
DialogPrompt.MessageType messageType, DialogPrompt.OptionType optionType);
/**
* Prompts the user to choose a file.
*
* The prompt is displayed in the default user interface.
*
*
* @param file The initial value displayed in the file chooser prompt.
* @param style The style of chooser to use:
*
* - {@link FileWidget#OPEN_STYLE}
* - {@link FileWidget#SAVE_STYLE}
* - {@link FileWidget#DIRECTORY_STYLE}
*
*/
File chooseFile(File file, String style);
/**
* Prompts the user to choose a file.
*
* The prompt is displayed in the default user interface.
*
*
* @param title Title to use in the file chooser dialog.
* @param file The initial value displayed in the file chooser prompt.
* @param style The style of chooser to use:
*
* - {@link FileWidget#OPEN_STYLE}
* - {@link FileWidget#SAVE_STYLE}
* - {@link FileWidget#DIRECTORY_STYLE}
*
*/
File chooseFile(String title, File file, String style);
/**
* Prompts the user to select one or multiple files.
*
* The prompt is displayed in the default user interface.
*
*
* @param files The initial value displayed in the file chooser prompt.
* @param filter A filter allowing to restrict the choice of files
*/
File[] chooseFiles(File parent, File[] files, FileFilter filter, String style);
/**
* Prompts the user to select one or multiple files.
*
* The prompt is displayed in the default user interface.
*
*
* @param fileList The initial value displayed in the file chooser prompt.
* @param filter A filter allowing to restrict the choice of files
*/
List chooseFiles(File parent, List fileList, FileFilter filter, String style);
/**
* Displays a popup context menu for the given display at the specified
* position.
*
* The context menu is displayed in the default user interface.
*
*/
void showContextMenu(String menuRoot, Display display, int x, int y);
/**
* Gets the status message associated with the given event.
*
* @see StatusService#getStatusMessage(String, StatusEvent)
*/
String getStatusMessage(StatusEvent statusEvent);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy