prajna.viz.display

Class AbstractGraphDisplay<N,E>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

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

Type Parameters:

N - The node class for the graph

E - The edge class for the graph

All Implemented Interfaces:

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

Direct Known Subclasses:

GraphCanvas, GraphGeoCanvas, MatrixGraphDisplay

public abstract class AbstractGraphDisplay<N,E>
extends javax.swing.JComponent
implements GraphDisplay<N,E>

Abstract base class for displaying graphs in a JComponent. The actual drawing methods are abstract, allowing subclasses to render the graph in a customized fashion.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addHoverListener(HoverListener listener) Adds a listener which will receive any ItemSelected events.
void	addItemListener(java.awt.event.ItemListener listener) Adds a listener which will receive any ItemSelected events.
protected void	fireHoverStateChanged(HoverEvent event) Notifies all listeners that have registered interest for notification on this event type.
protected void	fireItemStateChanged(java.awt.event.ItemEvent event) Notifies all listeners that have registered interest for notification on this event type.
abstract E	getEdgeAt(java.awt.Point point) Get the edge located at a particular point.
Graph<N,E>	getGraph() Get the graph assigned to this display
abstract N	getNodeAt(java.awt.Point point) Returns the node located at the pickPoint.
E	getSelectedEdge() Gets the current selected edge.
N	getSelectedNode() Gets the current selected node.
java.lang.Object[]	getSelectedObjects() Returns the selected items or null if no items are selected.
protected boolean	isEdgeDisplayable(E edge) Returns whether the edge should be displayed.
boolean	isEdgeSelectable() Returns whether the edges are selectable
protected boolean	isHighlighted(java.lang.Object obj) Returns whether the object should be highlighted.
protected boolean	isNodeDisplayable(N node) Returns whether the node should be displayed.
protected void	processMouseEvent(java.awt.event.MouseEvent event) Processes any internal mouse events.
abstract void	redrawEdge(E edge) Redraws an individual edge.
abstract void	redrawNode(N node) Redraws an individual node
void	removeHoverListener(HoverListener listener) Removes the ItemListener from the list of listeners receiving the node or edge selection events
void	removeItemListener(java.awt.event.ItemListener listener) Removes the ItemListener from the list of listeners receiving the node or edge selection events
void	selectEdge(E edge) Programatically sets the currently selected edge
void	selectNode(N node) Programatically sets the currently selected node
void	setEdgeSelectable(boolean edgeSelect) Sets whether the edges are selectable.
void	setGraph(Graph<N,E> graph) Set the graph to be displayed

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

Methods inherited from interface prajna.viz.display.GraphDisplay

updateGraph

Constructor Detail

AbstractGraphDisplay

public AbstractGraphDisplay()

Method Detail

addHoverListener

public void addHoverListener(HoverListener listener)

Adds a listener which will receive any ItemSelected events. An ItemSelected event is generated whenever a node or edge is selected or unselected.

Parameters:

listener - the ItemListener to receive node or edge selections

addItemListener

public void addItemListener(java.awt.event.ItemListener listener)

Adds a listener which will receive any ItemSelected events. An ItemSelected event is generated whenever a node or edge is selected or unselected.

Specified by:

addItemListener in interface java.awt.ItemSelectable

Parameters:

listener - the ItemListener to receive node or edge selections

fireHoverStateChanged

protected void fireHoverStateChanged(HoverEvent event)

Notifies all listeners that have registered interest for notification on this event type.

Parameters:

event - the ItemEvent object, indicating node/edge selection

fireItemStateChanged

protected void fireItemStateChanged(java.awt.event.ItemEvent event)

Notifies all listeners that have registered interest for notification on this event type.

Parameters:

event - the ItemEvent object, indicating node/edge selection

getEdgeAt

public abstract E getEdgeAt(java.awt.Point point)

Get the edge located at a particular point. If there are multiple edges passing through the point, this method returns one of the edges. Implementations of this class may determine more specific behavior. If edges are not selectable, this method returns null.

Parameters:

point - the point, in pixel coordinates

Returns:

the edge that passes through that point, or null if no such edge exists.

getGraph

public Graph<N,E> getGraph()

Get the graph assigned to this display

Specified by:

getGraph in interface GraphDisplay<N,E>

Returns:

the current graph

getNodeAt

public abstract N getNodeAt(java.awt.Point point)

Returns the node located at the pickPoint. If multiple nodes are overlapping at the pickPoint, this method returns one of the nodes. Implementations of the class may determine more specific behavior

Parameters:

point - the point in pixel coordinates

Returns:

the node at the point

getSelectedEdge

public E getSelectedEdge()

Gets the current selected edge.

Specified by:

getSelectedEdge in interface GraphDisplay<N,E>

Returns:

the current selected edge

getSelectedNode

public N getSelectedNode()

Gets the current selected node.

Specified by:

getSelectedNode in interface GraphDisplay<N,E>

Returns:

the current selected node

getSelectedObjects

public java.lang.Object[] getSelectedObjects()

Returns the selected items or null if no items are selected.

Specified by:

getSelectedObjects in interface java.awt.ItemSelectable

Returns:

the list of selected objects

isEdgeDisplayable

protected boolean isEdgeDisplayable(E edge)

Returns whether the edge should be displayed. This method returns whether an edge should be visibly displayed. An edge that is not displayed may still take up space, so that toggling the visibility of the edge will not force a rearrangement. This method is called whenever an edge is drawn. The default implementation always returns true.

Parameters:

edge - the edge to check

Returns:

true if the edge should be displayed, false otherwise

isEdgeSelectable

public boolean isEdgeSelectable()

Returns whether the edges are selectable

Returns:

whether the edges are currently selectable

isHighlighted

protected boolean isHighlighted(java.lang.Object obj)

Returns whether the object should be highlighted. The default implementation checks whether the object matches either the currently selected node or currently selected edge. If the object matches, the method returns true. Subclases can override this behavior.

Parameters:

obj - the object to check for highlighting

Returns:

true if the object should be highlighted when displayed, false otherwise

isNodeDisplayable

protected boolean isNodeDisplayable(N node)

Returns whether the node should be displayed. This method returns whether a node should be visibly displayed. A node that is not displayed may still take up space, so that toggling the visibility of the node will not force a rearrangement. This method is called whenever a node is drawn. The default implementation always returns true.

Parameters:

node - the node to check

Returns:

true if the node should be displayed, false otherwise

processMouseEvent

protected void processMouseEvent(java.awt.event.MouseEvent event)

Processes any internal mouse events. When there are listeners, this class handles any mouse clicks on the graph canvas, and fires any selection or deselection events.

Overrides:

processMouseEvent in class javax.swing.JComponent

Parameters:

event - the MouseEvent to process

redrawEdge

public abstract void redrawEdge(E edge)

Redraws an individual edge.

Parameters:

edge - the node to redraw

redrawNode

public abstract void redrawNode(N node)

Redraws an individual node

Parameters:

node - the node to redraw

removeHoverListener

public void removeHoverListener(HoverListener listener)

Removes the ItemListener from the list of listeners receiving the node or edge selection events

Parameters:

listener - the ItemListener to remove

removeItemListener

public void removeItemListener(java.awt.event.ItemListener listener)

Removes the ItemListener from the list of listeners receiving the node or edge selection events

Specified by:

removeItemListener in interface java.awt.ItemSelectable

Parameters:

listener - the ItemListener to remove

selectEdge

public void selectEdge(E edge)

Programatically sets the currently selected edge

Specified by:

selectEdge in interface GraphDisplay<N,E>

Parameters:

edge - the currently selected edge

selectNode

public void selectNode(N node)

Programatically sets the currently selected node

Specified by:

selectNode in interface GraphDisplay<N,E>

Parameters:

node - the node to be selected

setEdgeSelectable

public void setEdgeSelectable(boolean edgeSelect)

Sets whether the edges are selectable. By default, edges are not selectable.

Parameters:

edgeSelect - whether the edges should be selectable

setGraph

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

Set the graph to be displayed

Specified by:

setGraph in interface GraphDisplay<N,E>

Parameters:

graph - the graph to be displayed