Packagecom.yworks.graph.model
Classpublic class CopiedLayoutIGraph
InheritanceCopiedLayoutIGraph Inheritance CopiedLayoutGraph Inheritance LayoutGraph Inheritance Graph Inheritance YObject Inheritance Object

A CopiedLayoutGraph variant that can be initialized using an IGraph.

Using this class, the various layout algorithms can be used to calculate an automatic layout for an IGraph: 

  // build the adapter copy
  CopiedLayoutIGraph copy = new CopiedLayoutIGraph(graph);
   // perform the layout on the copy - layouter is of type com.yworks.yfiles.layout.Layouter
  layouter.doLayout(copy);
   // apply the results to the original IGraph
  copy.commitLayoutToOriginalGraph();
For more control over the adapting process, see the LayoutGraphAdapter class.

See also

CopiedLayoutGraph
LayoutGraphAdapter

Public Properties
 PropertyDefined By
 InheriteddataProviderKeys : Vector.<Object>
[read-only] Returns an array of all data provider look-up keys that are registered with this graph.
Graph
 InheritededgeList : EdgeList
[read-only] Returns a list, which contains the edges of the graph.
LayoutGraph
 Inheritedempty : Boolean
[read-only] Returns true if this graph contains no nodes.
Graph
 InheritedgraphCopyFactory : GraphCopier_CopyFactory
Specifies the copy factory that is associated with this instance.
Graph
 InheritedgraphListeners : Iterator
[read-only] Returns an iterator that grants access to all registered graph listeners.
Graph
 InheritedlayoutForOriginalGraph : GraphLayout
[read-only] Returns the GraphLayout that is valid for the original graph.
CopiedLayoutGraph
 InheritedoriginalGraph : GraphInterface
[read-only] Returns the original graph
CopiedLayoutGraph
 InheritedoriginalLayout : GraphLayout
[read-only] Returns the original layout
CopiedLayoutGraph
 InheritedregisteredEdgeMaps : Vector.<Object>
[read-only] Returns all edge maps that have been created by this graph but have not yet been disposed.
Graph
 InheritedregisteredNodeMaps : Vector.<Object>
[read-only] Returns all node maps that have been created by this graph but have not yet been disposed.
Graph
  selectionModel : ISelectionModel
Get or set the selection model to use for the LayoutConstants.SELECTED_NODES and LayoutConstants.SELECTED_EDGES data provider implementations that are automatically bound to this instance.
CopiedLayoutIGraph
Public Methods
 MethodDefined By
  
CopiedLayoutIGraph(graph:LayoutGraphAdapter)
Create a new instance using the given graph.
CopiedLayoutIGraph
 Inherited
addDataProvider(providerKey:Object, data:DataProvider):void
Registers the given data provider using the given look-up key.
Graph
 Inherited
addGraphListener(listener:GraphListener):void
Registers the given graph listener with this graph.
Graph
  
applyLayout(graph:IGraph, layouter:Layouter):void
[static] Static convenience method that applies a layout algorithm to an IGraph.
CopiedLayoutIGraph
 Inherited
changeEdgeTo(e:Edge, e1:Edge, e2:Edge, d1:int, d2:int):void
Redefines an edge's end points and fires corresponding notification events to inform registered listeners.
Graph
 Inherited
clear():void
Removes all nodes and edges from this graph and fires corresponding notification events to inform registered listeners.
Graph
  
commitLayoutToOriginalGraph():void
[override] Overrides the base method to temporarily turn off IGroupedGraph.AutoAdjustGroupNodeBounds so that the group node bounds don't get messed up.
CopiedLayoutIGraph
 Inherited
containsEdge(e:Edge):Boolean
Whether or not this graph contains the given edge.
Graph
 Inherited
containsEdgeBetweenNodes(source:Node, target:Node):Boolean
Returns whether or not this graph contains an edge that connects the given nodes.
Graph
 Inherited
containsNode(v:Node):Boolean
Whether or not this graph contains the given node.
Graph
 Inherited
createCopy():Graph
Creates a copy of this graph.
Graph
 Inherited
createEdge(v:Node, w:Node):Edge
Creates a new edge in this graph and fires a corresponding notification event to inform registered listeners.
Graph
 Inherited
createEdgeAt(v:Node, e1:Edge, w:Node, e2:Edge, d1:int, d2:int):Edge
Creates a new edge in this graph to be ordered before or after a given edge and fires a corresponding notification event to inform registered listeners.
Graph
 Inherited
createEdgeCopy(origEdge:Object):Edge
Creates an copied edge.
CopiedLayoutGraph
 Inherited
createEdgeMap():EdgeMap
Returns a newly created edge map that is valid for the edges in this graph.
Graph
 Inherited
createGraph():Graph
Creates an empty base object of the same type as this graph.
Graph
 Inherited
createNode():Node
Creates a new node in this graph and fires a corresponding notification event to inform registered listeners.
Graph
 Inherited
createNodeCopy(origNode:Object):Node
Creates a copy of the given original node.
CopiedLayoutGraph
 Inherited
createNodeMap():NodeMap
Returns a newly created node map that is valid for the nodes in this graph.
Graph
 Inherited
disposeEdgeMap(map:EdgeMap):void
Informs the graph that the given edge map is no longer needed.
Graph
 Inherited
disposeNodeMap(map:NodeMap):void
Informs the graph that the given node map is no longer needed.
Graph
 Inherited
E():int
Returns the number of edges in this graph.
Graph
 Inherited
edgeCount():int
Returns the number of edges in this graph.
Graph
 Inherited
edgeObjects():Iterator
Returns an iterator that provides access to all edges residing in this graph.
Graph
 Inherited
edges():EdgeCursor
Provides access to the edges of the graph.
Graph
 Inherited
equals(o:Object):Boolean
YObject
 Inherited
firePostEvent():void
Propagates a so-called POST event to all registered graph listeners.
Graph
 Inherited
firePostEventWithId(id:Object):void
Like firePostEvent().
Graph
 Inherited
firePreEvent():void
Propagates a so-called PRE event to all registered graph listeners.
Graph
 Inherited
firePreEventWithId(id:Object):void
Like firePreEvent().
Graph
 Inherited
firstEdge():Edge
Returns the first edge in this graph.
Graph
 Inherited
firstNode():Node
Returns the first node in this graph.
Graph
 Inherited
getBoundingBox():Rectangle
Returns the bounding box of the diagram.
LayoutGraph
 Inherited
getCenter(node:Node):YPoint
Returns the position of a node in a drawing.
LayoutGraph
 Inherited
getCenterX(v:Node):Number
Returns the center x-coordinate of the given node.
LayoutGraph
 Inherited
getCenterY(v:Node):Number
Returns the center y-coordinate of the given node.
LayoutGraph
 Inherited
getClass():Class
[override]
CopiedLayoutGraph
 Inherited
getCopiedEdge(e:Object):Edge
Returns the copied edge that corresponds to the given original edge.
CopiedLayoutGraph
 Inherited
getCopiedNode(v:Object):Node
Returns the copied node that corresponds to the given original node.
CopiedLayoutGraph
 Inherited
getDataProvider(providerKey:Object):DataProvider
Returns the data provider that is registered with the graph using the given look-up key.
Graph
 Inherited
getEdgeArray():Vector.<Object>
Returns an array containing all edges of this graph.
Graph
 Inherited
getEdgeFeature(labelLayout:EdgeLabelLayout):Edge
[override] Returns the edge which is described by a given label layout.
CopiedLayoutGraph
 Inherited
getEdgeLabelLayout(edge:Object):Vector.<Object>
Returns EdgeLabelLayout objects which describe the layouts of the labels that belong to the given edge.
LayoutGraph
 Inherited
getEdgeLabelLayoutForEdge(e:Edge):Vector.<Object>
[override] Returns EdgeLabelLayout objects which describe the layouts of the labels that belong to the given edge.
CopiedLayoutGraph
 Inherited
getEdgeLayout(edge:Object):EdgeLayout
Returns the layout information for an edge in the drawing.
LayoutGraph
 Inherited
getEdgeLayoutForEdge(e:Edge):EdgeLayout
[override] Returns the layout information for an edge in the drawing.
CopiedLayoutGraph
 Inherited
getHeight(v:Node):Number
Returns the height of the given node
LayoutGraph
 Inherited
getLocation(node:Node):YPoint
Returns the position of the node in a drawing.
LayoutGraph
 Inherited
getNodeArray():Vector.<Object>
Returns an array containing all nodes of this graph.
Graph
 Inherited
getNodeFeature(labelLayout:NodeLabelLayout):Node
[override] Returns the node which is described by a given label layout.
CopiedLayoutGraph
 Inherited
getNodeLabelLayout(node:Object):Vector.<Object>
Returns NodeLabelLayout objects which describe the layouts of the labels that belong to the given node.
LayoutGraph
 Inherited
getNodeLabelLayoutForNode(v:Node):Vector.<Object>
[override] Returns NodeLabelLayout objects which describe the layouts of the labels that belong to the given node.
CopiedLayoutGraph
 Inherited
getNodeLayout(node:Object):NodeLayout
Returns the layout information for a node in the drawing.
LayoutGraph
 Inherited
getNodeLayoutForNode(v:Node):NodeLayout
[override] Returns the layout information for a node in the drawing.
CopiedLayoutGraph
 Inherited
getOriginalEdge(e:Edge):Object
Returns the original edge that corresponds to the given edge.
CopiedLayoutGraph
 Inherited
getOriginalNode(v:Node):Object
Returns the original node that corresponds to the given node.
CopiedLayoutGraph
 Inherited
getPath(edge:Edge):YPointPath
Returns the path of an edge.
LayoutGraph
 Inherited
getPathList(edge:Edge):YList
Returns the path of an edge.
LayoutGraph
 Inherited
getPointList(edge:Edge):YList
Returns the control points of an edge.
LayoutGraph
 Inherited
getPoints(edge:Edge):YPointPath
Returns the control points of an edge.
LayoutGraph
 Inherited
getRectangle(node:Node):YRectangle
Returns the bounding box of a node.
LayoutGraph
 Inherited
getSize(node:Node):YDimension
Returns the size of the node in a drawing.
LayoutGraph
 Inherited
getSource(edge:Object):Object
Returns the source node associated with the given edge.
Graph
 Inherited
getSourcePointAbs(edge:Edge):YPoint
Returns the coordinates of the source end point of an edge in absolute coordinates.
LayoutGraph
 Inherited
getSourcePointRel(edge:Edge):YPoint
Returns the coordinates of the source end point of an edge in relative coordinates to the center of the source node.
LayoutGraph
 Inherited
getTarget(edge:Object):Object
Returns the target node associated with the given edge.
Graph
 Inherited
getTargetPointAbs(edge:Edge):YPoint
Returns the coordinates of the target end point of an edge in absolute coordinates.
LayoutGraph
 Inherited
getTargetPointRel(edge:Edge):YPoint
Returns the coordinates of the target end point of an edge in relative coordinates to the center of the target node.
LayoutGraph
 Inherited
getWidth(v:Node):Number
Returns the width of the given node.
LayoutGraph
 Inherited
getX(v:Node):Number
Returns the upper left x-coordinate of the given node.
LayoutGraph
 Inherited
getY(v:Node):Number
Returns the upper left y-coordinate of the given node.
LayoutGraph
 Inherited
hashCode():int
YObject
 Inherited
hideEdge(e:Edge):void
Hides the given edge from this graph.
Graph
 Inherited
hideNode(v:Node):void
Hides the given node from this graph.
Graph
 Inherited
lastEdge():Edge
Returns the last edge in this graph.
Graph
 Inherited
lastNode():Node
Returns the last node in this graph.
Graph
 Inherited
moveBy(node:Node, dx:Number, dy:Number):void
Moves the location of a node by a given vector
LayoutGraph
 Inherited
moveEdge(e:Edge, newSource:Node, newTarget:Node):void
Redefines an edge's end points and fires corresponding notification events to inform registered listeners.
Graph
 Inherited
moveEdgeTo(e:Edge, newSource:Node, sourceReference:Edge, sourceD:int, newTarget:Node, targetReference:Edge, targetD:int):void
Redefines an edge's end points and fires corresponding notification events to inform registered listeners.
Graph
 Inherited
moveEdgeToFirst(e:Edge):void
Moves the given edge to the first position within the sequence of edges in this graph.
Graph
 Inherited
moveEdgeToLast(e:Edge):void
Moves the given edge to the last position within the sequence of edges in this graph.
Graph
 Inherited
moveNodeToFirst(v:Node):void
Moves the given node to the first position within the sequence of nodes in this graph.
Graph
 Inherited
moveNodeToLast(v:Node):void
Moves the given node to the last position within the sequence of nodes in this graph.
Graph
 Inherited
moveSubGraph(subNodes:NodeList, targetGraph:Graph):EdgeList
Moves an induced subgraph to another graph.
Graph
 Inherited
N():int
Returns the number of nodes in this graph.
Graph
 Inherited
newCopiedLayoutGraph1(graph:LayoutGraph):CopiedLayoutGraph
[static] Initializes this graph as a copy of the given graph
CopiedLayoutGraph
 Inherited
newCopiedLayoutGraph2(graph:GraphInterface, layout:GraphLayout):CopiedLayoutGraph
[static] Initializes this graph as a copy of the given graph interface and graph layout.
CopiedLayoutGraph
  
newCopiedLayoutIGraph(graph:IGraph):CopiedLayoutIGraph
[static]
CopiedLayoutIGraph
 Inherited
newGraph1():Graph
[static] Instantiates an empty Graph object.
Graph
 Inherited
newGraph2(argGraph:Graph):Graph
[static] Instantiates a new Graph object as a copy of the given graph.
Graph
 Inherited
newGraph3(graph:Graph, subNodes:YCursor):Graph
[static] Instantiates a new Graph object as a partial copy of the given graph.
Graph
 Inherited
nodeCount():int
Returns the number of nodes in this graph.
Graph
 Inherited
nodeObjects():Iterator
Returns an iterator that provides access to all nodes residing in this graph.
Graph
 Inherited
nodes():NodeCursor
Provides access to the nodes of the graph.
Graph
 Inherited
printNodeSlotSize():void
For internal debugging purposes only.
Graph
 Inherited
reInsertEdge(e:Edge):void
Reinserts a formerly removed edge into this graph and fires a corresponding notification event to inform registered listeners.
Graph
 Inherited
reInsertNode(v:Node):void
Reinserts a formerly removed node into this graph and fires a corresponding notification event to inform registered listeners.
Graph
 Inherited
removeDataProvider(providerKey:Object):void
Removes the data provider that is registered using the given look-up key.
Graph
 Inherited
removeEdge(e:Edge):void
Removes the given edge from this graph and fires a corresponding notification event to inform registered listeners.
Graph
 Inherited
removeGraphListener(listener:GraphListener):void
Removes the given graph listener from this graph.
Graph
 Inherited
removeNode(v:Node):void
Removes the given node from this graph.
Graph
 Inherited
reverseEdge(e:Edge):void
Reverses the given edge and fires corresponding notification events to inform registered listeners.
Graph
 Inherited
setCenter(v:Node, x:Number, y:Number):void
Sets the center coordinates of the given node.
LayoutGraph
 Inherited
setCenter2(node:Node, position:YPoint):void
Sets the position of a node in a drawing.
LayoutGraph
 Inherited
setEndPointsAbs(edge:Edge, source:YPoint, target:YPoint):void
Set the two end points of an edge in absolute coordinates.
LayoutGraph
 Inherited
setLocation(v:Node, x:Number, y:Number):void
Sets the upper left coordinates of the given node.
LayoutGraph
 Inherited
setLocationToPoint(node:Node, position:YPoint):void
Set the position of the node in a drawing.
LayoutGraph
 Inherited
setPath(edge:Edge, path:YList):void
Sets the path of an edge.
LayoutGraph
 Inherited
setPath2(edge:Edge, path:YPointPath):void
Sets the path of an edge.
LayoutGraph
 Inherited
setPoints(edge:Edge, points:YPointPath):void
Sets the control points of an edge.
LayoutGraph
 Inherited
setPointsFromList(edge:Edge, points:YList):void
Sets the control points of an edge.
LayoutGraph
 Inherited
setSize(v:Node, w:Number, h:Number):void
Sets the size of the given node.
LayoutGraph
 Inherited
setSize2(node:Node, size:YDimension):void
Set the size of the node in a drawing.
LayoutGraph
 Inherited
setSourcePointAbs(edge:Edge, point:YPoint):void
Sets the coordinates of the source end point of an edge in absolute coordinates.
LayoutGraph
 Inherited
setSourcePointRel(edge:Edge, point:YPoint):void
Sets the coordinates of the source end point of an edge in relative coordinates to the center of the source node.
LayoutGraph
 Inherited
setTargetPointAbs(edge:Edge, point:YPoint):void
Sets the coordinates of the target end point of an edge in absolute coordinates.
LayoutGraph
 Inherited
setTargetPointRel(edge:Edge, point:YPoint):void
Sets the coordinates of the target end point of an edge in relative coordinates to the center of the target node.
LayoutGraph
 Inherited
sortEdges(inComp:Comparator, outComp:Comparator):void
Sorts incoming and outgoing edges at each node of the graph.
Graph
 Inherited
sortEdges2(comp:Comparator):void
Sorts the internally held list of edges.
Graph
 Inherited
sortNodes(comp:Comparator):void
Sorts the internally held list of nodes.
Graph
 Inherited
syncStructure():void
Synchronizes the structure of the CopiedLayoutGraph with the actual structure of the underlying LayoutGraph.
CopiedLayoutGraph
 Inherited
toString():String
Returns a String representation of this graph.
Graph
 Inherited
unhideEdge(e:Edge):void
Unhides the given edge in this graph.
Graph
 Inherited
unhideNode(v:Node):void
Unhides the given node in this graph.
Graph
Protected Methods
 MethodDefined By
 Inherited
createGraphCopyFactory():GraphCopier_CopyFactory
[override] Creates a factory that delegates to the createNodeCopy() and createEdgeCopy() methods of this instance.
CopiedLayoutGraph
 Inherited
createLabelFactory():LabelLayoutFactory
[override] Creates a new label layout factory for this graph.
CopiedLayoutGraph
 Inherited
fireGraphEvent(e:GraphEvent):void
Propagates the given graph event to all registered graph listeners.
Graph
 Inherited
firstOutEdge(v:Node):Edge
[static] Low-level iteration support for adjacent edges.
Graph
 Inherited
hasListeners():Boolean
Determines whether there are listeners registered with this instance.
Graph
 Inherited
initCopiedLayoutGraph1(graph:LayoutGraph):void
Initializes this object.
CopiedLayoutGraph
 Inherited
initCopiedLayoutGraph2(graph:GraphInterface, layout:GraphLayout):void
Initializes this object.
CopiedLayoutGraph
 Inherited
initGraph1():void
Initializes this object.
Graph
 Inherited
initGraph2(argGraph:Graph):void
Initializes this object.
Graph
 Inherited
initGraph3(graph:Graph, subNodes:YCursor):void
Initializes this object.
Graph
 Inherited
initLayoutGraph1():void
LayoutGraph
 Inherited
initLayoutGraph2(argGraph:LayoutGraph):void
LayoutGraph
 Inherited
initLayoutGraph3(graph:LayoutGraph, nodeSubset:YCursor):void
LayoutGraph
Public Constants
 ConstantDefined By
 InheritedAFTER : int = 0
[static] Object insertion specifier.
Graph
 InheritedBEFORE : int = 1
[static] Object insertion specifier.
Graph
Property Detail
selectionModelproperty
selectionModel:ISelectionModel

Get or set the selection model to use for the LayoutConstants.SELECTED_NODES and LayoutConstants.SELECTED_EDGES data provider implementations that are automatically bound to this instance.


Implementation
    public function get selectionModel():ISelectionModel
    public function set selectionModel(value:ISelectionModel):void

See also

LayoutConstants
Constructor Detail
CopiedLayoutIGraph()Constructor
public function CopiedLayoutIGraph(graph:LayoutGraphAdapter)

Create a new instance using the given graph.

Parameters
graph:LayoutGraphAdapter — The graph to initialize this instance from.
Method Detail
applyLayout()method
public static function applyLayout(graph:IGraph, layouter:Layouter):void

Static convenience method that applies a layout algorithm to an IGraph.

Parameters

graph:IGraph — The graph to compute the layout on.
 
layouter:Layouter — The layout algorithm to apply.

See also

Layouter
commitLayoutToOriginalGraph()method 
override public function commitLayoutToOriginalGraph():void

Overrides the base method to temporarily turn off IGroupedGraph.AutoAdjustGroupNodeBounds so that the group node bounds don't get messed up.

newCopiedLayoutIGraph()method 
public static function newCopiedLayoutIGraph(graph:IGraph):CopiedLayoutIGraph

Parameters

graph:IGraph

Returns
CopiedLayoutIGraph




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