Packagecom.yworks.yfiles.layout.tree
Classpublic class BusPlacer
InheritanceBusPlacer Inheritance AbstractRotatableNodePlacer Inheritance YObject Inheritance Object

The BusPlacer is a special NodePlacer that creates a bus where all child nodes and the root node are connected to. The BusPlacer is rotatable using the constructor 2().

See also

2()

Public Properties
 PropertyDefined By
 InheritedmodificationMatrix : AbstractRotatableNodePlacer_Matrix
[read-only] The actual modification matrix
AbstractRotatableNodePlacer
 Inheritedspacing : Number
Specifies the spacing between subtrees this NodePlacer is arranging.
AbstractRotatableNodePlacer
Protected Properties
 PropertyDefined By
 InheritedcreatedChildren : List
List containing the created children
AbstractRotatableNodePlacer
 Inheritedgraph : LayoutGraph
The graph instance this class is working on
AbstractRotatableNodePlacer
 InheritednodeShapeProvider : DataProvider
The actual node shape provider
AbstractRotatableNodePlacer
 Inherited_spacing : Number
This is the "default" spacing for the different move operations.
AbstractRotatableNodePlacer
 InheritedsubtreeShapeProvider : DataProvider
The actual subtree shape provider
AbstractRotatableNodePlacer
Public Methods
 MethodDefined By
  
BusPlacer(init:Boolean = true)
Initializes a new instance with the Default matrix.
BusPlacer
  
createComparator():Comparator
[override]
BusPlacer
 Inherited
createFromSketchComparator():Comparator
AbstractRotatableNodePlacer
 Inherited
createProcessor(layouter:GenericTreeLayouter, graph:LayoutGraph, currentRoot:Node):Processor
Creates an optional Processor for pre- and post-processing.
AbstractRotatableNodePlacer
  
determineChildConnectors(localRoot:Node, connectorMap:DataMap):void
[override] This method initializes internal data structures, then uses the abstract method determineChildConnector() to determine the child node connector directions.
BusPlacer
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
BusPlacer
 Inherited
hashCode():int
YObject
  
newBusPlacer1():BusPlacer
[static] Initializes a new instance with the Default matrix.
BusPlacer
  
newBusPlacer2(modificationMatrix:AbstractRotatableNodePlacer_Matrix):BusPlacer
[static] Initializes a new BusPlacer with the given modification matrix.
BusPlacer
 Inherited
placeSubtree(nodeShapeProvider:DataProvider, subtreeShapeProvider:DataProvider, graph:LayoutGraph, localRoot:Node, parentConnectorDirection:int):GenericTreeLayouter_SubtreeShape
This method initializes the local data structures and then delegates the work to the abstract variant.
AbstractRotatableNodePlacer
 Inherited
translatePoint(modificationMatrix:AbstractRotatableNodePlacer_Matrix, realWorldPoint:YPoint):YPoint
[static] Translates a "real world point" to a "model point"
AbstractRotatableNodePlacer
Protected Methods
 MethodDefined By
 Inherited
createRootNodeShape(node:Node):SubtreeShapeRotated
Convenience method that queries the DataProvider for the shape of a single node as a SubtreeShape instance.
AbstractRotatableNodePlacer
 Inherited
createSubtreeShape(node:Node):SubtreeShapeRotated
Convenience method that queries the DataProvider for a SubtreeShape.
AbstractRotatableNodePlacer
  
determineChildConnector(child:Node):int
[override]
BusPlacer
 Inherited
getPortConstraint(localRoot:Node):PortConstraint
Lookup method to get the PortConstraint for the local root translated.
AbstractRotatableNodePlacer
 Inherited
getSourcePointAbs(edge:Edge):YPoint
Translates the absolute source point of the given edge to the "view coordinates" (translated by the modification matrix)
AbstractRotatableNodePlacer
 Inherited
initAbstractRotatableNodePlacer(modificationMatrix:AbstractRotatableNodePlacer_Matrix):void
AbstractRotatableNodePlacer
  
initBusPlacer1():void
Initializes this object.
BusPlacer
  
initBusPlacer2(modificationMatrix:AbstractRotatableNodePlacer_Matrix):void
Initializes this object.
BusPlacer
  
placeSubtreeCore(localRoot:Node, parentConnectorDirection:int):SubtreeShapeRotated
[override] Places the root node and its children
BusPlacer
 Inherited
translateDirectionToModel(realDirection:int):int
Translates a "real" direction into a directionModel direction
AbstractRotatableNodePlacer
 Inherited
translateDirectionToReal(modelDirection:int):int
Translates a modelDirectionModel into the "real" directionModel
AbstractRotatableNodePlacer
Constructor Detail
BusPlacer()Constructor
public function BusPlacer(init:Boolean = true)

Initializes a new instance with the Default matrix.

Parameters
init:Boolean (default = true) — An internally used switch to help handle proper instance initialization in inheritance chains where classes can have multiple constructor-like factory methods. This parameter can safely be ignored/omitted when calling the constructor.
Method Detail
createComparator()method
override public function createComparator():Comparator

Returns
Comparator
determineChildConnector()method 
override protected function determineChildConnector(child:Node):int

Parameters

child:Node

Returns
int — com.yworks.yfiles.layout.tree.NodePlacerCompanion.DIRECTION_SOUTH

See also

com.yworks.yfiles.layout.tree.NodePlacerCompanion.DIRECTION_SOUTH
determineChildConnectors()method 
override public function determineChildConnectors(localRoot:Node, connectorMap:DataMap):void

This method initializes internal data structures, then uses the abstract method determineChildConnector() to determine the child node connector directions.

Parameters

localRoot:Node — the local root node
 
connectorMap:DataMap — the map that will be used to store the values

See also

determineChildConnector()
getClass()method 
override public function getClass():Class

Returns
Class
initBusPlacer1()method 
protected final function initBusPlacer1():void

Initializes this object. See the documentation of the corresponding factory method newBusPlacer1() for details.

See also

newBusPlacer1()
initBusPlacer2()method 
protected final function initBusPlacer2(modificationMatrix:AbstractRotatableNodePlacer_Matrix):void

Initializes this object. See the documentation of the corresponding factory method newBusPlacer2() for details.

Parameters

modificationMatrix:AbstractRotatableNodePlacer_Matrix

See also

newBusPlacer2()
newBusPlacer1()method 
public static function newBusPlacer1():BusPlacer

Initializes a new instance with the Default matrix.

Returns
BusPlacer
newBusPlacer2()method 
public static function newBusPlacer2(modificationMatrix:AbstractRotatableNodePlacer_Matrix):BusPlacer

Initializes a new BusPlacer with the given modification matrix.

Parameters

modificationMatrix:AbstractRotatableNodePlacer_Matrix

Returns
BusPlacer
placeSubtreeCore()method 
override protected function placeSubtreeCore(localRoot:Node, parentConnectorDirection:int):SubtreeShapeRotated

Places the root node and its children

Parameters

localRoot:Node
 
parentConnectorDirection:int

Returns
SubtreeShapeRotated — the created subtree shape




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