com.yworks.yfiles.layout

Class LayoutGraph

java.lang.Object

com.yworks.yfiles.algorithms.Graph

com.yworks.yfiles.layout.LayoutGraph

All Implemented Interfaces:

com.yworks.yfiles.algorithms.IGraphInterface, com.yworks.yfiles.layout.IGraphLayout

Direct Known Subclasses:

CopiedLayoutGraph, DefaultLayoutGraph

public abstract class LayoutGraph
extends Graph
implements com.yworks.yfiles.layout.IGraphLayout

A LayoutGraph is a Graph with attached layout information that basically represents a drawing of a graph.

It provides access to the layout information for nodes, edges and labels. This layout information consists of coordinates for the elements.

Layout algorithms work on LayoutGraphs and arrange their nodes and edges.

Constructor Summary

Constructors

Constructor and Description
LayoutGraph() Creates a new, empty LayoutGraph with default settings.
LayoutGraph(LayoutGraph subgraph) Creates a new LayoutGraph which is a copy of the given subgraph.
LayoutGraph(LayoutGraph graph, ICursor nodeSubset) Creates a new LayoutGraph which is a copy of the given subgraph.

Method Summary

Modifier and Type	Method and Description
protected abstract ILabelLayoutFactory	createLabelFactory() Creates a new ILabelLayoutFactory for this LayoutGraph that can be used for copying layout information of labels.
Rectangle2D	getBoundingBox()
YRectangle	getBoundingBox(Node node) Returns the rectangle describing the bounding box of the given node.
YPoint	getCenter(Node node) Returns the center coordinates of the given node.
double	getCenterX(Node node) Returns the x-coordinate of the given node's center.
double	getCenterY(Node node) Returns the y-coordinate of the given node's center.
EdgeList	getEdgeList() Gets a list of all edges in the graph.
double	getHeight(Node node) Returns the height of the given node.
abstract IEdgeLabelLayout[]	getLabelLayout(Edge edge) Returns the layout information for all labels associated with the given edge.
abstract INodeLabelLayout[]	getLabelLayout(Node node) Returns the layout information for all labels associated with the given node.
abstract IEdgeLayout	getLayout(Edge edge) Returns the layout information for the given edge.
abstract INodeLayout	getLayout(Node node) Returns the layout information for the given node.
YPoint	getLocation(Node node) Returns the coordinates of the given node's upper-left corner.
abstract Edge	getOwner(IEdgeLabelLayout labelLayout) Returns the edge to which the given IEdgeLabelLayout belongs.
abstract Node	getOwner(INodeLabelLayout labelLayout) Returns the node to which the given INodeLabelLayout belongs.
YPointPath	getPath(Edge edge) Returns the path of an edge, including the ports.
YList	getPathList(Edge edge) Returns the path of an edge, including the ports.
YList	getPointList(Edge edge) Returns the control points of an edge.
YPointPath	getPoints(Edge edge) Returns the control points of an edge.
YDimension	getSize(Node node) Returns the size of the given node.
YPoint	getSourcePointAbs(Edge edge) Returns the absolute coordinates of the source point of the given edge.
YPoint	getSourcePointRel(Edge edge) Returns the relative coordinates of the source point of the given edge.
YPoint	getTargetPointAbs(Edge edge) Returns the absolute coordinates of the target point of the given edge.
YPoint	getTargetPointRel(Edge edge) Returns the relative coordinates of the target point of the given edge.
double	getWidth(Node node) Returns the width of the given node.
double	getX(Node node) Returns the x-coordinate of the given node's upper-left corner.
double	getY(Node node) Returns the y-coordinate of the given node's upper-left corner.
void	moveBy(Node node, double dx, double dy) Moves the upper-left corner of a node by a given vector.
void	setCenter(Node node, double x, double y) Specifies the center coordinates of the given node.
void	setCenter(Node node, YPoint position) Specifies the center coordinates of the given node.
void	setEndPointsAbs(Edge edge, YPoint source, YPoint target) Specifies the two end points of the given edge in absolute coordinates.
void	setLocation(Node node, double x, double y) Specifies the coordinates of the upper-left corner of the given node.
void	setLocation(Node node, YPoint position) Specifies the coordinates of the upper-left corner of the given node.
void	setPath(Edge edge, YList path) Sets the path of the given edge.
void	setPath(Edge edge, YPointPath path) Sets the path of the given edge.
void	setPoints(Edge edge, YList points) Sets the control points of the given edge.
void	setPoints(Edge edge, YPointPath points) Sets the control points of the given edge.
void	setSize(Node node, double width, double height) Specifies the width and height of the given node.
void	setSize(Node node, YDimension size) Specifies the size of the given node.
void	setSourcePointAbs(Edge edge, YPoint point) Specifies the absolute coordinates of the source point of the given edge.
void	setSourcePointRel(Edge edge, YPoint point) Specifies the relative coordinates of the source point of the given edge.
void	setTargetPointAbs(Edge edge, YPoint point) Specifies the absolute coordinates of the target point of the given edge.
void	setTargetPointRel(Edge edge, YPoint point) Specifies the relative coordinates of the target point of the given edge.

Methods inherited from class com.yworks.yfiles.algorithms.Graph

addDataProvider, changeEdge, changeEdge, changeEdge, clear, contains, contains, containsEdge, createCopy, createEdge, createEdge, createEdgeMap, createGraph, createNode, createNodeMap, disposeEdgeMap, disposeNodeMap, edgeCount, edgeObjects, firstEdge, firstNode, firstOutEdge, getDataProvider, getDataProviderKeys, getEdgeArray, getEdgeCursor, getEdges, getNodeArray, getNodeCursor, getNodes, getRegisteredEdgeMaps, getRegisteredNodeMaps, getSource, getTarget, hasListeners, hide, hide, isEmpty, lastEdge, lastNode, moveToFirst, moveToFirst, moveToLast, moveToLast, nodeCount, nodeObjects, printNodeSlotSize, reInsertEdge, reInsertNode, removeDataProvider, removeEdge, removeNode, reverseEdge, sortEdges, sortEdges, sortNodes, toString, unhide, unhide

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yworks.yfiles.layout.IGraphLayout

getEdgeLabelLayout, getEdgeLayout, getNodeLabelLayout, getNodeLayout

Constructor Detail

LayoutGraph

public LayoutGraph()

Creates a new, empty LayoutGraph with default settings.

LayoutGraph

public LayoutGraph(LayoutGraph subgraph)

Creates a new LayoutGraph which is a copy of the given subgraph.

Parameters:

subgraph - the original subgraph

LayoutGraph

public LayoutGraph(LayoutGraph graph,
                   ICursor nodeSubset)

Creates a new LayoutGraph which is a copy of the given subgraph.

Parameters:

graph - the original graph

nodeSubset - the nodes that induce the subgraph

Method Detail

createLabelFactory

protected abstract ILabelLayoutFactory createLabelFactory()

Creates a new ILabelLayoutFactory for this LayoutGraph that can be used for copying layout information of labels.

Returns:

the new ILabelLayoutFactory

getBoundingBox

public final Rectangle2D getBoundingBox()

Specified by:

getBoundingBox in interface com.yworks.yfiles.layout.IGraphLayout

getBoundingBox

public YRectangle getBoundingBox(Node node)

Returns the rectangle describing the bounding box of the given node.

Parameters:

node - the node

Returns:

the bounds of the node

See Also:

getLocation(Node), getSize(Node)

getCenter

public YPoint getCenter(Node node)

Returns the center coordinates of the given node.

Parameters:

node - the node

Returns:

the location of the node's center

See Also:

INodeLayout, setCenter(Node, double, double)

getCenterX

public double getCenterX(Node node)

Returns the x-coordinate of the given node's center.

Parameters:

node - the node

Returns:

the x-value of the node's center coordinate

See Also:

INodeLayout

getCenterY

public double getCenterY(Node node)

Returns the y-coordinate of the given node's center.

Parameters:

node - the node

Returns:

the y-value of the node's center coordinate

See Also:

INodeLayout

getEdgeList

public EdgeList getEdgeList()

Gets a list of all edges in the graph.

Returns:

the edges contained in the graph

getHeight

public double getHeight(Node node)

Returns the height of the given node.

Parameters:

node - the node

Returns:

the height of the node

See Also:

INodeLayout.getHeight()

getLabelLayout

public abstract IEdgeLabelLayout[] getLabelLayout(Edge edge)

Returns the layout information for all labels associated with the given edge.

The layout information consists of the location, size and orientation of the label.

Parameters:

edge - the edge

Returns:

the layout information for the edge's labels

getLabelLayout

public abstract INodeLabelLayout[] getLabelLayout(Node node)

Returns the layout information for all labels associated with the given node.

The layout information consists of the location, size and orientation of the label.

Parameters:

node - the node

Returns:

the layout information for the node's labels

getLayout

public abstract IEdgeLayout getLayout(Edge edge)

Returns the layout information for the given edge.

The layout information consists of the locations of the control points and end points of the edge.

Parameters:

edge - the edge

Returns:

the layout information for the edge

getLayout

public abstract INodeLayout getLayout(Node node)

Returns the layout information for the given node.

The layout information consists of the location and size of the node.

Parameters:

node - the node

Returns:

the layout information for the node

getLocation

public YPoint getLocation(Node node)

Returns the coordinates of the given node's upper-left corner.

Parameters:

node - the node

Returns:

the location of the node's upper-left corner

See Also:

INodeLayout.getX(), INodeLayout.getY()

getOwner

public abstract Edge getOwner(IEdgeLabelLayout labelLayout)

Returns the edge to which the given IEdgeLabelLayout belongs.

Parameters:

labelLayout - the label's layout information

Returns:

the edge that owns the label

getOwner

public abstract Node getOwner(INodeLabelLayout labelLayout)

Returns the node to which the given INodeLabelLayout belongs.

Parameters:

labelLayout - the label's layout information

Returns:

the node that owns the label

getPath

public YPointPath getPath(Edge edge)

Returns the path of an edge, including the ports.

The path of an edge is the position of the source port, followed by the positions of the bends, followed by the position of the target port.

Parameters:

edge - the edge

Returns:

the path of the given edge

getPathList

public YList getPathList(Edge edge)

Returns the path of an edge, including the ports.

The path of an edge is the position of the source port, followed by the positions of the bends, followed by the position of the target port.

Parameters:

edge - the edge

Returns:

a list of YPoints representing the path of the given edge

getPointList

public YList getPointList(Edge edge)

Returns the control points of an edge.

The source and target port are not included in this path.

Parameters:

edge - the edge

Returns:

a list of YPoints representing the sequence of control points of the edge

See Also:

IEdgeLayout

getPoints

public YPointPath getPoints(Edge edge)

Returns the control points of an edge.

The source and target port are not included in this path.

Parameters:

edge - the edge

Returns:

a YPointPath representing the sequence of control points of the edge

See Also:

IEdgeLayout

getSize

public YDimension getSize(Node node)

Returns the size of the given node.

Parameters:

node - the node

Returns:

the size of the node

See Also:

INodeLayout.getWidth(), INodeLayout.getHeight()

getSourcePointAbs

public YPoint getSourcePointAbs(Edge edge)

Returns the absolute coordinates of the source point of the given edge.

Parameters:

edge - the edge

Returns:

the absolute source point coordinates of the edge

getSourcePointRel

public YPoint getSourcePointRel(Edge edge)

Returns the relative coordinates of the source point of the given edge.

The coordinates are interpreted relative to the center of the source node.

Parameters:

edge - the edge

Returns:

the relative source point coordinates of the edge

See Also:

IEdgeLayout.getSourcePoint()

getTargetPointAbs

public YPoint getTargetPointAbs(Edge edge)

Returns the absolute coordinates of the target point of the given edge.

Parameters:

edge - the edge

Returns:

the absolute target point coordinates of the edge

getTargetPointRel

public YPoint getTargetPointRel(Edge edge)

Returns the relative coordinates of the target point of the given edge.

The coordinates are interpreted relative to the center of the target node.

Parameters:

edge - the edge

Returns:

the relative target point coordinates of the edge

See Also:

IEdgeLayout.getTargetPoint()

getWidth

public double getWidth(Node node)

Returns the width of the given node.

Parameters:

node - the node

Returns:

the width of the node

See Also:

INodeLayout.getWidth()

getX

public double getX(Node node)

Returns the x-coordinate of the given node's upper-left corner.

Parameters:

node - the node

Returns:

the x-value of the node's upper-left corner

See Also:

INodeLayout.getX()

getY

public double getY(Node node)

Returns the y-coordinate of the given node's upper-left corner.

Parameters:

node - the node

Returns:

the y-value of the node's upper-left corner

See Also:

INodeLayout.getY()

moveBy

public void moveBy(Node node,
                   double dx,
                   double dy)

Moves the upper-left corner of a node by a given vector.

Parameters:

node - the node

dx - the x-component of the vector

dy - the y-component of the vector

setCenter

public void setCenter(Node node,
                      double x,
                      double y)

Specifies the center coordinates of the given node.

Parameters:

node - the node

x - the new x-coordinate of the node's center

y - the new y-coordinate of the node's center

See Also:

INodeLayout

setCenter

public void setCenter(Node node,
                      YPoint position)

Specifies the center coordinates of the given node.

Parameters:

node - the node

position - the new location of the node's center

See Also:

INodeLayout, setCenter(Node, double, double)

setEndPointsAbs

public void setEndPointsAbs(Edge edge,
                            YPoint source,
                            YPoint target)

Specifies the two end points of the given edge in absolute coordinates.

Parameters:

edge - the edge

source - the port on the source side of the edge

target - the port on the target side of the edge

See Also:

setSourcePointAbs(Edge, YPoint), setTargetPointAbs(Edge, YPoint)

setLocation

public void setLocation(Node node,
                        double x,
                        double y)

Specifies the coordinates of the upper-left corner of the given node.

Parameters:

node - the node

x - the new x-coordinate of the upper-left corner

y - the new y-coordinate of the upper-left corner

See Also:

INodeLayout.setLocation(double, double)

setLocation

public void setLocation(Node node,
                        YPoint position)

Specifies the coordinates of the upper-left corner of the given node.

Parameters:

node - the node

position - the new location of the upper-left corner

See Also:

INodeLayout.setLocation(double, double), setLocation(Node, double, double)

setPath

public void setPath(Edge edge,
                    YList path)

Sets the path of the given edge.

The path of an edge is the position of the source port, followed by the positions of the bends, followed by the position of the target port.

Both source and target port are expected to be given in absolute coordinates.

Previously specified coordinates will be cleared.

Precondition:

The length of the path must be at least 2.

Parameters:

edge - an edge in the graph

path - the list of YPoints representing the new path sequence of the edge

setPath

public void setPath(Edge edge,
                    YPointPath path)

Sets the path of the given edge.

The path of an edge is the position of the source port, followed by the positions of the bends, followed by the position of the target port.

Both source and target port are expected to be given in absolute coordinates.

Previously specified coordinates will be cleared.

Precondition:

The length of the path must be at least 2.

Parameters:

edge - an edge in the graph

path - the new path sequence of the edge

setPoints

public void setPoints(Edge edge,
                      YList points)

Sets the control points of the given edge.

The source and target points of the edge will not be modified.

Previously specified points will be cleared.

Parameters:

edge - an edge in the graph

points - the list of YPoints representing the new sequence of control points

setPoints

public void setPoints(Edge edge,
                      YPointPath points)

Sets the control points of the given edge.

The source and target points of the edge will not be modified.

Previously specified points will be cleared.

Parameters:

edge - an edge in the graph

points - the new sequence of control points

setSize

public void setSize(Node node,
                    double width,
                    double height)

Specifies the width and height of the given node.

Parameters:

node - the node

width - the new width of the node

height - the new height of the node

See Also:

INodeLayout.setSize(double, double)

setSize

public void setSize(Node node,
                    YDimension size)

Specifies the size of the given node.

Parameters:

node - the node

size - the new size of the node

See Also:

setSize(Node, double, double), INodeLayout.setSize(double, double)

setSourcePointAbs

public void setSourcePointAbs(Edge edge,
                              YPoint point)

Specifies the absolute coordinates of the source point of the given edge.

Parameters:

edge - the edge

point - the new absolute source point coordinates of the edge

setSourcePointRel

public void setSourcePointRel(Edge edge,
                              YPoint point)

Specifies the relative coordinates of the source point of the given edge.

The coordinates are interpreted relative to the center of the source node.

Parameters:

edge - the edge

point - the new relative source point coordinates of the edge

See Also:

IEdgeLayout.setSourcePoint(YPoint)

setTargetPointAbs

public void setTargetPointAbs(Edge edge,
                              YPoint point)

Specifies the absolute coordinates of the target point of the given edge.

Parameters:

edge - the edge

point - the new absolute target point coordinates of the edge

setTargetPointRel

public void setTargetPointRel(Edge edge,
                              YPoint point)

Specifies the relative coordinates of the target point of the given edge.

The coordinates are interpreted relative to the center of the target node.

Parameters:

edge - the edge

point - the new relative target point coordinates of the edge

See Also:

IEdgeLayout.setTargetPoint(YPoint)