org.scijava
Interface UIDetails

All Superinterfaces:

BasicDetails, Comparable<Prioritized>, Prioritized

All Known Subinterfaces:

ModuleInfo, MutableModuleInfo

All Known Implementing Classes:

AbstractModuleInfo, AbstractUIDetails, CommandInfo, DefaultMutableModuleInfo, DynamicCommandInfo, PluginInfo, ScriptInfo

public interface UIDetails
extends BasicDetails, Prioritized

An interface defining details useful for generating relevant user interface elements.

Author:

Curtis Rueden

Field Summary

static String

APPLICATION_MENU_ROOT The default, application-level menu root.

Method Summary

String	getIconPath() Gets the resource path to an icon representing the object.
MenuPath	getMenuPath() Gets the path to the object's suggested position in the menu structure.
String	getMenuRoot() Gets the name of the menu structure to which the object belongs.
String	getSelectionGroup() Gets the name of the selection group to which the object belongs.
String	getTitle() Gets an appropriate title for the object, for use in a user interface.
boolean	isEnabled() Gets whether the object should be enabled in the user interface.
boolean	isSelectable() Gets whether the object can be selected (e.g., checking and unchecking its menu item) in the user interface.
boolean	isSelected() Gets whether the object is selected (e.g., its menu item is checked) in the user interface.
boolean	isVisible() Gets whether the object should be visible in the user interface.
void	setEnabled(boolean enabled) Sets whether the object should be enabled in the user interface.
void	setIconPath(String iconPath) Sets the resource path to an icon representing the object.
void	setMenuPath(MenuPath menuPath) Sets the path to the object's suggested position in the menu structure.
void	setMenuRoot(String menuRoot) Sets the name of the menu structure to which the object belongs.
void	setSelectable(boolean selectable) Sets whether the object can be selected (e.g., checking and unchecking its menu item) in the user interface.
void	setSelected(boolean selected) Sets whether the object is selected (e.g., its menu item is checked) in the user interface.
void	setSelectionGroup(String selectionGroup) Sets the name of the selection group to which the object belongs.
void	setVisible(boolean visible) Sets whether the object should be visible in the user interface.

Methods inherited from interface org.scijava.BasicDetails

get, getDescription, getLabel, getName, is, set, setDescription, setLabel, setName

Methods inherited from interface org.scijava.Prioritized

getPriority, setPriority

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

APPLICATION_MENU_ROOT

static final String APPLICATION_MENU_ROOT

The default, application-level menu root.

See Also:

getMenuRoot(), Constant Field Values

Method Detail

getTitle

String getTitle()

Gets an appropriate title for the object, for use in a user interface. The result is prioritized as follows:

1. Item label
2. Menu path's leaf entry name
3. Item name
4. Item's class name, without package prefix

getMenuPath

MenuPath getMenuPath()

Gets the path to the object's suggested position in the menu structure.

getMenuRoot

String getMenuRoot()

Gets the name of the menu structure to which the object belongs.

getIconPath

String getIconPath()

Gets the resource path to an icon representing the object.

isSelectable

boolean isSelectable()

Gets whether the object can be selected (e.g., checking and unchecking its menu item) in the user interface.

getSelectionGroup

String getSelectionGroup()

Gets the name of the selection group to which the object belongs. Only one object in a particular selection group can be selected at a time.

isSelected

boolean isSelected()

Gets whether the object is selected (e.g., its menu item is checked) in the user interface.

isEnabled

boolean isEnabled()

Gets whether the object should be enabled in the user interface.

isVisible

boolean isVisible()

Gets whether the object should be visible in the user interface.

setMenuPath

void setMenuPath(MenuPath menuPath)

Sets the path to the object's suggested position in the menu structure.

setMenuRoot

void setMenuRoot(String menuRoot)

Sets the name of the menu structure to which the object belongs.

setIconPath

void setIconPath(String iconPath)

Sets the resource path to an icon representing the object.

setEnabled

void setEnabled(boolean enabled)

Sets whether the object should be enabled in the user interface.

setVisible

void setVisible(boolean visible)

Sets whether the object should be visible in the user interface.

setSelectable

void setSelectable(boolean selectable)

Sets whether the object can be selected (e.g., checking and unchecking its menu item) in the user interface.

setSelectionGroup

void setSelectionGroup(String selectionGroup)

Sets the name of the selection group to which the object belongs. Only one object in a particular selection group can be selected at a time.

setSelected

void setSelected(boolean selected)

Sets whether the object is selected (e.g., its menu item is checked) in the user interface.