org.scijava
Class AbstractUIDetails

java.lang.Object
  org.scijava.AbstractUIDetails

All Implemented Interfaces:

Comparable<Prioritized>, BasicDetails, Prioritized, UIDetails

Direct Known Subclasses:

PluginInfo

public abstract class AbstractUIDetails
extends Object
implements UIDetails

Abstract superclass of UIDetails implementations.

Author:

Curtis Rueden

Field Summary

Fields inherited from interface org.scijava.UIDetails

APPLICATION_MENU_ROOT

Constructor Summary

AbstractUIDetails()

Method Summary

int	compareTo(Prioritized that)
String	getDescription() Gets a string describing the object.
String	getIconPath() Gets the resource path to an icon representing the object.
String	getLabel() Gets the name to appear in a UI, if applicable.
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	getName() Gets the unique name of the object.
double	getPriority() Gets the sort priority of the object.
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	setDescription(String description) Sets a string describing the object.
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	setLabel(String label) Sets the name to appear in a UI, if applicable.
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	setName(String name) Sets the unique name of the object.
void	setPriority(double priority) Sets the sort priority of the object.
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.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractUIDetails

public AbstractUIDetails()

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getTitle

public String getTitle()

Description copied from interface: UIDetails

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

Specified by:

getTitle in interface UIDetails

getMenuPath

public MenuPath getMenuPath()

Description copied from interface: UIDetails

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

Specified by:

getMenuPath in interface UIDetails

getMenuRoot

public String getMenuRoot()

Description copied from interface: UIDetails

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

Specified by:

getMenuRoot in interface UIDetails

getIconPath

public String getIconPath()

Description copied from interface: UIDetails

Gets the resource path to an icon representing the object.

Specified by:

getIconPath in interface UIDetails

isEnabled

public boolean isEnabled()

Description copied from interface: UIDetails

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

Specified by:

isEnabled in interface UIDetails

isVisible

public boolean isVisible()

Description copied from interface: UIDetails

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

Specified by:

isVisible in interface UIDetails

isSelectable

public boolean isSelectable()

Description copied from interface: UIDetails

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

Specified by:

isSelectable in interface UIDetails

getSelectionGroup

public String getSelectionGroup()

Description copied from interface: UIDetails

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.

Specified by:

getSelectionGroup in interface UIDetails

isSelected

public boolean isSelected()

Description copied from interface: UIDetails

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

Specified by:

isSelected in interface UIDetails

setMenuPath

public void setMenuPath(MenuPath menuPath)

Description copied from interface: UIDetails

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

Specified by:

setMenuPath in interface UIDetails

setMenuRoot

public void setMenuRoot(String menuRoot)

Description copied from interface: UIDetails

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

Specified by:

setMenuRoot in interface UIDetails

setIconPath

public void setIconPath(String iconPath)

Description copied from interface: UIDetails

Sets the resource path to an icon representing the object.

Specified by:

setIconPath in interface UIDetails

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: UIDetails

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

Specified by:

setEnabled in interface UIDetails

setVisible

public void setVisible(boolean visible)

Description copied from interface: UIDetails

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

Specified by:

setVisible in interface UIDetails

setSelectable

public void setSelectable(boolean selectable)

Description copied from interface: UIDetails

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

Specified by:

setSelectable in interface UIDetails

setSelectionGroup

public void setSelectionGroup(String selectionGroup)

Description copied from interface: UIDetails

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.

Specified by:

setSelectionGroup in interface UIDetails

setSelected

public void setSelected(boolean selected)

Description copied from interface: UIDetails

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

Specified by:

setSelected in interface UIDetails

getName

public String getName()

Description copied from interface: BasicDetails

Gets the unique name of the object.

Specified by:

getName in interface BasicDetails

getLabel

public String getLabel()

Description copied from interface: BasicDetails

Gets the name to appear in a UI, if applicable.

Specified by:

getLabel in interface BasicDetails

getDescription

public String getDescription()

Description copied from interface: BasicDetails

Gets a string describing the object.

Specified by:

getDescription in interface BasicDetails

setName

public void setName(String name)

Description copied from interface: BasicDetails

Sets the unique name of the object.

Specified by:

setName in interface BasicDetails

setLabel

public void setLabel(String label)

Description copied from interface: BasicDetails

Sets the name to appear in a UI, if applicable.

Specified by:

setLabel in interface BasicDetails

setDescription

public void setDescription(String description)

Description copied from interface: BasicDetails

Sets a string describing the object.

Specified by:

setDescription in interface BasicDetails

getPriority

public double getPriority()

Description copied from interface: Prioritized

Gets the sort priority of the object.

Specified by:

getPriority in interface Prioritized

See Also:

Priority

setPriority

public void setPriority(double priority)

Description copied from interface: Prioritized

Sets the sort priority of the object.

Specified by:

setPriority in interface Prioritized

See Also:

Priority

compareTo

public int compareTo(Prioritized that)

Specified by:

compareTo in interface Comparable<Prioritized>