org.hkijena.jipipe.ui.grapheditor.general.nodeui

Class JIPipeNodeUI

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.nodeui.JIPipeNodeUI

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, JIPipeWorkbenchAccess

Direct Known Subclasses:

JIPipeHorizontalNodeUI, JIPipeVerticalNodeUI

public abstract class JIPipeNodeUI
extends JIPipeWorkbenchPanel

UI around an JIPipeGraphNode instance

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeNodeUI.AlgorithmEvent An event around JIPipeNodeUI

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 NodeUIContextAction[]	RUN_NODE_CONTEXT_MENU_ENTRIES

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
JIPipeNodeUI(JIPipeWorkbench workbench, JIPipeGraphCanvasUI graphUI, JIPipeGraphNode node, JIPipeGraphViewMode viewMode) Creates a new UI

Method Summary

Modifier and Type	Method and Description
abstract Dimension	calculateGridSize() Calculates the size in grid coordinates
protected JButton	createAddSlotButton(JIPipeSlotType slotType) Function that creates the "Add slot" button
Color	getBorderColor()
int	getBottomY() Get the Y location of the bottom part
EventBus	getEventBus()
Color	getFillColor()
JIPipeGraphCanvasUI	getGraphUI()
abstract Map<String,JIPipeDataSlotUI>	getInputSlotUIs()
JIPipeGraphNode	getNode()
abstract Map<String,JIPipeDataSlotUI>	getOutputSlotUIs()
int	getRightX()
abstract PointRange	getSlotLocation(JIPipeDataSlot slot) Returns the location of a slot in relative coordinates
Point	getStoredGridLocation()
boolean	isNodeRunnable()
boolean	isOverlapping() Returns true if this component overlaps with another component
boolean	moveToClosestGridPoint(Point location, boolean force, boolean save) Moves the node to the next grid location, given a real location
boolean	moveToGridLocation(Point gridLocation, boolean force, boolean save) Moves the node to a grid location
boolean	moveToStoredGridLocation(boolean force) Moves the UI back to the stored grid location
abstract boolean	needsRecalculateGridSize()
void	onAlgorithmParametersChanged(JIPipeParameterCollection.ParameterChangedEvent event) Should be triggered when an algorithm's name parameter is changed
void	onAlgorithmSlotsChanged(JIPipeGraph.NodeSlotsChangedEvent event) Should be triggered when the algorithm's slots are changed.
void	paint(Graphics g)
protected void	paintComponent(Graphics g)
JIPipeDataSlotUI	pickSlotComponent(MouseEvent mouseEvent)
abstract void	refreshSlots() Updates the UIs for slots
protected abstract void	updateActivationStatus() Called when the algorithm was enabled/disabled
abstract void	updateAlgorithmSlotUIs() Updates the slots
abstract void	updateHotkeyInfo()
protected abstract void	updateName() Called when the algorithm name was updated
abstract void	updateSize() Recalculates the UI size

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, paintBorder, paintChildren, 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

RUN_NODE_CONTEXT_MENU_ENTRIES

public static final NodeUIContextAction[] RUN_NODE_CONTEXT_MENU_ENTRIES

Constructor Detail

JIPipeNodeUI

public JIPipeNodeUI(JIPipeWorkbench workbench,
                    JIPipeGraphCanvasUI graphUI,
                    JIPipeGraphNode node,
                    JIPipeGraphViewMode viewMode)

Creates a new UI

Parameters:

workbench - thr workbench

graphUI - The graph UI that contains this UI

node - The algorithm

viewMode - Directionality of the canvas UI

Method Detail

isNodeRunnable

public boolean isNodeRunnable()

getNode

public JIPipeGraphNode getNode()

Returns:

The displayed algorithm

createAddSlotButton

protected JButton createAddSlotButton(JIPipeSlotType slotType)

Function that creates the "Add slot" button

Parameters:

slotType - slot type

Returns:

the button

updateHotkeyInfo

public abstract void updateHotkeyInfo()

updateAlgorithmSlotUIs

public abstract void updateAlgorithmSlotUIs()

Updates the slots

isOverlapping

public boolean isOverlapping()

Returns true if this component overlaps with another component

Returns:

True if an overlap was found

paint

public void paint(Graphics g)

Overrides:

paint in class JComponent

getBottomY

public int getBottomY()

Get the Y location of the bottom part

Returns:

y coordinate

onAlgorithmSlotsChanged

public void onAlgorithmSlotsChanged(JIPipeGraph.NodeSlotsChangedEvent event)

Should be triggered when the algorithm's slots are changed. Triggers slot UI updates

Parameters:

event - Generated event

onAlgorithmParametersChanged

public void onAlgorithmParametersChanged(JIPipeParameterCollection.ParameterChangedEvent event)

Should be triggered when an algorithm's name parameter is changed

Parameters:

event - The generated event

needsRecalculateGridSize

public abstract boolean needsRecalculateGridSize()

calculateGridSize

public abstract Dimension calculateGridSize()

Calculates the size in grid coordinates

Returns:

the size

updateName

protected abstract void updateName()

Called when the algorithm name was updated

updateActivationStatus

protected abstract void updateActivationStatus()

Called when the algorithm was enabled/disabled

updateSize

public abstract void updateSize()

Recalculates the UI size

moveToGridLocation

public boolean moveToGridLocation(Point gridLocation,
                                  boolean force,
                                  boolean save)

Moves the node to a grid location

Parameters:

gridLocation - the grid location

force - if false, no overlap check is applied

save - save the grid location to the node

Returns:

if setting the location was successful

getStoredGridLocation

public Point getStoredGridLocation()

moveToStoredGridLocation

public boolean moveToStoredGridLocation(boolean force)

Moves the UI back to the stored grid location

Parameters:

force - if false, no overlap check is applied

Returns:

either the location was not set or no stored location is available

getEventBus

public EventBus getEventBus()

Returns:

The event bus

getSlotLocation

public abstract PointRange getSlotLocation(JIPipeDataSlot slot)

Returns the location of a slot in relative coordinates

Parameters:

slot - the slot

Returns:

coordinates relative to this algorithm UI

getFillColor

public Color getFillColor()

getBorderColor

public Color getBorderColor()

getGraphUI

public JIPipeGraphCanvasUI getGraphUI()

getRightX

public int getRightX()

getInputSlotUIs

public abstract Map<String,JIPipeDataSlotUI> getInputSlotUIs()

getOutputSlotUIs

public abstract Map<String,JIPipeDataSlotUI> getOutputSlotUIs()

paintComponent

protected void paintComponent(Graphics g)

Overrides:

paintComponent in class JComponent

moveToClosestGridPoint

public boolean moveToClosestGridPoint(Point location,
                                      boolean force,
                                      boolean save)

Moves the node to the next grid location, given a real location

Parameters:

location - a real location

force - whether to disable checking for overlaps

save - store the location in the node

Returns:

if setting the location was successful

refreshSlots

public abstract void refreshSlots()

Updates the UIs for slots

pickSlotComponent

public JIPipeDataSlotUI pickSlotComponent(MouseEvent mouseEvent)