prajna.viz.render

Class IconNodeRenderer

java.lang.Object

prajna.viz.render.IconNodeRenderer

All Implemented Interfaces:

java.awt.image.ImageObserver, NodeRenderer

public class IconNodeRenderer
extends java.lang.Object
implements NodeRenderer, java.awt.image.ImageObserver

Renders nodes using an internal icon image. The icon used for a node is determined by the method getIcon(node). Subclasses can override this to allow multiple icons to be supported.

Author:

Edward Swing

Field Summary

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
IconNodeRenderer(java.awt.Image iconImage) Creates a new IconNodeRenderer object.

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
protected java.awt.Image	getIcon(java.lang.Object node) Get the icon used to render the specified node.
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) Highlights the node into the Graphics Context.
boolean	imageUpdate(java.awt.Image img, int infoflags, int x, int y, int width, int height) This method is called when information about an image which was previously requested using an asynchronous interface becomes available.
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	setIconScaleFlag(boolean scaleFlag) Sets the flag indicating whether to scale the icon, or use the natural icon size when displaying the icons.
void	setIconSize(int size) Sets the size of icon to be used.
void	setShowNames(boolean show) Sets the flag indicating whether the name of the node should be displayed beneath the icon.

Methods inherited from class java.lang.Object

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

Constructor Detail

IconNodeRenderer

public IconNodeRenderer(java.awt.Image iconImage)

Creates a new IconNodeRenderer object.

Parameters:

iconImage - An icon to use for rendering the node

Method Detail

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 draw the node as an icon.

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 to use for the renderer

getIcon

protected java.awt.Image getIcon(java.lang.Object node)

Get the icon used to render the specified node. Extensions to this class may simply override this method to determine the image to display for a particular node.

Parameters:

node - The node to render

Returns:

An image used to represent the 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 position defined, null is returned.

Specified by:

getNodeBounds in interface NodeRenderer

Parameters:

node - The node to be checked

loc - The node location

Returns:

the bounding box for the node

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 draw the node as an icon, with a rectangle surrounding it.

Specified by:

highlightNode in interface NodeRenderer

Parameters:

g - the Graphics context to display the node

node - the node to display

loc - The node location

imageUpdate

public boolean imageUpdate(java.awt.Image img,
                  int infoflags,
                  int x,
                  int y,
                  int width,
                  int height)

This method is called when information about an image which was previously requested using an asynchronous interface becomes available.

Specified by:

imageUpdate in interface java.awt.image.ImageObserver

Parameters:

img - the image being observed.

infoflags - the bitwise inclusive OR of the following flags: WIDTH, HEIGHT, PROPERTIES, SOMEBITS, FRAMEBITS, ALLBITS, ERROR, ABORT.

x - the x coordinate.

y - the y coordinate.

width - the width.

height - the height.

Returns:

false if the infoflags indicate that the image is completely loaded; true otherwise.

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

loc - 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 color)

Sets the color for the NodeRenderer. If this color is set, it will override any Node color. The color is largely ignored, unless the icon is partially transparent.

Specified by:

setColor in interface NodeRenderer

Parameters:

color - The color to use.

setIconScaleFlag

public void setIconScaleFlag(boolean scaleFlag)

Sets the flag indicating whether to scale the icon, or use the natural icon size when displaying the icons.

Parameters:

scaleFlag - a flag indicating whether to resize the icons.

setIconSize

public void setIconSize(int size)

Sets the size of icon to be used. Icons will be scaled to this size. in both the X and Y directions, maintaining aspect ratio of the original image. The default icon size is 32.

Parameters:

size - the size of the icon

setShowNames

public void setShowNames(boolean show)

Sets the flag indicating whether the name of the node should be displayed beneath the icon. This set to false by default. The name string displayed is derived by invoking toString() on the node.

Parameters:

show - flag indicating whether names are visible