public interface UIDetails extends BasicDetails, Prioritized
Modifier and Type | Field and Description |
---|---|
static String |
APPLICATION_MENU_ROOT
The default, application-level menu root.
|
Modifier and Type | Method and Description |
---|---|
default int |
compareTo(Prioritized that) |
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.
|
default 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.
|
get, getDescription, getLabel, is, set, setDescription, setLabel
getPriority, setPriority
static final String APPLICATION_MENU_ROOT
getMenuRoot()
,
Constant Field Valuesdefault String getTitle()
MenuPath getMenuPath()
String getMenuRoot()
String getIconPath()
boolean isSelectable()
String getSelectionGroup()
boolean isSelected()
boolean isEnabled()
boolean isVisible()
void setMenuPath(MenuPath menuPath)
void setMenuRoot(String menuRoot)
void setIconPath(String iconPath)
void setEnabled(boolean enabled)
void setVisible(boolean visible)
void setSelectable(boolean selectable)
void setSelectionGroup(String selectionGroup)
void setSelected(boolean selected)
default int compareTo(Prioritized that)
compareTo
in interface Comparable<Prioritized>
compareTo
in interface Prioritized
Copyright © 2015–2022 SciJava. All rights reserved.