com.yworks.yfiles.layout

Class DefaultLayoutGraph

java.lang.Object

com.yworks.yfiles.algorithms.Graph

com.yworks.yfiles.layout.LayoutGraph

com.yworks.yfiles.layout.DefaultLayoutGraph

All Implemented Interfaces:

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

public class DefaultLayoutGraph
extends LayoutGraph

DefaultLayoutGraph is a default implementation of LayoutGraph which holds the complete layout information about the graph and its elements.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Object,Object>	edgeLabelFeatureMap A Map associating the owner of an edge label with the edge label itself.
protected IEdgeMap	edgeLabelMap An IEdgeMap associating IEdgeLabelLayouts with the edges of this graph.
protected Map<Object,Object>	nodeLabelFeatureMap A Map associating the owner of a node label with the node label itself.
protected INodeMap	nodeLabelMap A INodeMap associating INodeLabelLayouts with the nodes of this graph.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected IEdgeLayout	createEdgeLayout() Creates a new implementation of IEdgeLayout.
protected ILabelLayoutFactory	createLabelFactory() Creates a new ILabelLayoutFactory for this LayoutGraph that can be used for copying layout information of labels.
protected INodeLayout	createNodeLayout() Creates a new implementation of INodeLayout.
IEdgeLabelLayout[]	getLabelLayout(Edge edge) Returns the layout information for all labels associated with the given edge.
INodeLabelLayout[]	getLabelLayout(Node node) Returns the layout information for all labels associated with the given node.
IEdgeLayout	getLayout(Edge edge) Returns the layout information for the given edge.
INodeLayout	getLayout(Node node) Returns the layout information for the given node.
Edge	getOwner(IEdgeLabelLayout labelLayout) Returns the edge to which the given IEdgeLabelLayout belongs.
Node	getOwner(INodeLabelLayout labelLayout) Returns the node to which the given INodeLabelLayout belongs.
void	setLabelLayout(Edge edge, IEdgeLabelLayout[] layout) Specifies the layout information for all associated labels of the given edge.
void	setLabelLayout(Node node, INodeLabelLayout layout) Specifies the layout information for all associated labels of the given node in case there is only one label.
void	setLabelLayout(Node node, INodeLabelLayout[] layout) Specifies the layout information for all associated labels of the given node.
void	setLayout(Edge edge, IEdgeLayout layout) Specifies the layout information for the given edge.
void	setLayout(Node node, INodeLayout layout) Specifies the layout information for the given node.

Methods inherited from class com.yworks.yfiles.layout.LayoutGraph

getBoundingBox, getBoundingBox, getCenter, getCenterX, getCenterY, getEdgeList, getHeight, getLocation, getPath, getPathList, getPointList, getPoints, getSize, getSourcePointAbs, getSourcePointRel, getTargetPointAbs, getTargetPointRel, getWidth, getX, getY, moveBy, setCenter, setCenter, setEndPointsAbs, setLocation, setLocation, setPath, setPath, setPoints, setPoints, setSize, setSize, setSourcePointAbs, setSourcePointRel, setTargetPointAbs, setTargetPointRel

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

Field Detail

edgeLabelFeatureMap

protected Map<Object,Object> edgeLabelFeatureMap

A Map associating the owner of an edge label with the edge label itself.

edgeLabelMap

protected IEdgeMap edgeLabelMap

An IEdgeMap associating IEdgeLabelLayouts with the edges of this graph.

See Also:

setLabelLayout(Edge, IEdgeLabelLayout[])

nodeLabelFeatureMap

protected Map<Object,Object> nodeLabelFeatureMap

A Map associating the owner of a node label with the node label itself.

nodeLabelMap

protected INodeMap nodeLabelMap

A INodeMap associating INodeLabelLayouts with the nodes of this graph.

See Also:

setLabelLayout(Node, INodeLabelLayout[])

Constructor Detail

DefaultLayoutGraph

public DefaultLayoutGraph()

Creates a new DefaultLayoutGraph instance with default settings.

DefaultLayoutGraph

public DefaultLayoutGraph(LayoutGraph argGraph)

Creates a new DefaultLayoutGraph instance which is a copy of the given graph.

Parameters:

argGraph - the original graph

DefaultLayoutGraph

public DefaultLayoutGraph(LayoutGraph graph,
                          ICursor nodeSubset)

Creates a new DefaultLayoutGraph instance which is a copy of the given subgraph.

Parameters:

graph - the original graph

nodeSubset - the nodes that induce a subgraph of the original graph

Method Detail

createEdgeLayout

protected IEdgeLayout createEdgeLayout()

Creates a new implementation of IEdgeLayout.

This method is called by getLayout(Edge) if there is no layout information assigned to an edge, yet. It may be overridden to create custom IEdgeLayouts.

Returns:

the layout of an edge

createLabelFactory

protected ILabelLayoutFactory createLabelFactory()

Description copied from class: LayoutGraph

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

Specified by:

createLabelFactory in class LayoutGraph

Returns:

the new ILabelLayoutFactory

createNodeLayout

protected INodeLayout createNodeLayout()

Creates a new implementation of INodeLayout.

This method is called by getLayout(Node) if there is no layout information assigned to a node, yet. It may be overridden to create custom INodeLayouts.

Returns:

the layout of a node

getLabelLayout

public IEdgeLabelLayout[] getLabelLayout(Edge edge)

Description copied from class: LayoutGraph

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.

Specified by:

getLabelLayout in class LayoutGraph

Parameters:

edge - the edge

Returns:

the layout information for the edge's labels

getLabelLayout

public INodeLabelLayout[] getLabelLayout(Node node)

Description copied from class: LayoutGraph

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.

Specified by:

getLabelLayout in class LayoutGraph

Parameters:

node - the node

Returns:

the layout information for the node's labels

getLayout

public IEdgeLayout getLayout(Edge edge)

Description copied from class: LayoutGraph

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.

Specified by:

getLayout in class LayoutGraph

Parameters:

edge - the edge

Returns:

the layout information for the edge

getLayout

public INodeLayout getLayout(Node node)

Description copied from class: LayoutGraph

Returns the layout information for the given node.

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

Specified by:

getLayout in class LayoutGraph

Parameters:

node - the node

Returns:

the layout information for the node

getOwner

public Edge getOwner(IEdgeLabelLayout labelLayout)

Description copied from class: LayoutGraph

Returns the edge to which the given IEdgeLabelLayout belongs.

Specified by:

getOwner in class LayoutGraph

Parameters:

labelLayout - the label's layout information

Returns:

the edge that owns the label

getOwner

public Node getOwner(INodeLabelLayout labelLayout)

Description copied from class: LayoutGraph

Returns the node to which the given INodeLabelLayout belongs.

Specified by:

getOwner in class LayoutGraph

Parameters:

labelLayout - the label's layout information

Returns:

the node that owns the label

setLabelLayout

public void setLabelLayout(Edge edge,
                           IEdgeLabelLayout[] layout)

Specifies the layout information for all associated labels of the given edge.

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

Parameters:

edge - the edge

layout - the layout information for the labels of the edge

setLabelLayout

public void setLabelLayout(Node node,
                           INodeLabelLayout layout)

Specifies the layout information for all associated labels of the given node in case there is only one label.

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

Parameters:

node - the node

layout - the layout information for the label of the node

setLabelLayout

public void setLabelLayout(Node node,
                           INodeLabelLayout[] layout)

Specifies the layout information for all associated labels of the given node.

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

Parameters:

node - the node

layout - the layout information for the labels of the node

setLayout

public void setLayout(Edge edge,
                      IEdgeLayout layout)

Specifies the layout information for the given edge.

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

Parameters:

edge - the edge

layout - the layout information for the edge

setLayout

public void setLayout(Node node,
                      INodeLayout layout)

Specifies the layout information for the given node.

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

Parameters:

node - the node

layout - the layout information for the node