prajna.viz.display

Class GraphCanvas<N,E>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

prajna.viz.display.AbstractGraphDisplay<N,E>

prajna.viz.display.GraphCanvas<N,E>

Type Parameters:

N - The class of nodes in the graph

E - The class of edges in the graph

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.MenuContainer, java.io.Serializable, GraphDisplay<N,E>

Direct Known Subclasses:

AnimateCanvas, TreeGraphCanvas

public class GraphCanvas<N,E>
extends AbstractGraphDisplay<N,E>

The GraphCanvas class provides a set of utilities for drawing and managing graphs. It includes references to a NodeRenderer, EdgeRenderer, and a GraphArrangement. When the GraphCanvas is redrawn, it will render the nodes and edges using the appropriate renderers.

Author:

Edward Swing

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

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

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
GraphCanvas() Creates a GraphCanvas with an empty graph
GraphCanvas(Graph<N,E> graph) Constructs a Graph Canvas with the specified graph

Method Summary

Methods

Modifier and Type	Method and Description
void	arrange() Arrange the graph
GraphArrangement<N,E>	getArrangement() Get the arrangement used to arrange the graph
E	getEdgeAt(java.awt.Point pickPoint) Returns the edge located at the pickPoint.
EdgeRenderer	getEdgeRenderer() Returns the edge renderer used for displaying the edges in the graph
N	getNodeAt(java.awt.Point pickPoint) Returns the node located at the pickPoint.
NodeRenderer	getNodeRenderer() Returns the node renderer used for displaying the nodes in the graph
protected void	paintComponent(java.awt.Graphics g) Repaints the graph on the canvas.
void	redrawEdge(E edge) Redraws an individual edge.
protected void	redrawEdge(E edge, java.awt.Graphics g) Redraws an individual edge.
void	redrawNode(N node) Redraws an individual node.
protected void	redrawNode(N node, java.awt.Graphics g) Redraws an individual node
protected void	renderGraph(java.awt.Graphics g) Draws the graph on the canvas.
void	setEdgeRenderer(EdgeRenderer renderer) Set the edge renderer
void	setGraph(Graph<N,E> graph) Set the graph to be displayed
void	setGraphArrangement(GraphArrangement<N,E> arrangement) Set the current graph arrangement.
void	setNodeRenderer(NodeRenderer renderer) Set the node renderer
void	updateGraph() Update the currently displayed graph.
protected void	validateArrangement() Validates the arrangement immediately prior to drawing.

Methods inherited from class prajna.viz.display.AbstractGraphDisplay

addHoverListener, addItemListener, fireHoverStateChanged, fireItemStateChanged, getGraph, getSelectedEdge, getSelectedNode, getSelectedObjects, isEdgeDisplayable, isEdgeSelectable, isHighlighted, isNodeDisplayable, processMouseEvent, removeHoverListener, removeItemListener, selectEdge, selectNode, setEdgeSelectable

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, 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, 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, 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, hide, 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

Constructor Detail

GraphCanvas

public GraphCanvas()

Creates a GraphCanvas with an empty graph

GraphCanvas

public GraphCanvas(Graph<N,E> graph)

Constructs a Graph Canvas with the specified graph

Parameters:

graph - the graph to display in the canvas

Method Detail

arrange

public void arrange()
             throws ArrangementException

Arrange the graph

Throws:

ArrangementException - if there is a problem with the arrangement

getArrangement

public GraphArrangement<N,E> getArrangement()

Get the arrangement used to arrange the graph

Returns:

the current graph arrangement

getEdgeAt

public E getEdgeAt(java.awt.Point pickPoint)

Returns the edge located at the pickPoint. If multiple edges are overlapping at the pickPoint, this method will assume they were drawn in order, and that the last edge in the list has been drawn above the earlier edges, and therefore will return the last one in the graph.

Specified by:

getEdgeAt in class AbstractGraphDisplay<N,E>

Parameters:

pickPoint - the point in the canvas to pick for edges.

Returns:

the edge at the pickPoint

getEdgeRenderer

public EdgeRenderer getEdgeRenderer()

Returns the edge renderer used for displaying the edges in the graph

Returns:

the edge renderer being used

getNodeAt

public N getNodeAt(java.awt.Point pickPoint)

Returns the node located at the pickPoint. If multiple nodes are overlapping at the pickPoint, this method will assume they were drawn in order, and that the last node in the list has been drawn above the earlier nodes, and therefore will return the last one in the graph.

Specified by:

getNodeAt in class AbstractGraphDisplay<N,E>

Parameters:

pickPoint - the point in the canvas to pick for nodes.

Returns:

the node at the pickPoint

getNodeRenderer

public NodeRenderer getNodeRenderer()

Returns the node renderer used for displaying the nodes in the graph

Returns:

the node renderer being used

paintComponent

protected void paintComponent(java.awt.Graphics g)

Repaints the graph on the canvas. If the graph needs to be rearranged, this is done first. Then each edge is rendered first, followed by the nodes.

Overrides:

paintComponent in class javax.swing.JComponent

Parameters:

g - the graphics context to render into

redrawEdge

public void redrawEdge(E edge)

Redraws an individual edge. This method simply calls the redrawEdge(edge, g) method with a call to getGraphics() to supply the graphics context.

Specified by:

redrawEdge in class AbstractGraphDisplay<N,E>

Parameters:

edge - the edge to redraw

redrawEdge

protected void redrawEdge(E edge,
              java.awt.Graphics g)

Redraws an individual edge. Also redraws the nodes anchoring the edge.

Parameters:

edge - the node to redraw

redrawNode

public void redrawNode(N node)

Redraws an individual node. This method simply calls the redrawNode(node, g) method with a call to getGraphics() to supply the graphics context.

Specified by:

redrawNode in class AbstractGraphDisplay<N,E>

Parameters:

node - the node to redraw

redrawNode

protected void redrawNode(N node,
              java.awt.Graphics g)

Redraws an individual node

Parameters:

node - the node to redraw

renderGraph

protected void renderGraph(java.awt.Graphics g)

Draws the graph on the canvas. This method is called by paintComponent. Any method which extends this class and overrides paintComponent should make sure to call this method.

Parameters:

g - the graphics context

setEdgeRenderer

public void setEdgeRenderer(EdgeRenderer renderer)

Set the edge renderer

Parameters:

renderer - the edge renderer

setGraph

public void setGraph(Graph<N,E> graph)

Set the graph to be displayed

Specified by:

setGraph in interface GraphDisplay<N,E>

Overrides:

setGraph in class AbstractGraphDisplay<N,E>

Parameters:

graph - the graph to be displayed

setGraphArrangement

public void setGraphArrangement(GraphArrangement<N,E> arrangement)

Set the current graph arrangement. This method causes the graph to redraw, updating the node and edge locations according to the new arrangement.

Parameters:

arrangement - the new graph arrangement

setNodeRenderer

public void setNodeRenderer(NodeRenderer renderer)

Set the node renderer

Parameters:

renderer - the node renderer

updateGraph

public void updateGraph()

Update the currently displayed graph. This call should be invoked when the graph's contents change, such as when new nodes are added.

validateArrangement

protected void validateArrangement()

Validates the arrangement immediately prior to drawing. This method is called by paintComponent() prior to renderGraph(). Any subclass should follow this contract