Package sc.fiji.snt.gui

Enum Class ContextMenuCommand

java.lang.Object

java.lang.Enum<ContextMenuCommand>

sc.fiji.snt.gui.ContextMenuCommand

All Implemented Interfaces:

Serializable, Comparable<ContextMenuCommand>, java.lang.constant.Constable

public enum ContextMenuCommand
extends Enum<ContextMenuCommand>

Non-editing commands shared by the contextual menus of the tracing canvas and of the Bdv/Bvv viewers: single source of truth for their labels and icons, so that both front-ends expose the same entries. Shortcuts and tooltips are not defined here because they differ between front-ends (e.g., bookmarking is Shift+B in the canvas and M in the viewers). Node-editing commands are defined in NodeEditCommand.

Author:

Tiago Ferreira

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ContextMenuCommand.Labels	The labels as compile-time constants, for front-ends that dispatch on them (e.g., in a switch)

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
APPEND
BOOKMARK
BRIGHTEST
DESELECT_LAST
EXTEND
FINISH
FORK
GRAB
HIDE
LASSO
ORIENTATION
PAUSE_SNT
PAUSE_TRACING
SELECT_NONE
SHOLL
UNDO_SEGMENT

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HIDE_KEY_TIP	Hold-key descriptions used by GuiUtils.showKeyTip(sc.fiji.snt.SNTPrefs, String, String)
static final String	ORIENTATION_KEY_TIP

Method Summary

Modifier and Type	Method	Description
void	applyIcon(JMenuItem item)	Assigns the icon of this command to a menu item.
String	label()
static ContextMenuCommand	of(Component c)
<T extends JMenuItem> T	tag(T item)	Flags a menu item as the front-end of this command (see of(Component))
static ContextMenuCommand	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ContextMenuCommand[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GRAB

public static final ContextMenuCommand GRAB

APPEND

public static final ContextMenuCommand APPEND

DESELECT_LAST

public static final ContextMenuCommand DESELECT_LAST

SELECT_NONE

public static final ContextMenuCommand SELECT_NONE

LASSO

public static final ContextMenuCommand LASSO

HIDE

public static final ContextMenuCommand HIDE

ORIENTATION

public static final ContextMenuCommand ORIENTATION

BOOKMARK

public static final ContextMenuCommand BOOKMARK

SHOLL

public static final ContextMenuCommand SHOLL

BRIGHTEST

public static final ContextMenuCommand BRIGHTEST

EXTEND

public static final ContextMenuCommand EXTEND

FORK

public static final ContextMenuCommand FORK

UNDO_SEGMENT

public static final ContextMenuCommand UNDO_SEGMENT

FINISH

public static final ContextMenuCommand FINISH

PAUSE_TRACING

public static final ContextMenuCommand PAUSE_TRACING

PAUSE_SNT

public static final ContextMenuCommand PAUSE_SNT

Field Details

HIDE_KEY_TIP

public static final String HIDE_KEY_TIP

Hold-key descriptions used by GuiUtils.showKeyTip(sc.fiji.snt.SNTPrefs, String, String)

See Also:

• Constant Field Values

ORIENTATION_KEY_TIP

public static final String ORIENTATION_KEY_TIP

See Also:

• Constant Field Values

Method Details

values

public static ContextMenuCommand[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ContextMenuCommand valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

tag

public <T extends JMenuItem> T tag(T item)

Flags a menu item as the front-end of this command (see of(Component))

Parameters:

item - the menu item

Returns:

the item, for chaining

of

public static ContextMenuCommand of(Component c)

Parameters:

c - the component, e.g., a menu item

Returns:

the command the component was tagged with, or null

label

public String label()

Returns:

the menu label

applyIcon

public void applyIcon(JMenuItem item)

Assigns the icon of this command to a menu item. Colors are resolved on every call, so that the icon matches the current look and feel

Parameters:

item - the menu item