| Package | com.yworks.yfiles.layout.tree |
| Class | public class LeftRightPlacer |
| Inheritance | LeftRightPlacer  AbstractRotatableNodePlacer YObject Object |
| Property | Defined By | ||
|---|---|---|---|
| horizontalDistance : Number
Specifies the horizontal distance/spacing between subtree shapes. | LeftRightPlacer | ||
 | modificationMatrix : AbstractRotatableNodePlacer_Matrix [read-only]
The actual modification matrix
| AbstractRotatableNodePlacer | |
| placeLastOnBottom : Boolean
Specifies whether or not the last child is placed at the bottom of the other. | LeftRightPlacer | ||
| spacing : Number [override]
Specifies the spacing between subtrees this NodePlacer is arranging. | LeftRightPlacer | ||
| verticalDistance : Number
Specifies the vertical distance/spacing between subtree shapes. | LeftRightPlacer | ||
| Method | Defined By | ||
|---|---|---|---|
LeftRightPlacer(init:Boolean = true)
Creates a LeftRightPlacer with the default modificationMatrix. | LeftRightPlacer | ||
[override]
Returns a comparator for edges. | LeftRightPlacer | ||
| AbstractRotatableNodePlacer | ||
|
Creates an optional Processor for pre- and post-processing. | AbstractRotatableNodePlacer | |
[override]
Determines the direction the children should place their connectors. | LeftRightPlacer | ||
| equals(o:Object):Boolean | YObject | |
getClass():Class [override] | LeftRightPlacer | ||
| hashCode():int | YObject | |
[static]
Creates a LeftRightPlacer with the default modificationMatrix. | LeftRightPlacer | ||
[static]
Creates a LeftRightPlacer with the given modificationMatrix. | LeftRightPlacer | ||
| 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 | |
| [static]
Translates a "real world point" to a "model point"
| AbstractRotatableNodePlacer | |
| Method | Defined By | ||
|---|---|---|---|
| createRootNodeShape(node:Node):SubtreeShapeRotated
Convenience method that queries the DataProvider for the shape of a single node as a SubtreeShape instance. | AbstractRotatableNodePlacer | |
| createSubtreeShape(node:Node):SubtreeShapeRotated
Convenience method that queries the DataProvider for a SubtreeShape. | AbstractRotatableNodePlacer | |
determineChildConnector(child:Node):int [override]
Throws IllegalStateException, should not be reached. | LeftRightPlacer | ||
|
Lookup method to get the PortConstraint for the local root translated. | AbstractRotatableNodePlacer | |
|
Translates the absolute source point of the given edge to the "view coordinates" (translated by the modification matrix)
| AbstractRotatableNodePlacer | |
| initAbstractRotatableNodePlacer(modificationMatrix:AbstractRotatableNodePlacer_Matrix):void | AbstractRotatableNodePlacer | |
initLeftRightPlacer1():void
Initializes this object. | LeftRightPlacer | ||
initLeftRightPlacer2(modificationMatrix:AbstractRotatableNodePlacer_Matrix):void
Initializes this object. | LeftRightPlacer | ||
placeSubtreeCore(localRoot:Node, parentConnectorDirection:int):SubtreeShapeRotated [override]
Places the shapes of the children on the left and right side of a vertical bus. | LeftRightPlacer | ||
| translateDirectionToModel(realDirection:int):int
Translates a "real" direction into a directionModel direction
| AbstractRotatableNodePlacer | |
| translateDirectionToReal(modelDirection:int):int
Translates a modelDirectionModel into the "real" directionModel
| AbstractRotatableNodePlacer | |
| Constant | Defined By | ||
|---|---|---|---|
| LEFT_RIGHT_DPKEY : Object = y.layout.tree.LeftRightPlacer.LEFT_RIGHT_DPKEY [static]
Key which can be used to register a data provider that tells the node placer whether the node shall be placed on the left or right side. | LeftRightPlacer | ||
| horizontalDistance | property |
Hide Inherited Public Properties
Show Inherited Public PropertieshorizontalDistance:NumberSpecifies the horizontal distance/spacing between subtree shapes.
By default, a value of 20 is used.
public function get horizontalDistance():Number public function set horizontalDistance(value:Number):voidSee also
| placeLastOnBottom | property |
placeLastOnBottom:BooleanSpecifies whether or not the last child is placed at the bottom of the other.
By default, this feature is enabled.
public function get placeLastOnBottom():Boolean public function set placeLastOnBottom(value:Boolean):void| spacing | property |
spacing:Number[override]
Specifies the spacing between subtrees this NodePlacer is arranging.
Calls
public function get spacing():Number public function set spacing(value:Number):voidSee also
| verticalDistance | property |
verticalDistance:NumberSpecifies the vertical distance/spacing between subtree shapes.
By default, a value of 20 is used.
public function get verticalDistance():Number public function set verticalDistance(value:Number):voidSee also
| LeftRightPlacer | () | Constructor |
public function LeftRightPlacer(init:Boolean = true)Creates a LeftRightPlacer with the default modificationMatrix.
Parametersinit:Boolean (default = true) |
| createComparator | () | method |
override public function createComparator():ComparatorReturns a comparator for edges. The comparator applies the modification matrix of the com.yworks.yfiles.layout.tree.LeftRightPlacer and returns
Comparator |
See also
| determineChildConnector | () | method |
override protected function determineChildConnector(child:Node):intThrows IllegalStateException, should not be reached.
Parameters
child:Node |
int |
Error — always.
|
| determineChildConnectors | () | method |
override public function determineChildConnectors(localRoot:Node, connectorMap:DataMap):voidDetermines the direction the children should place their connectors.
Parameters
localRoot:Node | |
connectorMap:DataMap |
| getClass | () | method |
override public function getClass():ClassReturnsClass |
| initLeftRightPlacer1 | () | method |
protected final function initLeftRightPlacer1():void
Initializes this object. See the documentation of the corresponding factory method newLeftRightPlacer1() for details.
See also
| initLeftRightPlacer2 | () | method |
protected final function initLeftRightPlacer2(modificationMatrix:AbstractRotatableNodePlacer_Matrix):void
Initializes this object. See the documentation of the corresponding factory method newLeftRightPlacer2() for details.
Parameters
modificationMatrix:AbstractRotatableNodePlacer_Matrix |
See also
| newLeftRightPlacer1 | () | method |
public static function newLeftRightPlacer1():LeftRightPlacerCreates a LeftRightPlacer with the default modificationMatrix.
ReturnsLeftRightPlacer |
| newLeftRightPlacer2 | () | method |
public static function newLeftRightPlacer2(modificationMatrix:AbstractRotatableNodePlacer_Matrix):LeftRightPlacerCreates a LeftRightPlacer with the given modificationMatrix.
Parameters
modificationMatrix:AbstractRotatableNodePlacer_Matrix |
LeftRightPlacer |
| placeSubtreeCore | () | method |
override protected function placeSubtreeCore(localRoot:Node, parentConnectorDirection:int):SubtreeShapeRotatedPlaces the shapes of the children on the left and right side of a vertical bus.
Parameters
localRoot:Node | |
parentConnectorDirection:int |
SubtreeShapeRotated — the new subtree shape
|
| LEFT_RIGHT_DPKEY | Constant |
public static const LEFT_RIGHT_DPKEY:Object = y.layout.tree.LeftRightPlacer.LEFT_RIGHT_DPKEYKey which can be used to register a data provider that tells the node placer whether the node shall be placed on the left or right side. If no provider is specified, the nodes will be placed alternating from left to right. The provider should return true if the node shall be placed on the left side.