Module com.marginallyclever.donatello

Package com.marginallyclever.donatello.graphview

Class GraphViewPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.marginallyclever.donatello.graphview.GraphViewPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class GraphViewPanel
extends JPanel

GraphViewPanel visualizes the contents of a Graph with Java Swing. It can call on GraphViewListeners to add additional flavor. Override this to implement a unique look and feel.

Since:

2022-02-11

Author:

Dan Royer

See Also:

• Serialized Form

Nested Class Summary

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

JComponent.AccessibleJComponent

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

Component.BaselineResizeBehavior

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGN_BOTTOM	Controls vertical text alignment within a Node or Port.
static final int	ALIGN_CENTER	Controls horizontal or vertical text alignment within a Node or Port.
static final int	ALIGN_LEFT	Controls horizontal text alignment within a Node or Port.
static final int	ALIGN_RIGHT	Controls horizontal text alignment within a Node or Port.
static final int	ALIGN_TOP	Controls vertical text alignment within a Node or Port.
static final int	MAX_CHARS_PER_RORT	The maximum number of characters to display in a Port.

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

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	Description
GraphViewPanel(com.marginallyclever.nodegraphcore.Graph model)	Constructs one new instance of GraphViewPanel.

Method Summary

Modifier and Type	Method	Description
void	addViewListener(GraphViewListener p)	GraphViewListeners register here.
Point	getCameraPosition()
static Rectangle	getNodeInternalBounds(Rectangle r)	Returns the adjusted inner bounds of a Node.
Point	getPreviousMousePosition()
GraphViewSettings	getSettings()
double	getZoom()	Returns the current scale
void	loadSettings()
void	moveAndZoomToFit(Rectangle rectangle)	pan and zoom the camera to fit the rectangle in the view.
void	moveAndZoomToFit(List<com.marginallyclever.nodegraphcore.Node> selectedNodes)	pan and zoom the camera such that it can see all the selected nodes.
void	paintBezierBetweenTwoPoints(Graphics g, Point p0, Point p3)	Paint a cubic bezier using Graphics from p0 to p3.
void	paintConnection(Graphics g, com.marginallyclever.nodegraphcore.Connection c)	Paint the male end of connection points at this Port.
void	paintConnectionAtPoint(Graphics g, Point p)	Paint the male end of one connection point.
void	paintNode(Graphics g, com.marginallyclever.nodegraphcore.Node n)	Paint one Node
void	paintNodeBackground(Graphics g, com.marginallyclever.nodegraphcore.Node n)	Paint the background of one Node
void	paintNodeBorder(Graphics g, com.marginallyclever.nodegraphcore.Node n)	Paint the outside border of one Node.
void	paintNodeTitleBar(Graphics g, com.marginallyclever.nodegraphcore.Node n)	Paint the title bar of one Node.
void	paintOnePort(Graphics g, com.marginallyclever.nodegraphcore.port.Port<?> v)	Paint one Port.
void	paintPortConnectionPoints(Graphics g, com.marginallyclever.nodegraphcore.port.Port<?> v)	Paint the female end of connection points of one Port.
static void	paintText(Graphics g, String str, Rectangle box, int alignH, int alignV)	Use the graphics context to paint text within a box with the provided alignment.
void	removeViewListener(GraphViewListener p)	GraphViewListeners unregister here.
void	saveSettings()
static void	setHints(Graphics2D g2)	Set rendering hints for the Graphics2D context.
void	setLineWidth(Graphics g, float r)	Sets the Graphics context line width.
void	setZoom(double zoom)	Sets the scale.
Point	transformScreenToWorldPoint(Point point)

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, 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, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ALIGN_LEFT

public static final int ALIGN_LEFT

Controls horizontal text alignment within a Node or Port. See paintText(Graphics, String, Rectangle, int, int) for more information.

See Also:

• Constant Field Values

ALIGN_RIGHT

public static final int ALIGN_RIGHT

Controls horizontal text alignment within a Node or Port. See paintText(Graphics, String, Rectangle, int, int) for more information.

See Also:

• Constant Field Values

ALIGN_CENTER

public static final int ALIGN_CENTER

Controls horizontal or vertical text alignment within a Node or Port. See paintText(Graphics, String, Rectangle, int, int) for more information.

See Also:

• Constant Field Values

ALIGN_TOP

public static final int ALIGN_TOP

Controls vertical text alignment within a Node or Port. See paintText(Graphics, String, Rectangle, int, int) for more information.

See Also:

• Constant Field Values

ALIGN_BOTTOM

public static final int ALIGN_BOTTOM

Controls vertical text alignment within a Node or Port. See paintText(Graphics, String, Rectangle, int, int) for more information.

See Also:

• Constant Field Values

MAX_CHARS_PER_RORT

public static final int MAX_CHARS_PER_RORT

The maximum number of characters to display in a Port.

See Also:

• Constant Field Values

Constructor Details

GraphViewPanel

public GraphViewPanel(com.marginallyclever.nodegraphcore.Graph model)

Constructs one new instance of GraphViewPanel.

Parameters:

model - the Graph model to paint.

Method Details

loadSettings

public void loadSettings()

saveSettings

public void saveSettings()

setHints

public static void setHints(Graphics2D g2)

Set rendering hints for the Graphics2D context.

Parameters:

g2 - the Graphics2D context.

transformScreenToWorldPoint

public Point transformScreenToWorldPoint(Point point)

paintNode

public void paintNode(Graphics g,
 com.marginallyclever.nodegraphcore.Node n)

Paint one Node

Parameters:

g - the Graphics context

n - the Node to paint.

paintNodeBackground

public void paintNodeBackground(Graphics g,
 com.marginallyclever.nodegraphcore.Node n)

Paint the background of one Node

Parameters:

g - the Graphics context

n - the Node to paint.

paintNodeTitleBar

public void paintNodeTitleBar(Graphics g,
 com.marginallyclever.nodegraphcore.Node n)

Paint the title bar of one Node.

Parameters:

g - the Graphics context

n - the Node to paint.

paintOnePort

public void paintOnePort(Graphics g,
 com.marginallyclever.nodegraphcore.port.Port<?> v)

Paint one Port.

Parameters:

g - the Graphics context

v - the Port to paint.

getNodeInternalBounds

public static Rectangle getNodeInternalBounds(Rectangle r)

Returns the adjusted inner bounds of a Node. Nodes have a left and right margin useful for printing labels and values without overlapping the Connection points. these edges form an inner bound. Given a Port.getRectangle(), this

Parameters:

r - the outer bounsd of the node.

Returns:

the adjusted inner bounds of a Node.

paintNodeBorder

public void paintNodeBorder(Graphics g,
 com.marginallyclever.nodegraphcore.Node n)

Paint the outside border of one Node.

Parameters:

g - the Graphics context

n - the Node to paint.

paintPortConnectionPoints

public void paintPortConnectionPoints(Graphics g,
 com.marginallyclever.nodegraphcore.port.Port<?> v)

Paint the female end of connection points of one Port.

Parameters:

g - the Graphics context

v - the Port to paint.

paintText

public static void paintText(Graphics g,
 String str,
 Rectangle box,
 int alignH,
 int alignV)

Use the graphics context to paint text within a box with the provided alignment.

Parameters:

g - the graphics context

str - the text to paint

box - the bounding limits

alignH - the desired horizontal alignment. Can be any one of ALIGN_LEFT, ALIGN_RIGHT, or ALIGN_CENTER

alignV - the desired vertical alignment. Can be any one of ALIGN_TOP, ALIGN_BOTTOM, or ALIGN_CENTER

paintConnection

public void paintConnection(Graphics g,
 com.marginallyclever.nodegraphcore.Connection c)

Paint the male end of connection points at this Port.

Parameters:

g - the Graphics context

c - the Port to paint.

paintConnectionAtPoint

public void paintConnectionAtPoint(Graphics g,
 Point p)

Paint the male end of one connection point.

Parameters:

g - the Graphics context

p - the center of male end to paint.

paintBezierBetweenTwoPoints

public void paintBezierBetweenTwoPoints(Graphics g,
 Point p0,
 Point p3)

Paint a cubic bezier using Graphics from p0 to p3. The X difference between p0 and p3 is used to calculate p1 and p2.

Parameters:

g - the Graphics painting tool.

p0 - the first point of the cubic bezier spline.

p3 - the last point of the cubic bezier spline.

addViewListener

public void addViewListener(GraphViewListener p)

GraphViewListeners register here.

Parameters:

p - the GraphViewListener to register.

removeViewListener

public void removeViewListener(GraphViewListener p)

GraphViewListeners unregister here.

Parameters:

p - the GraphViewListener to unregister.

setLineWidth

public void setLineWidth(Graphics g,
 float r)

Sets the Graphics context line width.

Parameters:

g - the Graphics context

r - thew new line width.

getZoom

public double getZoom()

Returns the current scale

Returns:

the current scale

setZoom

public void setZoom(double zoom)

Sets the scale. Must be greater than or equal to 1.

Parameters:

zoom - Must be greater than or equal to 1.

getSettings

public GraphViewSettings getSettings()

moveAndZoomToFit

public void moveAndZoomToFit(Rectangle rectangle)

pan and zoom the camera to fit the rectangle in the view.

Parameters:

rectangle - the rectangle to fit.

moveAndZoomToFit

public void moveAndZoomToFit(List<com.marginallyclever.nodegraphcore.Node> selectedNodes)

pan and zoom the camera such that it can see all the selected nodes.

Parameters:

selectedNodes - the nodes to fit. if there are none, allow all.

getCameraPosition

public Point getCameraPosition()

Returns:

a copy of the current camera position. it is in absolute world coordinates.

getPreviousMousePosition

public Point getPreviousMousePosition()