prajna.viz.render

Class SwingNodeRenderer

java.lang.Object

prajna.viz.render.SwingNodeRenderer

All Implemented Interfaces:

NodeRenderer

public class SwingNodeRenderer
extends java.lang.Object
implements NodeRenderer

NodeRenderer which uses a Swing Component to display nodes. This allows the graph to have full Swing functionality for any particular node, allowing an application to set up checkboxes, pushbuttons, or any other Swing component for each node. By default, this NodeRenderer tries to use whatever Swing component type is passed in as a template to render its nodes. However, by overriding the createComponent() method, a subclass can easily override the behavior for particular nodes.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
SwingNodeRenderer(java.awt.Container container) Creates a new SwingNodeRenderer object.
SwingNodeRenderer(java.awt.Container container, javax.swing.JComponent template) Creates a new SwingNodeRenderer object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(java.util.EventListener eventListener, java.lang.String type) Goes through the component list, adding listeners of the appropriate type and adding them to each component for each node.
protected javax.swing.JComponent	createComponent(java.lang.Object node) Creates the component used to render the specified node.
void	drawNode(java.awt.Graphics g, java.lang.Object node, java.awt.Point loc) Draws the node into the Graphics Context.
java.awt.Color	getColor() Gets the color for the Renderer, if any.
javax.swing.JComponent	getComponent(java.lang.Object node) Gets the component used to draw a particular node.
java.lang.Object	getNode(javax.swing.JComponent comp) Gets the node associated with a given Swing component.
java.awt.Rectangle	getNodeBounds(java.lang.Object node, java.awt.Point loc) Returns the bounding box for the node using this renderer.
boolean	getUseSwingColors() Gets the flag indicating whether this renderer should use the native Swing colors.
void	highlightNode(java.awt.Graphics g, java.lang.Object node, java.awt.Point loc) Highlights the node into the Graphics Context.
boolean	pickNode(java.lang.Object node, java.awt.Point loc, java.awt.Point pickPoint) Checks whether the specified pickpoint is within the drawn area for the node.
void	setColor(java.awt.Color color) Sets the color for the NodeRenderer.
void	setTemplate(javax.swing.JComponent template) Sets the template.
void	setUseSwingColors(boolean flag) Sets the flag indicating whether this renderer should use the native Swing colors.

Methods inherited from class java.lang.Object

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

Constructor Detail

SwingNodeRenderer

public SwingNodeRenderer(java.awt.Container container)

Creates a new SwingNodeRenderer object. The NodeRenderer will display all nodes using the default component type (a JLabel).

Parameters:

container - The container to draw components in

SwingNodeRenderer

public SwingNodeRenderer(java.awt.Container container,
                 javax.swing.JComponent template)

Creates a new SwingNodeRenderer object. The class of the component will be used as a template to create components for rendering each node.

Parameters:

container - The container to draw components in

template - the template component, used as an example for rendering the nodes

Method Detail

addListener

public void addListener(java.util.EventListener eventListener,
               java.lang.String type)
                 throws java.lang.IllegalArgumentException

Goes through the component list, adding listeners of the appropriate type and adding them to each component for each node. If a given component does not support the listener, it is ignored for that node. This renderer only supports a single listener; subsequent calls to this method will overwrite the listener.

Parameters:

eventListener - a listener

type - the type of listener. For instance, if adding an ActionListener, type should be "Action"

Throws:

java.lang.IllegalArgumentException - thrown if the type string doesn't match the EventListener, or if the type String indicates an invalid Listener type.

createComponent

protected javax.swing.JComponent createComponent(java.lang.Object node)

Creates the component used to render the specified node. This method attempts to create a component for the node. It creates a new instance of the component, and then tries to invoke setText() to set the component text value. The argument for this is the String obtained by invoking toString() on the node. The listener, if set, is also added to this node, if the component type allows the listener.

Parameters:

node - the node to render

Returns:

the Swing component used to render the node

drawNode

public void drawNode(java.awt.Graphics g,
            java.lang.Object node,
            java.awt.Point loc)

Draws the node into the Graphics Context. This renderer will display the node using the SwingComponent appropriately (if possible).

Specified by:

drawNode in interface NodeRenderer

Parameters:

g - the Graphics context to display the node

node - the node to display

loc - The node location

getColor

public java.awt.Color getColor()

Gets the color for the Renderer, if any.

Specified by:

getColor in interface NodeRenderer

Returns:

the color for this renderer

getComponent

public javax.swing.JComponent getComponent(java.lang.Object node)

Gets the component used to draw a particular node.

Parameters:

node - The node to query

Returns:

the exact Swing component used for a particular node

getNode

public java.lang.Object getNode(javax.swing.JComponent comp)

Gets the node associated with a given Swing component.

Parameters:

comp - the Swing component

Returns:

the associated node

getNodeBounds

public java.awt.Rectangle getNodeBounds(java.lang.Object node,
                               java.awt.Point loc)

Returns the bounding box for the node using this renderer. Individual renderers should ensure that the drawn node is created entirely within the bounds returned. If the node has no location defined, null is returned.

Specified by:

getNodeBounds in interface NodeRenderer

Parameters:

node - the Node to calculate the bounds for

loc - The node location

Returns:

the bounding box for the node

getUseSwingColors

public boolean getUseSwingColors()

Gets the flag indicating whether this renderer should use the native Swing colors. This may be used to allow the graph to use a particular Look-and-Feel

Returns:

whether to use the native Swing color scheme

highlightNode

public void highlightNode(java.awt.Graphics g,
                 java.lang.Object node,
                 java.awt.Point loc)

Highlights the node into the Graphics Context. This renderer will display the node using the SwingComponent appropriately (if possible), and request the focus for the component.

Specified by:

highlightNode in interface NodeRenderer

Parameters:

g - the Graphics context to display the node

node - the node to display

loc - The node location

pickNode

public boolean pickNode(java.lang.Object node,
               java.awt.Point loc,
               java.awt.Point pickPoint)

Checks whether the specified pickpoint is within the drawn area for the node.

Specified by:

pickNode in interface NodeRenderer

Parameters:

node - the node to check for picking

pickPoint - the coordinate of the point to check

loc - The node location

Returns:

whether the point is in the drawn area for this node

setColor

public void setColor(java.awt.Color color)

Sets the color for the NodeRenderer. If this color is set, it will override any Node color.

Specified by:

setColor in interface NodeRenderer

Parameters:

color - the color for this renderer

setTemplate

public void setTemplate(javax.swing.JComponent template)

Sets the template.

Parameters:

template - the new template

setUseSwingColors

public void setUseSwingColors(boolean flag)

Sets the flag indicating whether this renderer should use the native Swing colors. This may be used to allow the graph to use a particular Look-and-Feel

Parameters:

flag - whether to use the native Swing color scheme