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

Class JIPipeDesktopGraphNodeUI

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

All Implemented Interfaces:

MouseListener, MouseMotionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, JIPipeCache.ModifiedEventListener, JIPipeWorkbenchAccess, JIPipeGraph.NodeConnectedEventListener, JIPipeGraph.NodeDisconnectedEventListener, JIPipeGraphNode.NodeSlotsChangedEventListener, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeDesktopWorkbenchAccess

Direct Known Subclasses:

JIPipeDesktopAnnotationGraphNodeUI

public class JIPipeDesktopGraphNodeUI
extends JIPipeDesktopWorkbenchPanel
implements MouseListener, MouseMotionListener, JIPipeCache.ModifiedEventListener, JIPipeGraphNode.NodeSlotsChangedEventListener, JIPipeGraph.NodeConnectedEventListener, JIPipeGraph.NodeDisconnectedEventListener, JIPipeParameterCollection.ParameterChangedEventListener

UI around an JIPipeGraphNode instance

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeDesktopGraphNodeUI.DefaultNodeUIActionRequestedEvent Triggered when an JIPipeDesktopGraphNodeUI requests a default action (double click)
static class	JIPipeDesktopGraphNodeUI.DefaultNodeUIActionRequestedEventEmitter
static interface	JIPipeDesktopGraphNodeUI.DefaultNodeUIActionRequestedEventListener
static class	JIPipeDesktopGraphNodeUI.NodeUIActionRequestedEvent An action that is requested by an JIPipeDesktopGraphNodeUI and passed down to a AbstractJIPipeDesktopGraphEditorUI
static class	JIPipeDesktopGraphNodeUI.NodeUIActionRequestedEventEmitter
static interface	JIPipeDesktopGraphNodeUI.NodeUIActionRequestedEventListener
static class	JIPipeDesktopGraphNodeUI.SlotStatus

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
protected List<JIPipeDesktopGraphNodeUIActiveArea>	activeAreas
static Color	COLOR_DISABLED_1
static Color	COLOR_DISABLED_2
static Color	COLOR_RUN_BUTTON_ICON
static Color	COLOR_SLOT_CACHED
static Color	COLOR_SLOT_DISCONNECTED
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
JIPipeDesktopGraphNodeUI(JIPipeDesktopWorkbench workbench, JIPipeDesktopGraphCanvasUI graphCanvasUI, JIPipeGraphNode node) Creates a new UI

Method Summary

Modifier and Type	Method and Description
JIPipeDesktopGraphNodeUIAddSlotButtonActiveArea	getAddInputSlotArea()
JIPipeDesktopGraphNodeUIAddSlotButtonActiveArea	getAddOutputSlotArea()
Color	getBorderColor()
int	getBottomY() Get the Y location of the bottom part
JIPipeDesktopGraphNodeUIActiveArea	getCurrentActiveArea()
Color	getFillColor()
JIPipeDesktopGraphCanvasUI	getGraphCanvasUI()
Map<String,JIPipeDesktopGraphNodeUISlotActiveArea>	getInputSlotMap()
JIPipeGraphNode	getNode()
JIPipeDesktopGraphNodeUI.NodeUIActionRequestedEventEmitter	getNodeUIActionRequestedEventEmitter()
Map<String,JIPipeDesktopGraphNodeUISlotActiveArea>	getOutputSlotMap()
int	getRightX()
JIPipeDesktopGraphNodeUISlotActiveArea	getSlotActiveArea(JIPipeDataSlot slot)
PointRange	getSlotLocation(JIPipeDataSlot slot) Returns the location of a slot in relative coordinates
Point	getStoredGridLocation()
JIPipeGraphViewMode	getViewMode()
double	getZoom()
boolean	isBuffered()
boolean	isDisplayedInForeignCompartment()
boolean	isDrawShadow()
boolean	isNodeRunnable()
boolean	isSlotsInputsEditable()
boolean	isSlotsOutputsEditable()
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)
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
void	onCacheModified(JIPipeCache.ModifiedEvent event)
void	onNodeConnected(JIPipeGraph.NodeConnectedEvent event)
void	onNodeDisconnected(JIPipeGraph.NodeDisconnectedEvent event)
void	onNodeSlotsChanged(JIPipeGraphNode.NodeSlotsChangedEvent event)
void	onParameterChanged(JIPipeParameterCollection.ParameterChangedEvent event) Should be triggered when an algorithm's name parameter is changed
protected void	paintComponent(Graphics g)
void	paintMinimap(Graphics2D graphics2D, int x, int y, int width, int height, BasicStroke defaultStroke, BasicStroke selectedStroke, Set<JIPipeDesktopGraphNodeUI> selection)
protected void	paintNode(Graphics2D g2)
JIPipeDesktopGraphNodeUIActiveArea	pickAddSlotAtMousePosition(MouseEvent event)
JIPipeDesktopGraphNodeUISlotActiveArea	pickSlotAtMousePosition(MouseEvent event)
JIPipeDesktopGraphNodeUISlotActiveArea	pickSlotAtMousePosition(Point mousePosition)
void	setBuffered(boolean buffered)
void	setZoom(double zoom)
protected void	updateActiveAreas()
protected void	updateAssets()
protected void	updateColors()
void	updateHotkeyInfo()
protected void	updateSize() Recalculates the UI size
protected void	updateSlotActiveAreas()
protected void	updateSlots()
void	updateView(boolean assets, boolean slots, boolean size)
protected void	updateWholeNodeActiveAreas()

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

COLOR_DISABLED_1

public static final Color COLOR_DISABLED_1

COLOR_DISABLED_2

public static final Color COLOR_DISABLED_2

COLOR_SLOT_CACHED

public static final Color COLOR_SLOT_CACHED

COLOR_SLOT_DISCONNECTED

public static final Color COLOR_SLOT_DISCONNECTED

COLOR_RUN_BUTTON_ICON

public static final Color COLOR_RUN_BUTTON_ICON

RUN_NODE_CONTEXT_MENU_ENTRIES

public static final NodeUIContextAction[] RUN_NODE_CONTEXT_MENU_ENTRIES

activeAreas

protected final List<JIPipeDesktopGraphNodeUIActiveArea> activeAreas

Constructor Detail

JIPipeDesktopGraphNodeUI

public JIPipeDesktopGraphNodeUI(JIPipeDesktopWorkbench workbench,
                                JIPipeDesktopGraphCanvasUI graphCanvasUI,
                                JIPipeGraphNode node)

Creates a new UI

Parameters:

workbench - thr workbench

graphCanvasUI - The graph UI that contains this UI

node - The algorithm

Method Detail

isBuffered

public boolean isBuffered()

setBuffered

public void setBuffered(boolean buffered)

getNodeUIActionRequestedEventEmitter

public JIPipeDesktopGraphNodeUI.NodeUIActionRequestedEventEmitter getNodeUIActionRequestedEventEmitter()

isNodeRunnable

public boolean isNodeRunnable()

getZoom

public double getZoom()

setZoom

public void setZoom(double zoom)

updateView

public void updateView(boolean assets,
                       boolean slots,
                       boolean size)

updateActiveAreas

protected void updateActiveAreas()

getInputSlotMap

public Map<String,JIPipeDesktopGraphNodeUISlotActiveArea> getInputSlotMap()

getOutputSlotMap

public Map<String,JIPipeDesktopGraphNodeUISlotActiveArea> getOutputSlotMap()

updateSlotActiveAreas

protected void updateSlotActiveAreas()

updateWholeNodeActiveAreas

protected void updateWholeNodeActiveAreas()

updateColors

protected void updateColors()

updateAssets

protected void updateAssets()

getNode

public JIPipeGraphNode getNode()

Returns:

The displayed algorithm

updateHotkeyInfo

public void updateHotkeyInfo()

getBottomY

public int getBottomY()

Get the Y location of the bottom part

Returns:

y coordinate

onNodeSlotsChanged

public void onNodeSlotsChanged(JIPipeGraphNode.NodeSlotsChangedEvent event)

Specified by:

onNodeSlotsChanged in interface JIPipeGraphNode.NodeSlotsChangedEventListener

onNodeConnected

public void onNodeConnected(JIPipeGraph.NodeConnectedEvent event)

Specified by:

onNodeConnected in interface JIPipeGraph.NodeConnectedEventListener

onNodeDisconnected

public void onNodeDisconnected(JIPipeGraph.NodeDisconnectedEvent event)

Specified by:

onNodeDisconnected in interface JIPipeGraph.NodeDisconnectedEventListener

onParameterChanged

public void onParameterChanged(JIPipeParameterCollection.ParameterChangedEvent event)

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

Specified by:

onParameterChanged in interface JIPipeParameterCollection.ParameterChangedEventListener

Parameters:

event - The generated event

updateSize

protected void updateSize()

Recalculates the UI size

getViewMode

public JIPipeGraphViewMode getViewMode()

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

getSlotLocation

public 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()

getGraphCanvasUI

public JIPipeDesktopGraphCanvasUI getGraphCanvasUI()

getRightX

public int getRightX()

paintComponent

protected void paintComponent(Graphics g)

Overrides:

paintComponent in class JComponent

isDrawShadow

public boolean isDrawShadow()

isDisplayedInForeignCompartment

public boolean isDisplayedInForeignCompartment()

paintNode

protected void paintNode(Graphics2D g2)

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

pickSlotAtMousePosition

public JIPipeDesktopGraphNodeUISlotActiveArea pickSlotAtMousePosition(MouseEvent event)

pickSlotAtMousePosition

public JIPipeDesktopGraphNodeUISlotActiveArea pickSlotAtMousePosition(Point mousePosition)

pickAddSlotAtMousePosition

public JIPipeDesktopGraphNodeUIActiveArea pickAddSlotAtMousePosition(MouseEvent event)

isSlotsInputsEditable

public boolean isSlotsInputsEditable()

isSlotsOutputsEditable

public boolean isSlotsOutputsEditable()

getAddInputSlotArea

public JIPipeDesktopGraphNodeUIAddSlotButtonActiveArea getAddInputSlotArea()

getAddOutputSlotArea

public JIPipeDesktopGraphNodeUIAddSlotButtonActiveArea getAddOutputSlotArea()

updateSlots

protected void updateSlots()

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

getSlotActiveArea

public JIPipeDesktopGraphNodeUISlotActiveArea getSlotActiveArea(JIPipeDataSlot slot)

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

onCacheModified

public void onCacheModified(JIPipeCache.ModifiedEvent event)

Specified by:

onCacheModified in interface JIPipeCache.ModifiedEventListener

paintMinimap

public void paintMinimap(Graphics2D graphics2D,
                         int x,
                         int y,
                         int width,
                         int height,
                         BasicStroke defaultStroke,
                         BasicStroke selectedStroke,
                         Set<JIPipeDesktopGraphNodeUI> selection)

getCurrentActiveArea

public JIPipeDesktopGraphNodeUIActiveArea getCurrentActiveArea()