prajna.viz.render

Interface NodeRenderer

All Known Implementing Classes:

ClassNodeRenderer, CubeNodeRenderer, FadeNodeRenderer, IconNodeRenderer, ShapeNodeRenderer, SimpleNodeRenderer, SwingNodeRenderer, TextNodeRenderer, TimeNodeRenderer

public interface NodeRenderer

Interface which provides the functionality to draw nodes in a particular style or representation. The separation of the renderer from the actual node allows a simple method of switching representations, while keeping the actual node classes lightweight, and a single renderer may be used for all nodes in a graph.

Author:

Edward Swing

Method Summary

Methods

Modifier and Type	Method and Description
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
java.awt.Rectangle	getNodeBounds(java.lang.Object node, java.awt.Point loc) Returns the bounding box for the node using this renderer.
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 pickpoint is within the drawn area for the node.
void	setColor(java.awt.Color color) Sets the color for the NodeRenderer.

Method Detail

drawNode

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

Draws the node into the Graphics Context.

Parameters:

g - the Graphics context to display the node

node - the node to display

loc - The node location

getColor

java.awt.Color getColor()

Gets the color for the Renderer, if any

Returns:

the color for this renderer

getNodeBounds

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.

Parameters:

node - The node

loc - The node location

Returns:

the bounding box for the node

highlightNode

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.

Parameters:

g - the Graphics context to display the node

node - the node to display

loc - The node location

pickNode

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

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

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

void setColor(java.awt.Color color)

Sets the color for the NodeRenderer.

Parameters:

color - the color for this renderer