salvo.jesus.graph.visual

Class VisualEdge

java.lang.Object

salvo.jesus.graph.visual.AbstractVisualGraphComponent

salvo.jesus.graph.visual.VisualEdge

All Implemented Interfaces:

Serializable, VisualGraphComponent

public class VisualEdge
extends AbstractVisualGraphComponent

The VisualEdge class encapsulates an Edge with attributes used for visual rendering of the vertex. Visual attributes in addition to those already defined in AbstractVisualGraphComponent are the Point2Ds where the VisualEdge should start and finish. The actual direction and path taken from the two Point2Ds is defined by the GeneralPath in AbstractVisualGraphComponent.

Author:

Jesus M. Salvo Jr.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VisualEdge(Edge edge, VisualGraph vGraph) Creates a new VisualEdge object that encapsulates the given Edge object.

Method Summary

Modifier and Type	Method and Description
Edge	getEdge() Returns the Edge object that VisualEdge encapsulates.
float	getEdgeLength(VisualEdge vEdge, Point fromPoint, Point toPoint) Returns the length of the VisualEdge as dictated by its GeneralPath
Point2D.Double	getFromPortAssignment()
Point2D.Double	getToPortAssignment()
VisualVertex	getVisualVertexA() Returns the VisualVertex object at the tail of the edge.
VisualVertex	getVisualVertexB() Returns the VisualVertex object at the head of the edge.
void	paint(Graphics2D g2d, GraphLayoutManager layoutmanager) Draw the VisualEdge with the specified 2D graphics context.
double	ptSegDist(int x, int y) Returns the distance between a point and the edge's path.
void	rescale() Do nothing.
void	setFromPortAssignment(Point2D newport)
protected void	setLinetype(int linetype)
void	setOrthogonalLine()
void	setStraightLine()
void	setToPortAssignment(Point2D newport)
String	toString() String representation of the VisualGraphComponent.

Methods inherited from class salvo.jesus.graph.visual.AbstractVisualGraphComponent

addMouseListener, addMouseMotionListener, getBounds, getBounds2D, getFillcolor, getFont, getFontcolor, getFontMetrics, getGeneralPath, getLabel, getOutlinecolor, getPainter, getVisualGraph, processKeyEvent, processMouseEvent, processMouseMotionEvent, removeMouseListener, removeMouseMotionListener, setFillcolor, setFont, setFontcolor, setGeneralPath, setGeneralPath, setLabel, setOutlinecolor, setPainter

Methods inherited from class java.lang.Object

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

Constructor Detail

VisualEdge

public VisualEdge(Edge edge,
                  VisualGraph vGraph)

Creates a new VisualEdge object that encapsulates the given Edge object. Because an Edge object does not have any knowledge of the VisualVertex in its endpoints, the parameter visualgraph is required for this class to determine the VisualVertex objects at its endpoints.

Parameters:

edge - The Edge object that the VisualEdge will encapsulate.

visualgraph - The VisualGraph object where the VisualEdge will be drawn.

Method Detail

getEdge

public Edge getEdge()

Returns the Edge object that VisualEdge encapsulates.

Returns:

The Edge object that the VisualEdge encapsulates.

getVisualVertexA

public VisualVertex getVisualVertexA()

Returns the VisualVertex object at the tail of the edge. For directed graphs, this is the VisualVertex at the opposite end of where the arrowhead is drawn.

Returns:

The VisualVertex object at the tail of the edge.

getVisualVertexB

public VisualVertex getVisualVertexB()

Returns the VisualVertex object at the head of the edge. For directed graphs, this is the VisualVertex at the end where the arrowhead is drawn.

Returns:

The VisualVertex object at the head of the edge.

setLinetype

protected void setLinetype(int linetype)

setOrthogonalLine

public void setOrthogonalLine()

setStraightLine

public void setStraightLine()

setFromPortAssignment

public void setFromPortAssignment(Point2D newport)

setToPortAssignment

public void setToPortAssignment(Point2D newport)

getFromPortAssignment

public Point2D.Double getFromPortAssignment()

getToPortAssignment

public Point2D.Double getToPortAssignment()

toString

public String toString()

Description copied from interface: VisualGraphComponent

String representation of the VisualGraphComponent.

Specified by:

toString in interface VisualGraphComponent

Overrides:

toString in class Object

ptSegDist

public double ptSegDist(int x,
                        int y)

Returns the distance between a point and the edge's path. All segments of the edge's GeneralPath is iterated to determine which segment has the shortest distance with the point, and that distance is returned.

Parameters:

x - x coordinate of the point

y - y coordinate of the points

Returns:

The distance between the point and the edge's path.

paint

public void paint(Graphics2D g2d,
                  GraphLayoutManager layoutmanager)

Draw the VisualEdge with the specified 2D graphics context. The endpoints of the line is always determined at every call to this method by the center coordinates of the bounding rectangle of both visualVertexA and visualVertexB.

Parameters:

g2d - The Graphics2D graphics context object used to draw the VisualEdge object.

rescale

public void rescale()

Do nothing.

getEdgeLength

public float getEdgeLength(VisualEdge vEdge,
                           Point fromPoint,
                           Point toPoint)

Returns the length of the VisualEdge as dictated by its GeneralPath