org.hkijena.jipipe.ui.grapheditor.general

Class JIPipeGraphEditorUI

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.hkijena.jipipe.ui.JIPipeWorkbenchPanel

org.hkijena.jipipe.ui.grapheditor.general.JIPipeGraphEditorUI

All Implemented Interfaces:

MouseListener, MouseMotionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, JIPipeGraph.GraphChangedEventListener, JIPipeService.NodeInfoRegisteredEventListener, SearchBox.SelectedEventListener<Object>, JIPipeGraphCanvasUI.NodeSelectionChangedEventListener, JIPipeGraphCanvasUI.NodeUISelectedEventListener, JIPipeGraphNodeUI.DefaultNodeUIActionRequestedEventListener, JIPipeGraphNodeUI.NodeUIActionRequestedEventListener, JIPipeWorkbenchAccess, Disposable

Direct Known Subclasses:

JIPipeCompartmentsGraphEditorUI, JIPipeJsonExporter, JIPipeJsonExtensionGraphUI, JIPipePipelineGraphEditorUI, RunSingleAlgorithmSettingsPanelIOEditor

public abstract class JIPipeGraphEditorUI
extends JIPipeWorkbenchPanel
implements MouseListener, MouseMotionListener, Disposable, JIPipeGraph.GraphChangedEventListener, JIPipeService.NodeInfoRegisteredEventListener, SearchBox.SelectedEventListener<Object>, JIPipeGraphCanvasUI.NodeSelectionChangedEventListener, JIPipeGraphCanvasUI.NodeUISelectedEventListener, JIPipeGraphNodeUI.DefaultNodeUIActionRequestedEventListener, JIPipeGraphNodeUI.NodeUIActionRequestedEventListener

A panel around JIPipeGraphCanvasUI 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	JIPipeGraphEditorUI.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 int	FLAGS_NONE
static int	FLAGS_SPLIT_PANE_RATIO_1_1
static int	FLAGS_SPLIT_PANE_SWITCH_CONTENT
static int	FLAGS_SPLIT_PANE_VERTICAL
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
protected JMenuBar	menuBar

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
JIPipeGraphEditorUI(JIPipeWorkbench workbenchUI, JIPipeGraph graph, UUID compartment, JIPipeHistoryJournal historyJournal)
JIPipeGraphEditorUI(JIPipeWorkbench workbenchUI, JIPipeGraph graph, UUID compartment, JIPipeHistoryJournal historyJournal, GraphEditorUISettings settings, int flags)

Method Summary

Modifier and Type	Method and Description
void	addToSelection(JIPipeGraphNodeUI ui) Adds an algorithm to the selection
void	clearSelection() Clears the algorithm selection
void	createScreenshotClipboard()
void	dispose()
Set<JIPipeNodeInfo>	getAddableAlgorithms()
JIPipeGraphCanvasUI	getCanvasUI()
UUID	getCompartment()
JIPipeToggleableGraphEditorTool	getCurrentTool()
int	getFlags()
JIPipeGraph	getGraph()
JMenu	getGraphMenu()
GraphEditorUISettings	getGraphUISettings()
JIPipeHistoryJournal	getHistoryJournal()
protected JMenuBar	getMenuBar()
protected Component	getPropertyPanel()
JScrollPane	getScrollPane()
Set<JIPipeGraphNodeUI>	getSelection()
List<JIPipeGraphEditorTool>	getTools()
protected void	initializeCommonActions() Initializes the tool bar
static void	installContextActionsInto(JToolBar toolBar, Set<JIPipeGraphNodeUI> selection, List<NodeUIContextAction> actionList, JIPipeGraphCanvasUI canvasUI)
boolean	isFlagSet(int flag)
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(JIPipeGraphNodeUI.DefaultNodeUIActionRequestedEvent event)
void	onGraphCanvasNodeSelectionChanged(JIPipeGraphCanvasUI.NodeSelectionChangedEvent event)
void	onGraphChanged(JIPipeGraph.GraphChangedEvent event)
void	onJIPipeNodeInfoRegistered(JIPipeService.NodeInfoRegisteredEvent event)
void	onNodeUIActionRequested(JIPipeGraphNodeUI.NodeUIActionRequestedEvent event)
void	onNodeUISelected(JIPipeGraphCanvasUI.NodeUISelectedEvent event)
void	onSearchBoxSelectedEvent(SearchBox.SelectedEvent<Object> event)
void	reloadMenuBar() Reloads the menu bar
void	removeFromSelection(JIPipeGraphNodeUI ui) Removes an algorithm from the selection
void	scrollToAlgorithm(JIPipeGraphNodeUI ui) Scrolls to the specified algorithm UI
void	selectDefaultTool()
void	selectOnly(JIPipeGraphNodeUI ui) Selects only the specified algorithm
void	selectTool(JIPipeGraphEditorTool tool)
void	setAddableAlgorithms(Set<JIPipeNodeInfo> addableAlgorithms)
protected void	setPropertyPanel(Component content, boolean disposeExisting) Sets the component displayed in the right property panel
void	updateNavigation() Updates the navigation list
protected void	updateSelection()

Methods inherited from class org.hkijena.jipipe.ui.JIPipeWorkbenchPanel

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

FLAGS_NONE

public static final int FLAGS_NONE

See Also:

Constant Field Values

FLAGS_SPLIT_PANE_VERTICAL

public static final int FLAGS_SPLIT_PANE_VERTICAL

See Also:

Constant Field Values

FLAGS_SPLIT_PANE_RATIO_1_1

public static final int FLAGS_SPLIT_PANE_RATIO_1_1

See Also:

Constant Field Values

FLAGS_SPLIT_PANE_SWITCH_CONTENT

public static final int FLAGS_SPLIT_PANE_SWITCH_CONTENT

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

menuBar

protected JMenuBar menuBar

Constructor Detail

JIPipeGraphEditorUI

public JIPipeGraphEditorUI(JIPipeWorkbench workbenchUI,
                           JIPipeGraph graph,
                           UUID compartment,
                           JIPipeHistoryJournal historyJournal,
                           GraphEditorUISettings settings,
                           int flags)

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.

flags - additional flags

JIPipeGraphEditorUI

public JIPipeGraphEditorUI(JIPipeWorkbench 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

installContextActionsInto

public static void installContextActionsInto(JToolBar toolBar,
                                             Set<JIPipeGraphNodeUI> selection,
                                             List<NodeUIContextAction> actionList,
                                             JIPipeGraphCanvasUI canvasUI)

dispose

public void dispose()

Specified by:

dispose in interface Disposable

getFlags

public int getFlags()

getGraphMenu

public JMenu getGraphMenu()

getGraphUISettings

public GraphEditorUISettings getGraphUISettings()

getScrollPane

public JScrollPane getScrollPane()

getCanvasUI

public JIPipeGraphCanvasUI getCanvasUI()

isFlagSet

public boolean isFlagSet(int flag)

getTools

public List<JIPipeGraphEditorTool> getTools()

selectDefaultTool

public void selectDefaultTool()

selectTool

public void selectTool(JIPipeGraphEditorTool tool)

getCurrentTool

public JIPipeToggleableGraphEditorTool getCurrentTool()

getSelection

public Set<JIPipeGraphNodeUI> getSelection()

reloadMenuBar

public void reloadMenuBar()

Reloads the menu bar

initializeCommonActions

protected void initializeCommonActions()

Initializes the tool bar

createScreenshotClipboard

public void createScreenshotClipboard()

getGraph

public JIPipeGraph getGraph()

Returns:

The edited graph

updateSelection

protected void updateSelection()

scrollToAlgorithm

public void scrollToAlgorithm(JIPipeGraphNodeUI ui)

Scrolls to the specified algorithm UI

Parameters:

ui - the algorithm

clearSelection

public void clearSelection()

Clears the algorithm selection

selectOnly

public void selectOnly(JIPipeGraphNodeUI ui)

Selects only the specified algorithm

Parameters:

ui - The algorithm UI

removeFromSelection

public void removeFromSelection(JIPipeGraphNodeUI ui)

Removes an algorithm from the selection

Parameters:

ui - The algorithm UI

getPropertyPanel

protected Component getPropertyPanel()

setPropertyPanel

protected void setPropertyPanel(Component content,
                                boolean disposeExisting)

Sets the component displayed in the right property panel

Parameters:

content - the component

disposeExisting - if the old component should be disposed

addToSelection

public void addToSelection(JIPipeGraphNodeUI 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

getMenuBar

protected JMenuBar getMenuBar()

getAddableAlgorithms

public Set<JIPipeNodeInfo> getAddableAlgorithms()

setAddableAlgorithms

public void setAddableAlgorithms(Set<JIPipeNodeInfo> addableAlgorithms)

updateNavigation

public void updateNavigation()

Updates the navigation list

getHistoryJournal

public JIPipeHistoryJournal getHistoryJournal()

onGraphChanged

public void onGraphChanged(JIPipeGraph.GraphChangedEvent event)

Specified by:

onGraphChanged in interface JIPipeGraph.GraphChangedEventListener

onJIPipeNodeInfoRegistered

public void onJIPipeNodeInfoRegistered(JIPipeService.NodeInfoRegisteredEvent event)

Specified by:

onJIPipeNodeInfoRegistered in interface JIPipeService.NodeInfoRegisteredEventListener

onSearchBoxSelectedEvent

public void onSearchBoxSelectedEvent(SearchBox.SelectedEvent<Object> event)

Specified by:

onSearchBoxSelectedEvent in interface SearchBox.SelectedEventListener<Object>

onGraphCanvasNodeSelectionChanged

public void onGraphCanvasNodeSelectionChanged(JIPipeGraphCanvasUI.NodeSelectionChangedEvent event)

Specified by:

onGraphCanvasNodeSelectionChanged in interface JIPipeGraphCanvasUI.NodeSelectionChangedEventListener

onNodeUISelected

public void onNodeUISelected(JIPipeGraphCanvasUI.NodeUISelectedEvent event)

Specified by:

onNodeUISelected in interface JIPipeGraphCanvasUI.NodeUISelectedEventListener

onDefaultNodeUIActionRequested

public void onDefaultNodeUIActionRequested(JIPipeGraphNodeUI.DefaultNodeUIActionRequestedEvent event)

Specified by:

onDefaultNodeUIActionRequested in interface JIPipeGraphNodeUI.DefaultNodeUIActionRequestedEventListener

onNodeUIActionRequested

public void onNodeUIActionRequested(JIPipeGraphNodeUI.NodeUIActionRequestedEvent event)

Specified by:

onNodeUIActionRequested in interface JIPipeGraphNodeUI.NodeUIActionRequestedEventListener