com.yworks.yfiles.layout.multipage

Class LayoutContext

java.lang.Object

com.yworks.yfiles.layout.multipage.LayoutContext

All Implemented Interfaces:

IElementInfoManager

public class LayoutContext
extends Object
implements IElementInfoManager

This class represents the layout context.

It provides several methods to access data as well as adding and removing elements.

Method Summary

Modifier and Type	Method and Description
void	addEdgeLabel(IEdgeLabelLayout label, Edge labeledElement) Adds a label to a given edge.
void	addNodeLabel(INodeLabelLayout label, Node labeledElement) Adds a label to a given node.
Edge	createEdge(Node source, Node target, Object sameDataElementId) All methods of the IElementFactory have to use this method to create an edge.
Node	createNode(Object sameDataElementId) All methods of the IElementFactory have to use this method to create a node.
IEdgeInfo	getEdgeInfo(Edge edge) Returns the edge information object of the given edge.
IEdgeLabelInfo	getEdgeLabelInfo(IEdgeLabelLayout edgeLabelLayout) Returns the edge label information object of the given edge label layout.
LayoutGraph	getGraph() Gets the relevant graph.
MultiPageLayout	getLayout() Gets the layouter object that belongs to this layout context.
INodeInfo	getNodeInfo(Node node) Returns the node information object of the given node.
INodeLabelInfo	getNodeLabelInfo(INodeLabelLayout nodeLabelLayout) Returns the node label layout information object of the given node label layout.
Edge	getOriginalEdge(Object id) Returns the edge of the input graph with the given ID or null if there is no such edge.
Node	getOriginalNode(Object id) Returns the node of the input graph with the given ID or null if there is no such node.
Edge	getPageEdge(Object id) Returns the edge of a page graph (a graph that represents the result of the multi-page layout) with the given ID or null if there is no such edge.
Node	getPageNode(Object id) Returns the node of a page graph (a graph that represents the result of the multi-page layout) with the given ID or null if there is no such node.
boolean	removeEdgeLabel(IEdgeLabelLayout label, Edge labeledElement) Removes a label from a given edge.
boolean	removeNodeLabel(INodeLabelLayout label, Node labeledElement) Removes a label from a given node.

Methods inherited from class java.lang.Object

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

Method Detail

addEdgeLabel

public void addEdgeLabel(IEdgeLabelLayout label,
                         Edge labeledElement)

Adds a label to a given edge.

Parameters:

label - the label that should be added to the given edge

labeledElement - the edge to which the label should be added

addNodeLabel

public void addNodeLabel(INodeLabelLayout label,
                         Node labeledElement)

Adds a label to a given node.

Parameters:

label - the label that should be added to the given node

labeledElement - the node to which the label should be added

createEdge

public Edge createEdge(Node source,
                       Node target,
                       Object sameDataElementId)

All methods of the IElementFactory have to use this method to create an edge.

Parameters:

source - the source of the edge

target - the target of the edge

sameDataElementId - the ID of the edge whose data should be copied to the created edge (or null if no data should be copied)

Returns:

the created edge

See Also:

IElementFactory

createNode

public Node createNode(Object sameDataElementId)

All methods of the IElementFactory have to use this method to create a node.

Parameters:

sameDataElementId - the ID of the node whose data should be copied to the created node (or null if no data should be copied)

Returns:

the created node

See Also:

IElementFactory

getEdgeInfo

public IEdgeInfo getEdgeInfo(Edge edge)

Description copied from interface: IElementInfoManager

Returns the edge information object of the given edge.

Specified by:

getEdgeInfo in interface IElementInfoManager

Parameters:

edge - the edge for which the information object should be returned

Returns:

the edge information object of the given edge

getEdgeLabelInfo

public IEdgeLabelInfo getEdgeLabelInfo(IEdgeLabelLayout edgeLabelLayout)

Description copied from interface: IElementInfoManager

Returns the edge label information object of the given edge label layout.

Specified by:

getEdgeLabelInfo in interface IElementInfoManager

Parameters:

edgeLabelLayout - the edge label layout for which the information object should be returned

Returns:

the edge label information object of the given edge label layout

getGraph

public LayoutGraph getGraph()

Gets the relevant graph.

Returns:

the relevant graph

getLayout

public MultiPageLayout getLayout()

Gets the layouter object that belongs to this layout context.

Returns:

the layouter object that belongs to this layout context

getNodeInfo

public INodeInfo getNodeInfo(Node node)

Description copied from interface: IElementInfoManager

Returns the node information object of the given node.

Specified by:

getNodeInfo in interface IElementInfoManager

Parameters:

node - the node for which the information object should be returned

Returns:

the node information object of the given node

getNodeLabelInfo

public INodeLabelInfo getNodeLabelInfo(INodeLabelLayout nodeLabelLayout)

Description copied from interface: IElementInfoManager

Returns the node label layout information object of the given node label layout.

Specified by:

getNodeLabelInfo in interface IElementInfoManager

Parameters:

nodeLabelLayout - the node label layout for which the information object should be returned

Returns:

the node label information object of the given node label layout

getOriginalEdge

public Edge getOriginalEdge(Object id)

Returns the edge of the input graph with the given ID or null if there is no such edge.

Parameters:

id - the ID of the edge that should be returned

Returns:

the edge of the input graph with the given ID or null if there is no such edge

getOriginalNode

public Node getOriginalNode(Object id)

Returns the node of the input graph with the given ID or null if there is no such node.

Parameters:

id - the ID of the node that should be returned

Returns:

the node of the input graph with the given ID or null if there is no such node

getPageEdge

public Edge getPageEdge(Object id)

Returns the edge of a page graph (a graph that represents the result of the multi-page layout) with the given ID or null if there is no such edge.

Parameters:

id - the ID of the edge that should be returned

Returns:

the edge of a page graph with the given ID or null if there is no such edge

getPageNode

public Node getPageNode(Object id)

Returns the node of a page graph (a graph that represents the result of the multi-page layout) with the given ID or null if there is no such node.

Parameters:

id - the ID of the node that should be returned

Returns:

the node of a page graph with the given ID or null if there is no such node

removeEdgeLabel

public boolean removeEdgeLabel(IEdgeLabelLayout label,
                               Edge labeledElement)

Removes a label from a given edge.

Parameters:

label - the label that should be removed

labeledElement - the edge owning the label

removeNodeLabel

public boolean removeNodeLabel(INodeLabelLayout label,
                               Node labeledElement)

Removes a label from a given node.

Parameters:

label - the label that should be removed

labeledElement - the node owning the label