Packagecom.yworks.yfiles.layout.tree
Classpublic class DoubleLinePlacer
InheritanceDoubleLinePlacer Inheritance AbstractRotatableNodePlacer Inheritance YObject Inheritance Object

The DoubleLinePlacer is a special node placer that places its children in two lines. This node placer is especially useful for leaves with great width.



Public Properties
 PropertyDefined By
  doubleLineSpacingRatio : Number
Specifies the ratio of the spacing (spacing) between the root and the children in the upper line and the spacing between the two lines of subtrees.
DoubleLinePlacer
 InheritedmodificationMatrix : AbstractRotatableNodePlacer_Matrix
[read-only] The actual modification matrix
AbstractRotatableNodePlacer
  rootAlignment : AbstractRotatableNodePlacer_RootAlignment
Specifies the horizontal alignment that is used for the root node.
DoubleLinePlacer
 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
  
DoubleLinePlacer(init:Boolean = true)
Creates a new DoubleLinePlacer with the default modification matrix.
DoubleLinePlacer
 Inherited
AbstractRotatableNodePlacer
 Inherited
AbstractRotatableNodePlacer
 Inherited
Creates an optional Processor for pre- and post-processing.
AbstractRotatableNodePlacer
 Inherited
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.
AbstractRotatableNodePlacer
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
DoubleLinePlacer
 Inherited
hashCode():int
YObject
  
[static] Creates a new DoubleLinePlacer with the default modification matrix.
DoubleLinePlacer
  
[static] Creates a new DoubleLinePlacer with the given modification matrix.
DoubleLinePlacer
 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
[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
  
[override] Returns com.yworks.yfiles.layout.tree.NodePlacerCompanion.DIRECTION_NORTH
DoubleLinePlacer
 Inherited
Lookup method to get the PortConstraint for the local root translated.
AbstractRotatableNodePlacer
 Inherited
Translates the absolute source point of the given edge to the "view coordinates" (translated by the modification matrix)
AbstractRotatableNodePlacer
 Inherited
AbstractRotatableNodePlacer
  
Initializes this object.
DoubleLinePlacer
  
Initializes this object.
DoubleLinePlacer
  
placeSubtreeCore(localRoot:Node, parentConnectorDirection:int):SubtreeShapeRotated
[override] Places the subtree in two lines.
DoubleLinePlacer
 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
Property Detail
doubleLineSpacingRatioproperty
doubleLineSpacingRatio:Number

Specifies the ratio of the spacing (spacing) between the root and the children in the upper line and the spacing between the two lines of subtrees.

By default, the ratio is 0.33 due to backwards compatibility.


Implementation
    public function get doubleLineSpacingRatio():Number
    public function set doubleLineSpacingRatio(value:Number):void

See also

rootAlignmentproperty 
rootAlignment:AbstractRotatableNodePlacer_RootAlignment

Specifies the horizontal alignment that is used for the root node.


Implementation
    public function get rootAlignment():AbstractRotatableNodePlacer_RootAlignment
    public function set rootAlignment(value:AbstractRotatableNodePlacer_RootAlignment):void
Constructor Detail
DoubleLinePlacer()Constructor
public function DoubleLinePlacer(init:Boolean = true)

Creates a new DoubleLinePlacer with the default modification 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
determineChildConnector()method
override protected function determineChildConnector(child:Node):int

Returns com.yworks.yfiles.layout.tree.NodePlacerCompanion.DIRECTION_NORTH

Parameters

child:Node

Returns
intNodePlacer#DIRECTION_NORTH

See also

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

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

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

See also

initDoubleLinePlacer2()method 
protected final function initDoubleLinePlacer2(modificationMatrix:AbstractRotatableNodePlacer_Matrix):void

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

Parameters

modificationMatrix:AbstractRotatableNodePlacer_Matrix

See also

newDoubleLinePlacer1()method 
public static function newDoubleLinePlacer1():DoubleLinePlacer

Creates a new DoubleLinePlacer with the default modification matrix.

Returns
DoubleLinePlacer
newDoubleLinePlacer2()method 
public static function newDoubleLinePlacer2(modificationMatrix:AbstractRotatableNodePlacer_Matrix):DoubleLinePlacer

Creates a new DoubleLinePlacer with the given modification matrix.

Parameters

modificationMatrix:AbstractRotatableNodePlacer_Matrix — the current modification matrix

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

Places the subtree in two lines.

Parameters

localRoot:Node
 
parentConnectorDirection:int

Returns
SubtreeShapeRotated — the subtree