Packagecom.yworks.yfiles.layout.multipage
Classpublic class LayoutContext
InheritanceLayoutContext Inheritance YObject Inheritance Object
Implements ElementInfoManager

Class that represents the layout context.


Public Properties
 PropertyDefined By
  graph : LayoutGraph
[read-only] Returns the relevant graph.
LayoutContext
  layouter : MultiPageLayouter
[read-only] Returns the layouter object that belongs to this layout context.
LayoutContext
Public Methods
 MethodDefined By
  
LayoutContext(init:Boolean = true)
LayoutContext
  
addEdgeLabel(label:EdgeLabelLayout, labeledElement:Edge):void
Adds a label to an edge.
LayoutContext
  
addNodeLabel(label:NodeLabelLayout, labeledElement:Node):void
Adds a label to a node.
LayoutContext
  
createEdge(source:Node, target:Node, sameDataElementId:Object):Edge
All methods of the com.yworks.yfiles.layout.multipage.ElementFactory have to use this method to create an edge.
LayoutContext
  
createNode(sameDataElementId:Object):Node
All methods of the com.yworks.yfiles.layout.multipage.ElementFactory have to use this method to create a node.
LayoutContext
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
LayoutContext
  
getEdgeInfo(e:Edge):EdgeInfo
LayoutContext
  
getEdgeLabelInfo(ell:EdgeLabelLayout):EdgeLabelInfo
LayoutContext
  
getNodeInfo(n:Node):NodeInfo
LayoutContext
  
getNodeLabelInfo(nll:NodeLabelLayout):NodeLabelInfo
LayoutContext
  
getOriginalEdge(id:Object):Edge
Returns the edge of the input graph with the given id or null if there is no such edge.
LayoutContext
  
getOriginalNode(id:Object):Node
Returns the node of the input graph with the given id or null if there is no such node.
LayoutContext
  
getPageEdge(id:Object):Edge
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.
LayoutContext
  
getPageNode(id:Object):Node
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.
LayoutContext
 Inherited
hashCode():int
YObject
  
removeEdgeLabel(label:EdgeLabelLayout, labeledElement:Edge):Boolean
Removes a label from an edge.
LayoutContext
  
removeNodeLabel(label:NodeLabelLayout, labeledElement:Node):Boolean
Removes a label from a node.
LayoutContext
Property Detail
graphproperty
graph:LayoutGraph  [read-only]

Returns the relevant graph.


Implementation
    public function get graph():LayoutGraph
layouterproperty 
layouter:MultiPageLayouter  [read-only]

Returns the layouter object that belongs to this layout context.


Implementation
    public function get layouter():MultiPageLayouter
Constructor Detail
LayoutContext()Constructor
public function LayoutContext(init:Boolean = true)



Parameters
init:Boolean (default = true)
Method Detail
addEdgeLabel()method
public function addEdgeLabel(label:EdgeLabelLayout, labeledElement:Edge):void

Adds a label to an edge.

Parameters

label:EdgeLabelLayout — the label that should be added to the edge.
 
labeledElement:Edge — the edge the label should be added to.

addNodeLabel()method 
public function addNodeLabel(label:NodeLabelLayout, labeledElement:Node):void

Adds a label to a node.

Parameters

label:NodeLabelLayout — the label that should be added to the node.
 
labeledElement:Node — the node the label should be added to.

createEdge()method 
public function createEdge(source:Node, target:Node, sameDataElementId:Object):Edge

All methods of the com.yworks.yfiles.layout.multipage.ElementFactory have to use this method to create an edge.

Parameters

source:Node — the source of the edge.
 
target:Node — the target of the edge.
 
sameDataElementId:Object — the id of the edge whose data should be copied to the created edge (or null if no data should be copied).

Returns
Edge — the created edge.

See also

com.yworks.yfiles.layout.multipage.ElementFactory
createNode()method 
public function createNode(sameDataElementId:Object):Node

All methods of the com.yworks.yfiles.layout.multipage.ElementFactory have to use this method to create a node.

Parameters

sameDataElementId:Object — the id of the node whose data should be copied to the created node (or null if no data should be copied).

Returns
Node — the created node.

See also

com.yworks.yfiles.layout.multipage.ElementFactory
getClass()method 
override public function getClass():Class

Returns
Class
getEdgeInfo()method 
public function getEdgeInfo(e:Edge):EdgeInfo

Parameters

e:Edge

Returns
EdgeInfo
getEdgeLabelInfo()method 
public function getEdgeLabelInfo(ell:EdgeLabelLayout):EdgeLabelInfo

Parameters

ell:EdgeLabelLayout

Returns
EdgeLabelInfo
getNodeInfo()method 
public function getNodeInfo(n:Node):NodeInfo

Parameters

n:Node

Returns
NodeInfo
getNodeLabelInfo()method 
public function getNodeLabelInfo(nll:NodeLabelLayout):NodeLabelInfo

Parameters

nll:NodeLabelLayout

Returns
NodeLabelInfo
getOriginalEdge()method 
public function getOriginalEdge(id:Object):Edge

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

Parameters

id:Object — the id of the edge that should be returned.

Returns
Edge — the edge of the input graph with the given id or null if there is no such edge.
getOriginalNode()method 
public function getOriginalNode(id:Object):Node

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

Parameters

id:Object — the id of the node that should be returned.

Returns
Node — the node of the input graph with the given id or null if there is no such node.
getPageEdge()method 
public function getPageEdge(id:Object):Edge

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:Object — the id of the edge that should be returned.

Returns
Edge — the edge of a page graph with the given id or null if there is no such edge.
getPageNode()method 
public function getPageNode(id:Object):Node

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:Object — the id of the node that should be returned.

Returns
Node — the node of a page graph with the given id or null if there is no such node.
removeEdgeLabel()method 
public function removeEdgeLabel(label:EdgeLabelLayout, labeledElement:Edge):Boolean

Removes a label from an edge.

Parameters

label:EdgeLabelLayout — the label that should be removed.
 
labeledElement:Edge — the edge owning the label.

Returns
Boolean
removeNodeLabel()method 
public function removeNodeLabel(label:NodeLabelLayout, labeledElement:Node):Boolean

Removes a label from a node.

Parameters

label:NodeLabelLayout — the label that should be removed.
 
labeledElement:Node — the node owning the label.

Returns
Boolean




Wed Oct 7 2015, 04:43 PM +02:00