org.jgraph.graph

Class EdgeView

Implemented Interfaces:
CellView, Serializable

public class EdgeView
extends AbstractCellView

The default implementation of an edge view. The getEdgeRenderer method assumes a renderer of type EdgeRenderer. If you provide a custom renderer to a subclass, you must also override the methods that call this method, namely: getShape, getLabelBounds, getExtraLabelBounds, intersects and getBounds.

Nested Class Summary

static class
EdgeView.EdgeHandle

Field Summary

Shape
beginShape
Drawing attributes that are created on the fly
protected Rectangle2D
cachedBounds
Shape
endShape
Drawing attributes that are created on the fly
protected Point2D[]
extraLabelPositions
protected Point2D
labelPosition
Cached label position of the edge.
protected Point2D
labelVector
Shape
lineShape
Drawing attributes that are created on the fly
protected List
points
List of points of the edge.
static EdgeRenderer
renderer
Renderer for the class.
GeneralPath
sharedPath
Shared-path tune-up.
protected CellView
source
Cached source and target portview of the edge.
protected CellView
sourceParentView
protected CellView
target
Cached source and target portview of the edge.
protected CellView
targetParentView

Fields inherited from class org.jgraph.graph.AbstractCellView

allAttributes, attributes, cell, cellEditor, childViews, groupBounds, parent

Constructor Summary

EdgeView()
Constructs an empty edge view.
EdgeView(Object cell)
Constructs an edge view for the specified model object.

Method Summary

void
addExtraLabel(Point2D location, Object label)
Adds an extra label.
void
addPoint(int index, Point2D p)
Adds p at position index.
protected void
checkDefaultLabelPosition()
Hook for subclassers to avoid default label positions.
Rectangle2D
getBounds()
Returns the location for this edgeview.
Point2D
getExtraLabelPosition(int index)
Returns a point that describes the position of the label.
CellHandle
getHandle(GraphContext context)
Returns a cell handle for the view.
Point2D
getLabelPosition()
Returns a point that describes the position of the label.
Point2D
getLabelVector()
Hook to return the vector that is taken as the base vector to compute relative label positions.
static double
getLength(CellView view)
protected Point2D
getNearestPoint(boolean source)
Returns the nearest point wrt to the source or target.
Point2D
getPerimeterPoint(EdgeView edge, Point2D source, Point2D p)
Returns the intersection of the bounding rectangle and the straight line between the source and the specified point p.
Point2D
getPoint(int index)
Returns the cached points for this edge.
int
getPointCount()
Returns the number of point for this edge.
protected Point2D
getPointLocation(int index)
Returns the point of edge at index.
List
getPoints()
Returns the points.
CellViewRenderer
getRenderer()
Returns a renderer for the class.
Shape
getShape()
Returns the shape of the view according to the last rendering state
CellView
getSource()
Returns the CellView that represents the source of the edge.
CellView
getSourceParentView()
CellView
getTarget()
Returns the CellView that represents the target of the edge.
CellView
getTargetParentView()
protected CellView
getVisibleParent(GraphModel model, CellMapper mapper, Object port)
boolean
intersects(JGraph graph, Rectangle2D rect)
Returns true if this view intersects the given rectangle.
protected void
invalidate()
Resets the cached values of the edge view
boolean
isLoop()
Returns true if the edge is a loop.
void
refresh(GraphLayoutCache cache, CellMapper mapper, boolean createDependentViews)
Overrides the parent method to udpate the cached points, source and target port.
void
removeExtraLabel(int index)
Removes the point at position index.
void
removePoint(int index)
Removes the point at position index.
void
setExtraLabelPosition(int index, Point2D pos)
Sets the description of the label position.
void
setLabelPosition(Point2D pos)
Sets the description of the label position.
void
setPoint(int index, Point2D p)
Sets the point at index to p.
void
setSource(CellView sourceView)
Sets the sourceView of the edge.
void
setTarget(CellView targetView)
Sets the targetView of the edge.
void
update(GraphLayoutCache cache)
Update attributes and recurse children.

Methods inherited from class org.jgraph.graph.AbstractCellView

changeAttributes, childUpdated, createAttributeMap, getAllAttributes, getAttributes, getBounds, getBounds, getCell, getCellAttributes, getCenterPoint, getChildViews, getDescendantViews, getEditor, getHandle, getParentView, getPerimeterPoint, getRenderer, getRendererComponent, includeInGroupBounds, intersects, isLeaf, mergeAttributes, refresh, removeFromParent, scale, setAttributes, setBounds, setCell, translate, update, updateGroupBounds

Field Details

beginShape

public Shape beginShape
Drawing attributes that are created on the fly

cachedBounds

protected Rectangle2D cachedBounds

endShape

public Shape endShape
Drawing attributes that are created on the fly

extraLabelPositions

protected Point2D[] extraLabelPositions

labelPosition

protected Point2D labelPosition
Cached label position of the edge.

labelVector

protected Point2D labelVector

lineShape

public Shape lineShape
Drawing attributes that are created on the fly

points

protected List points
List of points of the edge. May contain ports.

renderer

public static EdgeRenderer renderer
Renderer for the class.

sharedPath

public GeneralPath sharedPath
Shared-path tune-up.

source

protected CellView source
Cached source and target portview of the edge.

sourceParentView

protected CellView sourceParentView

target

protected CellView target
Cached source and target portview of the edge.

targetParentView

protected CellView targetParentView

Constructor Details

EdgeView

public EdgeView()
Constructs an empty edge view.

EdgeView

public EdgeView(Object cell)
Constructs an edge view for the specified model object.
Parameters:
cell - reference to the model object

Method Details

addExtraLabel

public void addExtraLabel(Point2D location,
                          Object label)
Adds an extra label.

addPoint

public void addPoint(int index,
                     Point2D p)
Adds p at position index.

checkDefaultLabelPosition

protected void checkDefaultLabelPosition()
Hook for subclassers to avoid default label positions.

getBounds

public Rectangle2D getBounds()
Returns the location for this edgeview.
Specified by:
getBounds in interface CellView
Overrides:
getBounds in interface AbstractCellView

getExtraLabelPosition

public Point2D getExtraLabelPosition(int index)
Returns a point that describes the position of the label.

getHandle

public CellHandle getHandle(GraphContext context)
Returns a cell handle for the view.
Specified by:
getHandle in interface CellView
Overrides:
getHandle in interface AbstractCellView

getLabelPosition

public Point2D getLabelPosition()
Returns a point that describes the position of the label.

getLabelVector

public Point2D getLabelVector()
Hook to return the vector that is taken as the base vector to compute relative label positions. Normally, the vector goes from the first to the last point on the edge, unless these points are equal, in which case the average distance of all points to the source point is used.

getLength

public static double getLength(CellView view)

getNearestPoint

protected Point2D getNearestPoint(boolean source)
Returns the nearest point wrt to the source or target. This method returns the next or previous point or port in the points list, eg. if source is true it returns the location of the point or port at index 1 without calling the getLocation method on any ports.
Likewise, the method returns the location at index getPointCount()-2 if source is false.

getPerimeterPoint

public Point2D getPerimeterPoint(EdgeView edge,
                                 Point2D source,
                                 Point2D p)
Returns the intersection of the bounding rectangle and the straight line between the source and the specified point p. The specified point is expected not to intersect the bounds. Note: You must override this method if you use a different renderer. This is because this method relies on the VertexRenderer interface, which can not be safely assumed for subclassers.
Specified by:
getPerimeterPoint in interface CellView
Overrides:
getPerimeterPoint in interface AbstractCellView

getPoint

public Point2D getPoint(int index)
Returns the cached points for this edge.

getPointCount

public int getPointCount()
Returns the number of point for this edge.

getPointLocation

protected Point2D getPointLocation(int index)
Returns the point of edge at index. Avoids calling getLocation on any ports of edge.
This is used from within getPoint to pass the nearest point to the portview to find it's location. This uses the center point of the parent view to determine the port view's location to avoid infinite recursion.

getPoints

public List getPoints()
Returns the points.
Returns:
List

getRenderer

public CellViewRenderer getRenderer()
Returns a renderer for the class.
Overrides:
getRenderer in interface AbstractCellView

getShape

public Shape getShape()
Returns the shape of the view according to the last rendering state

getSource

public CellView getSource()
Returns the CellView that represents the source of the edge.

getSourceParentView

public CellView getSourceParentView()

getTarget

public CellView getTarget()
Returns the CellView that represents the target of the edge.

getTargetParentView

public CellView getTargetParentView()

getVisibleParent

protected CellView getVisibleParent(GraphModel model,
                                    CellMapper mapper,
                                    Object port)

intersects

public boolean intersects(JGraph graph,
                          Rectangle2D rect)
Returns true if this view intersects the given rectangle.
Specified by:
intersects in interface CellView
Overrides:
intersects in interface AbstractCellView

invalidate

protected void invalidate()
Resets the cached values of the edge view

isLoop

public boolean isLoop()
Returns true if the edge is a loop.

refresh

public void refresh(GraphLayoutCache cache,
                    CellMapper mapper,
                    boolean createDependentViews)
Overrides the parent method to udpate the cached points, source and target port. If the source or target is removed, a point is inserted into the array of points.
Specified by:
refresh in interface CellView
Overrides:
refresh in interface AbstractCellView

removeExtraLabel

public void removeExtraLabel(int index)
Removes the point at position index.

removePoint

public void removePoint(int index)
Removes the point at position index.

setExtraLabelPosition

public void setExtraLabelPosition(int index,
                                  Point2D pos)
Sets the description of the label position.

setLabelPosition

public void setLabelPosition(Point2D pos)
Sets the description of the label position.

setPoint

public void setPoint(int index,
                     Point2D p)
Sets the point at index to p.

setSource

public void setSource(CellView sourceView)
Sets the sourceView of the edge.

setTarget

public void setTarget(CellView targetView)
Sets the targetView of the edge.

update

public void update(GraphLayoutCache cache)
Update attributes and recurse children.
Specified by:
update in interface CellView
Overrides:
update in interface AbstractCellView

Copyright (C) 2001-2006 Gaudenz Alder. All rights reserved.