prajna.viz.render

Class ShapeNodeRenderer

java.lang.Object

prajna.viz.render.ShapeNodeRenderer

All Implemented Interfaces:

NodeRenderer

Direct Known Subclasses:

TextNodeRenderer

public class ShapeNodeRenderer
extends java.lang.Object
implements NodeRenderer

Renderer which draws nodes as simple shapes. The renderer draws all nodes with the same shape, though this behavior can be changed in subclasses.

Author:

Edward Swing

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShapeNodeRenderer.NodeShape Geometric render shape

Constructor Summary

Constructors

Constructor and Description
ShapeNodeRenderer()

Method Summary

Methods

Modifier and Type	Method and Description
void	drawNode(java.awt.Graphics g, java.lang.Object node, java.awt.Point loc) Render the node with the current shape
protected void	drawNodeShape(java.awt.Graphics g, ShapeNodeRenderer.NodeShape nodeShape, java.awt.Color nodeColor, java.awt.Rectangle bounds, boolean hilite) Draw the node shape into the graphics context.
java.awt.Color	getColor() Gets the color for the Renderer, if any
java.awt.Rectangle	getNodeBounds(java.lang.Object node, java.awt.Point loc) Returns the bounding box for the node using this renderer.
protected java.awt.Color	getNodeColor(java.lang.Object node) Get the color used for the node.
protected ShapeNodeRenderer.NodeShape	getNodeShape(java.lang.Object node) Get the shape for a particular node.
ShapeNodeRenderer.NodeShape	getShape() Get the current shape
void	highlightNode(java.awt.Graphics g, java.lang.Object node, java.awt.Point loc) Draws the node into the Graphics Context in a highlighted fashion.
boolean	pickNode(java.lang.Object node, java.awt.Point nodeLoc, java.awt.Point pickPoint) Checks whether the specified pick point is within the drawn area for the node.
void	setColor(java.awt.Color nodeColor) Sets the color for the NodeRenderer.
void	setShape(ShapeNodeRenderer.NodeShape nodeShape) Set the shape used to display the nodes

Methods inherited from class java.lang.Object

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

Constructor Detail

ShapeNodeRenderer

public ShapeNodeRenderer()

Method Detail

drawNode

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

Render the node with the current shape

Specified by:

drawNode in interface NodeRenderer

Parameters:

g - the Graphics context to display the node

node - the node to display

loc - The node location

drawNodeShape

protected void drawNodeShape(java.awt.Graphics g,
                 ShapeNodeRenderer.NodeShape nodeShape,
                 java.awt.Color nodeColor,
                 java.awt.Rectangle bounds,
                 boolean hilite)

Draw the node shape into the graphics context. This will fill a shape with the color. If the highlight flag is set, this call will draw a highlighted outline around the shape. The graphics context color will always be changed to a highlight color as a result of this call to allow a renderer to display text over the node.

Parameters:

g - the graphics context to draw into

nodeShape - the shape to draw

nodeColor - the color of the node

bounds - the rectangular area to draw within

hilite - whether to draw the node with a highlighted border

getColor

public java.awt.Color getColor()

Gets the color for the Renderer, if any

Specified by:

getColor in interface NodeRenderer

Returns:

the color used by the NodeRenderer

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.

Specified by:

getNodeBounds in interface NodeRenderer

Parameters:

node - The node

loc - The node location

Returns:

the bounding box for the node

getNodeColor

protected java.awt.Color getNodeColor(java.lang.Object node)

Get the color used for the node. Defaults to returning the node color set for the renderer in general. Subclasses can override this behavior, providing colors for nodes based upon attributes.

Parameters:

node - the node to query for the color

Returns:

the color of the node

getNodeShape

protected ShapeNodeRenderer.NodeShape getNodeShape(java.lang.Object node)

Get the shape for a particular node. This returns the same shape value as getShape(), but may be overridden by subclases to implement shapes which vary according to the node.

Parameters:

node - the node

Returns:

the shape for the node

getShape

public ShapeNodeRenderer.NodeShape getShape()

Get the current shape

Returns:

the shape

highlightNode

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

Draws the node into the Graphics Context in a highlighted fashion.

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 nodeLoc,
               java.awt.Point pickPoint)

Checks whether the specified pick point is within the drawn area for the node.

Specified by:

pickNode in interface NodeRenderer

Parameters:

node - the node to check for picking

nodeLoc - The node location

pickPoint - the coordinate of the point to check

Returns:

whether the point is in the drawn area for this node

setColor

public void setColor(java.awt.Color nodeColor)

Sets the color for the NodeRenderer. This will set the color used to fill the node shape

Specified by:

setColor in interface NodeRenderer

Parameters:

nodeColor - The color for the NodeRenderer

setShape

public void setShape(ShapeNodeRenderer.NodeShape nodeShape)

Set the shape used to display the nodes

Parameters:

nodeShape - the shape to set