Class VisualizationViewer<V,E>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

edu.uci.ics.jung.visualization.BasicVisualizationServer<V,E>

edu.uci.ics.jung.visualization.VisualizationViewer<V,E>

All Implemented Interfaces:

ChangeEventSupport, VisualizationServer<V,E>, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, ChangeListener

Direct Known Subclasses:

SatelliteVisualizationViewer

public class VisualizationViewer<V,E>
extends BasicVisualizationServer<V,E>

Adds mouse behaviors and tooltips to the graph visualization base class

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VisualizationViewer.GraphMouse	a convenience type to represent a class that processes all types of mouse events for the graph

Nested classes/interfaces inherited from class BasicVisualizationServer

BasicVisualizationServer.VisualizationListener

Nested classes/interfaces inherited from class JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Nested classes/interfaces inherited from interface VisualizationServer

VisualizationServer.Paintable

Field Summary

Fields

Modifier and Type	Field	Description
protected com.google.common.base.Function<? super E, String>	edgeToolTipTransformer
protected VisualizationViewer.GraphMouse	graphMouse	provides MouseListener, MouseMotionListener, and MouseWheelListener events to the graph
protected com.google.common.base.Function<MouseEvent, String>	mouseEventToolTipTransformer
protected MouseListener	requestFocusListener
protected com.google.common.base.Function<? super V, String>	vertexToolTipTransformer

Fields inherited from class BasicVisualizationServer

changeSupport, doubleBuffered, model, offscreen, offscreenG2d, pickedEdgeState, pickedVertexState, pickEventListener, postRenderers, preRenderers, renderContext, renderer, renderingHints

Fields inherited from class JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
VisualizationViewer(Layout<V,E> layout)
VisualizationViewer(Layout<V,E> layout, Dimension preferredSize)
VisualizationViewer(VisualizationModel<V,E> model)
VisualizationViewer(VisualizationModel<V,E> model, Dimension preferredSize)

Method Summary

Modifier and Type	Method	Description
void	addGraphMouseListener(GraphMouseListener<V> gel)	This is the interface for adding a mouse listener.
void	addKeyListener(KeyListener l)	Override to request focus on mouse enter, if a key listener is added
VisualizationViewer.GraphMouse	getGraphMouse()
String	getToolTipText(MouseEvent event)	called by the superclass to display tooltips
void	setEdgeToolTipTransformer(com.google.common.base.Function<? super E, String> edgeToolTipTransformer)
void	setGraphMouse(VisualizationViewer.GraphMouse graphMouse)	a setter for the GraphMouse.
void	setMouseEventToolTipTransformer(com.google.common.base.Function<MouseEvent, String> mouseEventToolTipTransformer)
void	setVertexToolTipTransformer(com.google.common.base.Function<? super V, String> vertexToolTipTransformer)

Methods inherited from class BasicVisualizationServer

addChangeListener, addPostRenderPaintable, addPreRenderPaintable, checkOffscreenImage, fireStateChanged, getCenter, getChangeListeners, getGraphLayout, getModel, getPickedEdgeState, getPickedVertexState, getPickSupport, getRenderContext, getRenderer, getRenderingHints, getSize, isDoubleBuffered, paintComponent, prependPostRenderPaintable, prependPreRenderPaintable, removeChangeListener, removePostRenderPaintable, removePreRenderPaintable, renderGraph, scaleToLayout, setDoubleBuffered, setGraphLayout, setModel, setPickedEdgeState, setPickedVertexState, setPickSupport, setRenderContext, setRenderer, setRenderingHints, setVisible, stateChanged

Methods inherited from class JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class 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, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, 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, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update

Methods inherited from class 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 Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, 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, getPropertyChangeListeners, getPropertyChangeListeners, 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, requestFocus, 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 Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface VisualizationServer

repaint

Field Details

vertexToolTipTransformer

protected com.google.common.base.Function<? super V, String> vertexToolTipTransformer

edgeToolTipTransformer

protected com.google.common.base.Function<? super E, String> edgeToolTipTransformer

mouseEventToolTipTransformer

protected com.google.common.base.Function<MouseEvent, String> mouseEventToolTipTransformer

graphMouse

protected VisualizationViewer.GraphMouse graphMouse

provides MouseListener, MouseMotionListener, and MouseWheelListener events to the graph

requestFocusListener

protected MouseListener requestFocusListener

Constructor Details

VisualizationViewer

public VisualizationViewer(Layout<V,E> layout)

VisualizationViewer

public VisualizationViewer(Layout<V,E> layout,
 Dimension preferredSize)

VisualizationViewer

public VisualizationViewer(VisualizationModel<V,E> model)

VisualizationViewer

public VisualizationViewer(VisualizationModel<V,E> model,
 Dimension preferredSize)

Method Details

setGraphMouse

public void setGraphMouse(VisualizationViewer.GraphMouse graphMouse)

a setter for the GraphMouse. This will remove any previous GraphMouse (including the one that is added in the initMouseClicker method.

Parameters:

graphMouse - new value

getGraphMouse

public VisualizationViewer.GraphMouse getGraphMouse()

Returns:

the current GraphMouse

addGraphMouseListener

public void addGraphMouseListener(GraphMouseListener<V> gel)

This is the interface for adding a mouse listener. The GEL will be called back with mouse clicks on vertices.

Parameters:

gel - the mouse listener to add

addKeyListener

public void addKeyListener(KeyListener l)

Override to request focus on mouse enter, if a key listener is added

Overrides:

addKeyListener in class Component

See Also:

• Component.addKeyListener(java.awt.event.KeyListener)

setEdgeToolTipTransformer

public void setEdgeToolTipTransformer(com.google.common.base.Function<? super E, String> edgeToolTipTransformer)

Parameters:

edgeToolTipTransformer - the edgeToolTipTransformer to set

setMouseEventToolTipTransformer

public void setMouseEventToolTipTransformer(com.google.common.base.Function<MouseEvent, String> mouseEventToolTipTransformer)

Parameters:

mouseEventToolTipTransformer - the mouseEventToolTipTransformer to set

setVertexToolTipTransformer

public void setVertexToolTipTransformer(com.google.common.base.Function<? super V, String> vertexToolTipTransformer)

Parameters:

vertexToolTipTransformer - the vertexToolTipTransformer to set

getToolTipText

public String getToolTipText(MouseEvent event)

called by the superclass to display tooltips

Overrides:

getToolTipText in class JComponent