prajna.viz.render

Interface EdgeRenderer

All Known Subinterfaces:

TimeEdgeRenderer

All Known Implementing Classes:

ArrowEdgeRenderer, FadeEdgeRenderer, SimpleEdgeRenderer, StepEdgeRenderer, WeightEdgeRenderer

public interface EdgeRenderer

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

Author:

Edward Swing

Method Summary

Methods

Modifier and Type	Method and Description
void	drawEdge(java.awt.Graphics g, java.lang.Object edge, java.awt.Point origLoc, java.awt.Point destLoc) Draws the edge into the Graphics Context.
java.awt.Color	getColor() Gets the color for the Renderer, if any
java.util.List<java.awt.Point>	getEdgePoints(java.lang.Object edge, java.awt.Point origLoc, java.awt.Point destLoc) Method to return the sequence of points used to draw the path for a particular edge.
void	highlightEdge(java.awt.Graphics g, java.lang.Object edge, java.awt.Point origLoc, java.awt.Point destLoc) Highlights the edge into the Graphics Context.
boolean	pickEdge(java.lang.Object edge, java.awt.Point pickPoint, java.awt.Point origLoc, java.awt.Point destLoc) Checks whether the specified pickpoint is within the drawn area for the edge.
void	setColor(java.awt.Color color) Sets the color for the Renderer.

Method Detail

drawEdge

void drawEdge(java.awt.Graphics g,
            java.lang.Object edge,
            java.awt.Point origLoc,
            java.awt.Point destLoc)

Draws the edge into the Graphics Context.

Parameters:

g - the Graphics context to display the edge

edge - the edge to display

origLoc - location of the origin node

destLoc - location of the destination node

getColor

java.awt.Color getColor()

Gets the color for the Renderer, if any

Returns:

the color for this renderer

getEdgePoints

java.util.List<java.awt.Point> getEdgePoints(java.lang.Object edge,
                                           java.awt.Point origLoc,
                                           java.awt.Point destLoc)

Method to return the sequence of points used to draw the path for a particular edge. The list is returned in a strict order. The list does not include any decorative elements, such as arrowheads.

Parameters:

edge - the Object to figure the points for

origLoc - location of the origin node

destLoc - location of the destination node

Returns:

a list of points for the edge.

highlightEdge

void highlightEdge(java.awt.Graphics g,
                 java.lang.Object edge,
                 java.awt.Point origLoc,
                 java.awt.Point destLoc)

Highlights the edge into the Graphics Context.

Parameters:

g - the Graphics context to display the edge

edge - the edge to display

origLoc - location of the origin node

destLoc - location of the destination node

pickEdge

boolean pickEdge(java.lang.Object edge,
               java.awt.Point pickPoint,
               java.awt.Point origLoc,
               java.awt.Point destLoc)

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

Parameters:

edge - the edge to check for picking

pickPoint - the coordinate of the point to check

origLoc - location of the origin node

destLoc - location of the destination node

Returns:

whether the point is in the drawn area for this edge

setColor

void setColor(java.awt.Color color)

Sets the color for the Renderer.

Parameters:

color - the color for this renderer