prajna.viz.prefuse

Class PrefuseGraphDisplay<N,E>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

prefuse.Display

prajna.viz.prefuse.PrefuseGraphDisplay<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:

ForceDirectedDisplay, PrefuseTreeDisplay

public abstract class PrefuseGraphDisplay<N,E>
extends prefuse.Display
implements GraphDisplay<N,E>

Abstract display class which provides a bridge between Prajna and Prefuse. The Prefuse graph display provides a framework for adapting Prefuse visualizations while using other data. It is particularly useful when using DataAccessors.

Author:

Edward Swing

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class prefuse.Display

prefuse.Display.InputEventCapturer

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 prefuse.Display

frameRate, m_bgpainter, m_bounders, m_bounds, m_clip, m_controls, m_customToolTip, m_damageRedraw, m_highQuality, m_itransform, m_offscreen, m_painters, m_predicate, m_queue, m_rclip, m_screen, m_tmpPoint, m_transact, m_transform, m_vis, m_visibleCount, nframes

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

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	displayGraph(prefuse.data.Graph prefuseGraph) Display the Prefuse graph.
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.
protected PrefuseConverter<N,E>	getConverter() Get the PrefuseConverter used to convert data for this GraphDisplay
Graph<N,E>	getGraph() Get the graph for this display
protected prefuse.data.Graph	getPrefuseGraph() Return the current Prefuse graph
E	getSelectedEdge() Get the currently selected edge
N	getSelectedNode() Get the currently selected node
java.lang.Object[]	getSelectedObjects() Get the currently selected objects
protected boolean	hasInteractiveEdges() Return whether the graph display has interactive edges or not.
void	highlight(java.util.Collection<N> nodeSet, java.util.Collection<E> edgeSet) Highlight a group of nodes and edges.
void	pickItem(prefuse.visual.VisualItem item) Pick an item on the display.
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) Select a particular edge
void	selectNode(N node) Select a particular node
void	setConverter(PrefuseConverter<N,E> prefuseConverter) Sets the Prefuse tuple converter.
void	setGraph(Graph<N,E> newGraph) Set the graph currently displayed.
void	setRenderer(prefuse.render.Renderer render) Set the Prefuse renderer used to render nodes on this graph display.
void	setVisible(boolean visible) Set visibility of component.
abstract void	setZoom(float zoom) Set the zoom factor for the display.
void	updateGraph() Updates the currently displayed graph.

Methods inherited from class prefuse.Display

addControlListener, addItemBoundsListener, addPaintListener, animatePan, animatePanAbs, animatePanAndZoomTo, animatePanAndZoomToAbs, animatePanTo, animatePanToAbs, animateZoom, animateZoomAbs, checkItemBoundsChanged, clearDamage, clearRegion, createToolTip, damageReport, damageReport, editText, editText, editText, findItem, firePostPaint, firePrePaint, getAbsoluteCoordinate, getCustomToolTip, getDisplayX, getDisplayY, getFrameRate, getInverseTransform, getItemBounds, getItemBounds, getItemSorter, getNewOffscreenBuffer, getOffscreenBuffer, getPredicate, getScale, getTextEditor, getTransform, getVisibleItemCount, getVisualization, invalidate, isDamageRedraw, isHighQuality, isTranformInProgress, paintBufferToScreen, paintComponent, paintDisplay, pan, panAbs, panTo, panToAbs, prepareGraphics, printComponent, registerDefaultCommands, removeControlListener, removeItemBoundsListener, removePaintListener, renderImmediate, repaintImmediate, rotate, rotateAbs, saveImage, setBackgroundImage, setBackgroundImage, setBounds, setCustomToolTip, setDamageRedraw, setFont, setHighQuality, setItemSorter, setPredicate, setPredicate, setRenderingHints, setSize, setSize, setTextEditor, setTransform, setVisualization, stopEditing, update, zoom, zoomAbs

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, 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, 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, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, 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, 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, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, 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

PrefuseGraphDisplay

public PrefuseGraphDisplay()

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

displayGraph

protected void displayGraph(prefuse.data.Graph prefuseGraph)

Display the Prefuse graph.

Parameters:

prefuseGraph - the prefuse graph

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

getConverter

protected PrefuseConverter<N,E> getConverter()

Get the PrefuseConverter used to convert data for this GraphDisplay

Returns:

the converter

getGraph

public Graph<N,E> getGraph()

Get the graph for this display

Specified by:

getGraph in interface GraphDisplay<N,E>

Returns:

the graph for this display

getPrefuseGraph

protected prefuse.data.Graph getPrefuseGraph()

Return the current Prefuse graph

Returns:

the prefuse Graph

getSelectedEdge

public E getSelectedEdge()

Get the currently selected edge

Specified by:

getSelectedEdge in interface GraphDisplay<N,E>

Returns:

the currently selected edge

getSelectedNode

public N getSelectedNode()

Get the currently selected node

Specified by:

getSelectedNode in interface GraphDisplay<N,E>

Returns:

the currently selected node

getSelectedObjects

public java.lang.Object[] getSelectedObjects()

Get the currently selected objects

Specified by:

getSelectedObjects in interface java.awt.ItemSelectable

Returns:

the currently selected objects

hasInteractiveEdges

protected boolean hasInteractiveEdges()

Return whether the graph display has interactive edges or not. By default, a display has non-interactive edges. Specific implementations may override this.

Returns:

true if the edges are interactive, false otherwise

highlight

public void highlight(java.util.Collection<N> nodeSet,
             java.util.Collection<E> edgeSet)

Highlight a group of nodes and edges. This method unhighlights all nodes and edges which are not in the specified collections. It then sets the highlight flag on each VisualItem corresponding to the nodes and edges in the specified groups

Parameters:

nodeSet - the group of nodes which should be highlighted

edgeSet - the group of edges which should be highlighted

pickItem

public void pickItem(prefuse.visual.VisualItem item)

Pick an item on the display.

Parameters:

item - the item picked

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)

Select a particular edge

Specified by:

selectEdge in interface GraphDisplay<N,E>

Parameters:

edge - the edge

selectNode

public void selectNode(N node)

Select a particular node

Specified by:

selectNode in interface GraphDisplay<N,E>

Parameters:

node - the node

setConverter

public void setConverter(PrefuseConverter<N,E> prefuseConverter)

Sets the Prefuse tuple converter.

Parameters:

prefuseConverter - the converter

setGraph

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

Set the graph currently displayed. This method converts the graph to a Prefuse graph, and invokes displayGraph().

Specified by:

setGraph in interface GraphDisplay<N,E>

Parameters:

newGraph - the new graph

setRenderer

public void setRenderer(prefuse.render.Renderer render)

Set the Prefuse renderer used to render nodes on this graph display. If not set, the graph display should use a default renderer, such as LabelRenderer.

Parameters:

render - The prefuse renderer

setVisible

public void setVisible(boolean visible)

Set visibility of component. This method overrides the setVisibility() method on the superclass to stop or start any animations that are running.

Overrides:

setVisible in class javax.swing.JComponent

Parameters:

visible - whether the display is visible or not.

setZoom

public abstract void setZoom(float zoom)

Set the zoom factor for the display. The Zoom should expand or contract the display without changing the display qualities of the various nodes of the graph. The zoom factor is a floating point number; 1.0 should reflect the default zoom for any particular graph display.

Parameters:

zoom - the zoom factor

updateGraph

public void updateGraph()

Updates the currently displayed graph. This call checks the graph for new nodes and edges, and adds them to the internal Prefuse graph.

Specified by:

updateGraph in interface GraphDisplay<N,E>