org.vrjuggler.vrjconfig.commoneditors.devicegraph
Class AbstractCustomVertexRenderer

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.vrjuggler.vrjconfig.commoneditors.devicegraph.AbstractCustomVertexRenderer

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, CellViewRenderer

public abstract class AbstractCustomVertexRenderer
extends JPanel
implements CellViewRenderer

Basic (abstract) custom vertex renderer—based on JPanel—for use with JGraph. This code is based on examples included with JGraph and JGraphAddons for creating custom vertex renderers.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected Color	defaultBackground The default background color to use for rendering if none is defined in the cell view attributes.
protected Color	defaultForeground The default foreground color to use for rendering if none is defined in the cell view attributes.
protected Color	gradientColor The gradient (if any) associated with the attributes of the cell view being rendered.
protected JGraph	graph The graph where this vertex renderer is used.
protected boolean	hasFocus A flag indicating if the vertex view has focus.
protected JLabel	nameLabel The Swing component used for displaying the name of the object held by the vertex cell.
protected boolean	preview A flag indicating whether the vertex view should be rendered as a preview is selected.
protected boolean	selected A flag indicating whether the vertex is selected.

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

AbstractCustomVertexRenderer()

Method Summary

abstract Component	getRendererComponent(JGraph graph, CellView view, boolean selected, boolean hasFocus, boolean preview) Configures and returns the renderer component based on the passed-in cell view.
protected void	installAttributes(JGraph graph, Map attributes) Sets up the attributes for the renderer as determined by the given JGraph instance and the given attribute map.
void	paint(Graphics g)

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, 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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, 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, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, 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, transferFocusBackward, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

graph

protected transient JGraph graph

The graph where this vertex renderer is used.

gradientColor

protected transient Color gradientColor

The gradient (if any) associated with the attributes of the cell view being rendered. This is set in installAttributes().

See Also:

installAttributes(JGraph,Map)

selected

protected transient boolean selected

A flag indicating whether the vertex is selected.

preview

protected transient boolean preview

A flag indicating whether the vertex view should be rendered as a preview is selected.

hasFocus

protected transient boolean hasFocus

A flag indicating if the vertex view has focus.

defaultBackground

protected Color defaultBackground

The default background color to use for rendering if none is defined in the cell view attributes.

See Also:

installAttributes(JGraph,Map)

defaultForeground

protected Color defaultForeground

The default foreground color to use for rendering if none is defined in the cell view attributes.

See Also:

installAttributes(JGraph,Map)

nameLabel

protected JLabel nameLabel

The Swing component used for displaying the name of the object held by the vertex cell.

Constructor Detail

AbstractCustomVertexRenderer

public AbstractCustomVertexRenderer()

Method Detail

getRendererComponent

public abstract Component getRendererComponent(JGraph graph,
                                               CellView view,
                                               boolean selected,
                                               boolean hasFocus,
                                               boolean preview)

Configures and returns the renderer component based on the passed-in cell view.

Specified by:

getRendererComponent in interface CellViewRenderer

Parameters:

graph - the graph that that defines the rendering context

view - the object that should be rendered

selected - whether the object is selected

hasFocus - whether the object has the focus

preview - whether we are drawing a preview

See Also:

CellViewRenderer.getRendererComponent(JGraph,CellView,boolean,boolean,boolean)

paint

public void paint(Graphics g)

Overrides:

paint in class JComponent

installAttributes

protected void installAttributes(JGraph graph,
                                 Map attributes)

Sets up the attributes for the renderer as determined by the given JGraph instance and the given attribute map.

Parameters:

graph - the graph where this renderer is being used

attributes - the attributes for the cell view with which this renderer is associated

See Also:

GraphConstants