Package edu.uci.ics.jung.visualization

Class VisualizationViewer<V,​E>

  • All Implemented Interfaces:
    ChangeEventSupport, VisualizationServer<V,​E>, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.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
    Author:
    Joshua O'Madadhain, Tom Nelson, Danyel Fisher
    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 javax.swing.JPanel

        javax.swing.JPanel.AccessibleJPanel

      • 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

    • Method Summary

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

      • Methods inherited from class javax.swing.JPanel

        getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

      • 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, 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 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, 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 java.lang.Object

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

    • Field Detail

      • vertexToolTipTransformer

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

      • edgeToolTipTransformer

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

      • mouseEventToolTipTransformer

        protected com.google.common.base.Function<java.awt.event.MouseEvent,​java.lang.String> mouseEventToolTipTransformer

      • graphMouse

        protected VisualizationViewer.GraphMouse graphMouse
        provides MouseListener, MouseMotionListener, and MouseWheelListener events to the graph

      • requestFocusListener

        protected java.awt.event.MouseListener requestFocusListener

    • Constructor Detail

      • VisualizationViewer

        public VisualizationViewer​(Layout<V,​E> layout)

      • VisualizationViewer

        public VisualizationViewer​(Layout<V,​E> layout,
                           java.awt.Dimension preferredSize)

      • VisualizationViewer

        public VisualizationViewer​(VisualizationModel<V,​E> model,
                           java.awt.Dimension preferredSize)

    • Method Detail

      • 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

      • 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​(java.awt.event.KeyListener l)
        Override to request focus on mouse enter, if a key listener is added
        Overrides:
        addKeyListener in class java.awt.Component
        See Also:
        Component.addKeyListener(java.awt.event.KeyListener)

      • setEdgeToolTipTransformer

        public void setEdgeToolTipTransformer​(com.google.common.base.Function<? super E,​java.lang.String> edgeToolTipTransformer)
        Parameters:
        edgeToolTipTransformer - the edgeToolTipTransformer to set

      • setMouseEventToolTipTransformer

        public void setMouseEventToolTipTransformer​(com.google.common.base.Function<java.awt.event.MouseEvent,​java.lang.String> mouseEventToolTipTransformer)
        Parameters:
        mouseEventToolTipTransformer - the mouseEventToolTipTransformer to set

      • setVertexToolTipTransformer

        public void setVertexToolTipTransformer​(com.google.common.base.Function<? super V,​java.lang.String> vertexToolTipTransformer)
        Parameters:
        vertexToolTipTransformer - the vertexToolTipTransformer to set

      • getToolTipText

        public java.lang.String getToolTipText​(java.awt.event.MouseEvent event)
        called by the superclass to display tooltips
        Overrides:
        getToolTipText in class javax.swing.JComponent