Packagecom.yworks.yfiles.layout.tree
Classpublic class FreePlacer
InheritanceFreePlacer Inheritance AbstractRotatableNodePlacer Inheritance YObject Inheritance Object

Placer that can be used as simple "pseudo"-placer. May be useful if the localRoot does not have any children or you want to place them manually.


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
  
FreePlacer(init:Boolean = true)
Creates a new instance with the default matrix.
FreePlacer
 Inherited
createComparator():Comparator
AbstractRotatableNodePlacer
 Inherited
createFromSketchComparator():Comparator
AbstractRotatableNodePlacer
  
createProcessor(layouter:GenericTreeLayouter, graph:LayoutGraph, currentRoot:Node):Processor
[override] Creates a processor suitable to the FreePlacer. This processor will change all descendants node placers to FreePlacer.
FreePlacer
 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]
FreePlacer
 Inherited
hashCode():int
YObject
  
newFreePlacer():FreePlacer
[static] Creates a new instance with the default matrix.
FreePlacer
 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]
FreePlacer
 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
  
initFreePlacer():void
Initializes this object.
FreePlacer
  
placeSubtreeCore(localRoot:Node, parentConnectorDirection:int):SubtreeShapeRotated
[override] Creates the subtree shape
FreePlacer
 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
FreePlacer()Constructor
public function FreePlacer(init:Boolean = true)

Creates 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
createProcessor()method
override public function createProcessor(layouter:GenericTreeLayouter, graph:LayoutGraph, currentRoot:Node):Processor

Creates a processor suitable to the FreePlacer. This processor will change all descendants node placers to FreePlacer.

Parameters

layouter:GenericTreeLayouter
 
graph:LayoutGraph
 
currentRoot:Node

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

Parameters

child:Node

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

See also

com.yworks.yfiles.layout.tree.NodePlacerCompanion.DIRECTION_NONE
getClass()method 
override public function getClass():Class

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

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

See also

newFreePlacer()
newFreePlacer()method 
public static function newFreePlacer():FreePlacer

Creates a new instance with the default matrix.

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

Creates the subtree shape

Parameters

localRoot:Node
 
parentConnectorDirection:int

Returns
SubtreeShapeRotated — the created subtree shape




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