org.hkijena.jipipe.ui.grapheditor.general.contextmenu

Interface NodeUIContextAction

All Known Implementing Classes:

AddBookmarkNodeUIContextAction, AddTemplateContextMenuAction, AlgorithmGraphCopyNodeUIContextAction, AlgorithmGraphCutNodeUIContextAction, AlgorithmGraphDuplicateNodeUIContextAction, AlgorithmGraphPasteNodeUIContextAction, CollapseIOInterfaceNodeUIContextAction, DeleteCompartmentUIContextAction, DeleteNodeUIContextAction, DisableNodeUIContextAction, DisablePassThroughNodeUIContextAction, DisableSaveOutputsNodeUIContextAction, DisableVirtualOutputNodeUIContextAction, EnableNodeUIContextAction, EnablePassThroughNodeUIContextAction, EnableSaveOutputsNodeUIContextAction, EnableVirtualOutputsNodeUIContextAction, ExportCompartmentAsJsonNodeUIContextAction, ExportCompartmentToNodeUIContextAction, ExportNodeUIContextAction, GraphCompartmentCopyNodeUIContextAction, GraphCompartmentCutNodeUIContextAction, GraphCompartmentPasteNodeUIContextAction, GroupNodeUIContextAction, InvertSelectionNodeUIContextAction, IsolateNodesUIContextAction, JsonAlgorithmToGroupNodeUIContextAction, LoadExampleContextMenuAction, MoveNodeUIDownContextAction, MoveNodeUILeftContextAction, MoveNodeUIRightContextAction, MoveNodeUIUpContextAction, NodeContextActionWrapperUIContextAction, OpenCacheBrowserInWindowUIContextAction, ParameterExplorerContextMenuAction, RemoveBookmarkNodeUIContextAction, RunAndShowIntermediateResultsNodeUIContextAction, RunAndShowResultsNodeUIContextAction, SelectAllNodeUIContextAction, SelectAndMoveNodeHereNodeUIContextAction, SetNodeHotkeyContextAction, UpdateCacheNodeUIContextAction, UpdateCacheShowIntermediateNodeUIContextAction

public interface NodeUIContextAction

An action that is applied one or multiple algorithms

Field Summary

Fields

Modifier and Type	Field and Description
static NodeUIContextAction	SEPARATOR Indicates that a separator is created

Method Summary

Modifier and Type	Method and Description
default boolean	disableOnNonMatch() Determines if an item should be disabled or removed if it does not match
String	getDescription()
Icon	getIcon()
default KeyStroke	getKeyboardShortcut() Returns an optional keyboard shortcut.
String	getName()
default boolean	isHidden() Determines if the item is never shown (even if it applies) Keyboard shortcuts still work
boolean	matches(Set<JIPipeNodeUI> selection) Returns if the action shows up
void	run(JIPipeGraphCanvasUI canvasUI, Set<JIPipeNodeUI> selection) Runs the workload
default boolean	showInCompartmentGraph() Determines if the item is displayed in the compartment graph.
default boolean	showInGraphCompartment() Determines if the item is displayed in the graph compartment (project/group/extension editor).

Field Detail

SEPARATOR

static final NodeUIContextAction SEPARATOR

Indicates that a separator is created

Method Detail

matches

boolean matches(Set<JIPipeNodeUI> selection)

Returns if the action shows up

Parameters:

selection - the list of algorithm UIs

Returns:

if the action shows up

run

void run(JIPipeGraphCanvasUI canvasUI,
         Set<JIPipeNodeUI> selection)

Runs the workload

Parameters:

canvasUI - the canvas that contains all algorithm UIs

selection - the current selection of algorithms

getName

String getName()

Returns:

the name

getDescription

String getDescription()

Returns:

the description

getIcon

Icon getIcon()

Returns:

the icon

isHidden

default boolean isHidden()

Determines if the item is never shown (even if it applies) Keyboard shortcuts still work

Returns:

if the item is hidden

disableOnNonMatch

default boolean disableOnNonMatch()

Determines if an item should be disabled or removed if it does not match

Returns:

if an item should be disabled or removed if it does not match

getKeyboardShortcut

default KeyStroke getKeyboardShortcut()

Returns an optional keyboard shortcut. Can be null

Returns:

Keyboard shortcut or null

showInCompartmentGraph

default boolean showInCompartmentGraph()

Determines if the item is displayed in the compartment graph.

Returns:

if the item is displayed

showInGraphCompartment

default boolean showInGraphCompartment()

Determines if the item is displayed in the graph compartment (project/group/extension editor).

Returns:

if the item is displayed