org.hkijena.jipipe.desktop.app.grapheditor.commons

Class AbstractJIPipeDesktopGraphEditorUI

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.hkijena.jipipe.desktop.app.JIPipeDesktopWorkbenchPanel

org.hkijena.jipipe.desktop.app.grapheditor.commons.AbstractJIPipeDesktopGraphEditorUI

All Implemented Interfaces:

MouseListener, MouseMotionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, JIPipeWorkbenchAccess, JIPipeGraph.GraphChangedEventListener, JIPipeDesktopGraphCanvasUI.NodeSelectionChangedEventListener, JIPipeDesktopGraphCanvasUI.NodeUISelectedEventListener, JIPipeDesktopGraphNodeUI.DefaultNodeUIActionRequestedEventListener, JIPipeDesktopGraphNodeUI.NodeUIActionRequestedEventListener, JIPipeDesktopWorkbenchAccess, JIPipeDesktopDockPanel.PanelSideVisibilityChangedEventListener, JIPipeDesktopDockPanel.StateSavedEventListener, org.scijava.Disposable

Direct Known Subclasses:

JIPipeDesktopCompartmentsGraphEditorUI, JIPipeDesktopPipelineGraphEditorUI, JIPipeDesktopRunSingleAlgorithmSettingsPanelIOEditor

public abstract class AbstractJIPipeDesktopGraphEditorUI
extends JIPipeDesktopWorkbenchPanel
implements MouseListener, MouseMotionListener, org.scijava.Disposable, JIPipeGraph.GraphChangedEventListener, JIPipeDesktopGraphCanvasUI.NodeSelectionChangedEventListener, JIPipeDesktopGraphCanvasUI.NodeUISelectedEventListener, JIPipeDesktopGraphNodeUI.DefaultNodeUIActionRequestedEventListener, JIPipeDesktopGraphNodeUI.NodeUIActionRequestedEventListener, JIPipeDesktopDockPanel.StateSavedEventListener, JIPipeDesktopDockPanel.PanelSideVisibilityChangedEventListener

A panel around JIPipeDesktopGraphCanvasUI that comes with scrolling/panning, properties panel, and a menu bar

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractJIPipeDesktopGraphEditorUI.NavigationRenderer Renders items in the navigator

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOCK_BOOKMARKS
static String	DOCK_CALCULATOR
static String	DOCK_ERRORS
static String	DOCK_HISTORY
static String	DOCK_LOG
static String	DOCK_MAP
static KeyStroke	KEY_STROKE_MOVE_SELECTION_DOWN
static KeyStroke	KEY_STROKE_MOVE_SELECTION_LEFT
static KeyStroke	KEY_STROKE_MOVE_SELECTION_RIGHT
static KeyStroke	KEY_STROKE_MOVE_SELECTION_UP
static KeyStroke	KEY_STROKE_REDO
static KeyStroke	KEY_STROKE_UNDO
static KeyStroke	KEY_STROKE_ZOOM_IN
static KeyStroke	KEY_STROKE_ZOOM_OUT
static KeyStroke	KEY_STROKE_ZOOM_RESET

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
AbstractJIPipeDesktopGraphEditorUI(JIPipeDesktopWorkbench workbenchUI, JIPipeGraph graph, UUID compartment, JIPipeHistoryJournal historyJournal)
AbstractJIPipeDesktopGraphEditorUI(JIPipeDesktopWorkbench workbenchUI, JIPipeGraph graph, UUID compartment, JIPipeHistoryJournal historyJournal, JIPipeGraphEditorUIApplicationSettings settings)

Method Summary

Modifier and Type	Method and Description
void	addToSelection(JIPipeDesktopGraphNodeUI ui) Adds an algorithm to the selection
abstract void	beforeOpenContextMenu(JPopupMenu menu) Executed before opening the context menu Right before adding the partition entries and after all auto-generated items
void	clearSelection() Clears the algorithm selection
void	createScreenshotClipboard()
void	dispose()
Set<JIPipeNodeInfo>	getAddableAlgorithms()
JIPipeDesktopGraphCanvasUI	getCanvasUI()
UUID	getCompartment()
JIPipeToggleableGraphEditorTool	getCurrentTool()
JIPipeGraphEditorTool	getDefaultTool()
JIPipeDesktopDockPanel	getDockPanel()
protected abstract StringAndStringPairParameter.List	getDockStateTemplates()
JIPipeGraph	getGraph()
JIPipeGraphEditorUIApplicationSettings	getGraphUISettings()
JIPipeHistoryJournal	getHistoryJournal()
JScrollPane	getScrollPane()
Set<JIPipeDesktopGraphNodeUI>	getSelection()
List<JIPipeGraphEditorTool>	getTools()
void	mouseClicked(MouseEvent e)
void	mouseDragged(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mouseMoved(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
void	onDefaultNodeUIActionRequested(JIPipeDesktopGraphNodeUI.DefaultNodeUIActionRequestedEvent event)
void	onDockPanelStateSaved(JIPipeDesktopDockPanel.StateSavedEvent event)
void	onGraphCanvasNodeSelectionChanged(JIPipeDesktopGraphCanvasUI.NodeSelectionChangedEvent event)
void	onGraphChanged(JIPipeGraph.GraphChangedEvent event)
void	onNodeUIActionRequested(JIPipeDesktopGraphNodeUI.NodeUIActionRequestedEvent event)
void	onNodeUISelected(JIPipeDesktopGraphCanvasUI.NodeUISelectedEvent event)
void	onPanelSideVisibilityChanged(JIPipeDesktopDockPanel.PanelSideVisibilityChangedEvent event)
void	removeFromSelection(JIPipeDesktopGraphNodeUI ui) Removes an algorithm from the selection
protected abstract void	restoreDefaultDockState()
protected abstract void	restoreDockStateFromSettings()
protected abstract void	saveDockStateToSettings()
void	scrollToAlgorithm(JIPipeDesktopGraphNodeUI ui) Scrolls to the specified algorithm UI
void	selectDefaultTool()
void	selectOnly(JIPipeDesktopGraphNodeUI ui) Selects only the specified algorithm
void	selectTool(JIPipeGraphEditorTool tool)
void	setAddableAlgorithms(Set<JIPipeNodeInfo> addableAlgorithms)
void	updateContextToolbar()
protected void	updateSelection()

Methods inherited from class org.hkijena.jipipe.desktop.app.JIPipeDesktopWorkbenchPanel

getDesktopWorkbench, getWorkbench

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

DOCK_LOG

public static final String DOCK_LOG

See Also:

Constant Field Values

DOCK_HISTORY

public static final String DOCK_HISTORY

See Also:

Constant Field Values

DOCK_BOOKMARKS

public static final String DOCK_BOOKMARKS

See Also:

Constant Field Values

DOCK_MAP

public static final String DOCK_MAP

See Also:

Constant Field Values

DOCK_ERRORS

public static final String DOCK_ERRORS

See Also:

Constant Field Values

DOCK_CALCULATOR

public static final String DOCK_CALCULATOR

See Also:

Constant Field Values

KEY_STROKE_UNDO

public static final KeyStroke KEY_STROKE_UNDO

KEY_STROKE_REDO

public static final KeyStroke KEY_STROKE_REDO

KEY_STROKE_ZOOM_IN

public static final KeyStroke KEY_STROKE_ZOOM_IN

KEY_STROKE_ZOOM_OUT

public static final KeyStroke KEY_STROKE_ZOOM_OUT

KEY_STROKE_ZOOM_RESET

public static final KeyStroke KEY_STROKE_ZOOM_RESET

KEY_STROKE_MOVE_SELECTION_LEFT

public static final KeyStroke KEY_STROKE_MOVE_SELECTION_LEFT

KEY_STROKE_MOVE_SELECTION_RIGHT

public static final KeyStroke KEY_STROKE_MOVE_SELECTION_RIGHT

KEY_STROKE_MOVE_SELECTION_UP

public static final KeyStroke KEY_STROKE_MOVE_SELECTION_UP

KEY_STROKE_MOVE_SELECTION_DOWN

public static final KeyStroke KEY_STROKE_MOVE_SELECTION_DOWN

Constructor Detail

AbstractJIPipeDesktopGraphEditorUI

public AbstractJIPipeDesktopGraphEditorUI(JIPipeDesktopWorkbench workbenchUI,
                                          JIPipeGraph graph,
                                          UUID compartment,
                                          JIPipeHistoryJournal historyJournal,
                                          JIPipeGraphEditorUIApplicationSettings settings)

Parameters:

workbenchUI - the workbench

graph - the algorithm graph

compartment - the graph compartment to display. Set to null to display all compartments

historyJournal - object that tracks the history of this graph. Set to null to disable the undo feature.

AbstractJIPipeDesktopGraphEditorUI

public AbstractJIPipeDesktopGraphEditorUI(JIPipeDesktopWorkbench workbenchUI,
                                          JIPipeGraph graph,
                                          UUID compartment,
                                          JIPipeHistoryJournal historyJournal)

Parameters:

workbenchUI - the workbench

graph - the algorithm graph

compartment - the graph compartment to display. Set to null to display all compartments

historyJournal - object that tracks the history of this graph. Set to null to disable the undo feature.

Method Detail

restoreDockStateFromSettings

protected abstract void restoreDockStateFromSettings()

saveDockStateToSettings

protected abstract void saveDockStateToSettings()

dispose

public void dispose()

Specified by:

dispose in interface org.scijava.Disposable

onDockPanelStateSaved

public void onDockPanelStateSaved(JIPipeDesktopDockPanel.StateSavedEvent event)

Specified by:

onDockPanelStateSaved in interface JIPipeDesktopDockPanel.StateSavedEventListener

getGraphUISettings

public JIPipeGraphEditorUIApplicationSettings getGraphUISettings()

getScrollPane

public JScrollPane getScrollPane()

getCanvasUI

public JIPipeDesktopGraphCanvasUI getCanvasUI()

getDockStateTemplates

protected abstract StringAndStringPairParameter.List getDockStateTemplates()

restoreDefaultDockState

protected abstract void restoreDefaultDockState()

getDockPanel

public JIPipeDesktopDockPanel getDockPanel()

getTools

public List<JIPipeGraphEditorTool> getTools()

getDefaultTool

public JIPipeGraphEditorTool getDefaultTool()

selectDefaultTool

public void selectDefaultTool()

selectTool

public void selectTool(JIPipeGraphEditorTool tool)

getCurrentTool

public JIPipeToggleableGraphEditorTool getCurrentTool()

getSelection

public Set<JIPipeDesktopGraphNodeUI> getSelection()

createScreenshotClipboard

public void createScreenshotClipboard()

getGraph

public JIPipeGraph getGraph()

Returns:

The edited graph

updateSelection

protected void updateSelection()

updateContextToolbar

public void updateContextToolbar()

scrollToAlgorithm

public void scrollToAlgorithm(JIPipeDesktopGraphNodeUI ui)

Scrolls to the specified algorithm UI

Parameters:

ui - the algorithm

clearSelection

public void clearSelection()

Clears the algorithm selection

selectOnly

public void selectOnly(JIPipeDesktopGraphNodeUI ui)

Selects only the specified algorithm

Parameters:

ui - The algorithm UI

removeFromSelection

public void removeFromSelection(JIPipeDesktopGraphNodeUI ui)

Removes an algorithm from the selection

Parameters:

ui - The algorithm UI

addToSelection

public void addToSelection(JIPipeDesktopGraphNodeUI ui)

Adds an algorithm to the selection

Parameters:

ui - The algorithm UI

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

mouseDragged

public void mouseDragged(MouseEvent e)

Specified by:

mouseDragged in interface MouseMotionListener

mouseMoved

public void mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

getCompartment

public UUID getCompartment()

Returns:

The displayed graph compartment

getAddableAlgorithms

public Set<JIPipeNodeInfo> getAddableAlgorithms()

setAddableAlgorithms

public void setAddableAlgorithms(Set<JIPipeNodeInfo> addableAlgorithms)

getHistoryJournal

public JIPipeHistoryJournal getHistoryJournal()

onGraphChanged

public void onGraphChanged(JIPipeGraph.GraphChangedEvent event)

Specified by:

onGraphChanged in interface JIPipeGraph.GraphChangedEventListener

onGraphCanvasNodeSelectionChanged

public void onGraphCanvasNodeSelectionChanged(JIPipeDesktopGraphCanvasUI.NodeSelectionChangedEvent event)

Specified by:

onGraphCanvasNodeSelectionChanged in interface JIPipeDesktopGraphCanvasUI.NodeSelectionChangedEventListener

onNodeUISelected

public void onNodeUISelected(JIPipeDesktopGraphCanvasUI.NodeUISelectedEvent event)

Specified by:

onNodeUISelected in interface JIPipeDesktopGraphCanvasUI.NodeUISelectedEventListener

onDefaultNodeUIActionRequested

public void onDefaultNodeUIActionRequested(JIPipeDesktopGraphNodeUI.DefaultNodeUIActionRequestedEvent event)

Specified by:

onDefaultNodeUIActionRequested in interface JIPipeDesktopGraphNodeUI.DefaultNodeUIActionRequestedEventListener

onNodeUIActionRequested

public void onNodeUIActionRequested(JIPipeDesktopGraphNodeUI.NodeUIActionRequestedEvent event)

Specified by:

onNodeUIActionRequested in interface JIPipeDesktopGraphNodeUI.NodeUIActionRequestedEventListener

onPanelSideVisibilityChanged

public void onPanelSideVisibilityChanged(JIPipeDesktopDockPanel.PanelSideVisibilityChangedEvent event)

Specified by:

onPanelSideVisibilityChanged in interface JIPipeDesktopDockPanel.PanelSideVisibilityChangedEventListener

beforeOpenContextMenu

public abstract void beforeOpenContextMenu(JPopupMenu menu)

Executed before opening the context menu Right before adding the partition entries and after all auto-generated items

Parameters:

menu - the menu