org.eth.cyril.graphdrawing.gui.graphdrawer.swing

Class SwingGraphDrawer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.eth.cyril.graphdrawing.gui.graphdrawer.swing.SwingGraphDrawer

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, GraphDrawer

public class SwingGraphDrawer
extends javax.swing.JComponent
implements GraphDrawer

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

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
SwingGraphDrawer(GraphComponentDrawer componentDrawer)

Method Summary

Modifier and Type	Method and Description
void	addMouseListener(MouseEventListener listener) Add a mouse listener which then receives mouse events.
void	addPopupMenu(Position position, java.util.Collection<PopupItem> entries) Creates a popup menu at the given position, using the given popup-items as entires.
void	addSelectionListener(SelectionEventListener listener) Add a selection listener which then receives selection events when the user selects multiple nodes at once by drawing a rectangle around the nodes to select.
void	drawGraph(Graph graph, DrawingFrame frame) Draws the given graph on the screen.
Graph	getCurrentGraph() Get the currently drawn graph.
boolean	isReadyForInteractions() Returns whether the drawing is ready for interactions, or whether the graph is still being drawn.
void	moveNode(Node node, Position newPosition) Move the given node to a new position.
protected void	paintComponent(java.awt.Graphics g)
void	redraw() Redraws the entire graph, without setting a new graph or a new drawing frame.
void	redrawNodes(java.util.Collection<Node> nodes) Redraws the given nodes, as well as all edges connected to those nodes.
void	removeMouseListener(MouseEventListener listener) Remove a previously added mouse listener.
void	removeSelectionListener(SelectionEventListener listener) Remove a previously added selection listener.
void	resetNodeBackgroundColor(Node node) Resets the given node's background color to the previously used color.
void	setIntermediateLayout(IntermediateLayout intermediateLayout) Set the intermediate layout to be used by the graph drawer.
void	setNodeBackgroundColor(Node node, Color color) Set the background color of a given node to the given color.
void	setNodeShape(Node node, Shape shape) Set the shape of a given node to the given shape.
void	setPreferredSize(java.awt.Dimension preferredSize)

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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, 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, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

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

Methods inherited from interface org.eth.cyril.graphdrawing.gui.graphdrawer.GraphDrawer

addPopupMenu, getSize

Constructor Detail

SwingGraphDrawer

public SwingGraphDrawer(GraphComponentDrawer componentDrawer)

Method Detail

drawGraph

public void drawGraph(Graph graph,
                      DrawingFrame frame)

Description copied from interface: GraphDrawer

Draws the given graph on the screen. For optimal results, the graph should be previously laid out, for example using some type of GraphDrawingAlgorithm or by manually specifying reasonable positions. The graph will be drawn as is, without changing any positions to e.g. fit on screen.

Specified by:

drawGraph in interface GraphDrawer

Parameters:

graph - The graph to draw.

frame - The drawing frame which was used for laying out the graph.

getCurrentGraph

public Graph getCurrentGraph()

Description copied from interface: GraphDrawer

Get the currently drawn graph. Note that this may be null, if no graph was drawn yet.

Specified by:

getCurrentGraph in interface GraphDrawer

Returns:

The currently drawn graph.

isReadyForInteractions

public boolean isReadyForInteractions()

Description copied from interface: GraphDrawer

Returns whether the drawing is ready for interactions, or whether the graph is still being drawn.

Specified by:

isReadyForInteractions in interface GraphDrawer

moveNode

public void moveNode(Node node,
                     Position newPosition)

Description copied from interface: GraphDrawer

Move the given node to a new position. Note that the node's new position should be given in coordinates within the drawing frame - not the screen space.

Specified by:

moveNode in interface GraphDrawer

Parameters:

node - The node to move in the drawing.

newPosition - The new position to move the node to.

addMouseListener

public void addMouseListener(MouseEventListener listener)

Description copied from interface: GraphDrawer

Add a mouse listener which then receives mouse events.

Specified by:

addMouseListener in interface GraphDrawer

Parameters:

listener - The listener to add.

removeMouseListener

public void removeMouseListener(MouseEventListener listener)

Description copied from interface: GraphDrawer

Remove a previously added mouse listener.

Specified by:

removeMouseListener in interface GraphDrawer

Parameters:

listener - The listener to remove.

addSelectionListener

public void addSelectionListener(SelectionEventListener listener)

Description copied from interface: GraphDrawer

Add a selection listener which then receives selection events when the user selects multiple nodes at once by drawing a rectangle around the nodes to select.

Specified by:

addSelectionListener in interface GraphDrawer

Parameters:

listener - The listener to add.

removeSelectionListener

public void removeSelectionListener(SelectionEventListener listener)

Description copied from interface: GraphDrawer

Remove a previously added selection listener.

Specified by:

removeSelectionListener in interface GraphDrawer

Parameters:

listener - The listener to add.

setIntermediateLayout

public void setIntermediateLayout(IntermediateLayout intermediateLayout)

Description copied from interface: GraphDrawer

Set the intermediate layout to be used by the graph drawer.

Specified by:

setIntermediateLayout in interface GraphDrawer

Parameters:

intermediateLayout - The intermediate layout to be used.

setPreferredSize

public void setPreferredSize(java.awt.Dimension preferredSize)

Overrides:

setPreferredSize in class javax.swing.JComponent

addPopupMenu

public void addPopupMenu(Position position,
                         java.util.Collection<PopupItem> entries)

Description copied from interface: GraphDrawer

Creates a popup menu at the given position, using the given popup-items as entires.

Specified by:

addPopupMenu in interface GraphDrawer

Parameters:

position - The position of the new popup menu within the GraphDrawer item.

entries - The entries of the new menu. For each entry, a new item with the given description and on-click handler is created. Optionally, a group may be defined. However, graph drawers are not obliged to consider this group.

setNodeBackgroundColor

public void setNodeBackgroundColor(Node node,
                                   Color color)

Description copied from interface: GraphDrawer

Set the background color of a given node to the given color. See GraphDrawer.redrawNodes(Collection) to force the updates to appear on screen.

Specified by:

setNodeBackgroundColor in interface GraphDrawer

Parameters:

node - The node of which to set the background color.

color - The color to which to set the node's background color.

resetNodeBackgroundColor

public void resetNodeBackgroundColor(Node node)

Description copied from interface: GraphDrawer

Resets the given node's background color to the previously used color. See GraphDrawer.redrawNodes(Collection) to force the updates to appear on screen.

Specified by:

resetNodeBackgroundColor in interface GraphDrawer

Parameters:

node - The node to reset the background color of.

setNodeShape

public void setNodeShape(Node node,
                         Shape shape)

Description copied from interface: GraphDrawer

Set the shape of a given node to the given shape. See GraphDrawer.redrawNodes(Collection) to force the updates to appear on screen.

Specified by:

setNodeShape in interface GraphDrawer

Parameters:

node - The node of which to set the shape.

shape - The shape to which to set the node.

redraw

public void redraw()

Description copied from interface: GraphDrawer

Redraws the entire graph, without setting a new graph or a new drawing frame. Forces any updates to shapes or colors which were made to appear, as well as updates to the content of nodes.

Specified by:

redraw in interface GraphDrawer

redrawNodes

public void redrawNodes(java.util.Collection<Node> nodes)

Description copied from interface: GraphDrawer

Redraws the given nodes, as well as all edges connected to those nodes. If not the entire graph needs to be redrawn, this might be more efficient than GraphDrawer.redraw() depending on the specific implementation. Forces any updates to shapes or colors which were made to appear, as well as updates to the content of nodes.

Specified by:

redrawNodes in interface GraphDrawer

Parameters:

nodes - The nodes which need to be redrawn.

paintComponent

protected void paintComponent(java.awt.Graphics g)

Overrides:

paintComponent in class javax.swing.JComponent