Packagecom.yworks.yfiles.layout.tree
Classpublic class LeftRightPlacer_LeftRightDataProvider
InheritanceLeftRightPlacer_LeftRightDataProvider Inheritance DataProviderAdapter Inheritance YObject Inheritance Object

Utility class providing a method to determine if a given node is aligned left (true) or right (false) to the parent node.



Public Methods
 MethodDefined By
  
LeftRightPlacer_LeftRightDataProvider(nodePlacerMap:DataProvider, init:Boolean = true)
Constructs a new data provider for the LeftRightPlacer.
LeftRightPlacer_LeftRightDataProvider
 Inherited
defined(dataHolder:Object):Boolean
Returns false for all data holders.
DataProviderAdapter
 Inherited
equals(o:Object):Boolean
YObject
  
getBool(dataHolder:Object):Boolean
[override] Determines if the given node is "left" of its parent node.
LeftRightPlacer_LeftRightDataProvider
  
getClass():Class
[override]
LeftRightPlacer_LeftRightDataProvider
 Inherited
getDouble(dataHolder:Object):Number
Subclasses may override this method to provide access to double values.
DataProviderAdapter
 Inherited
getInt(dataHolder:Object):int
Subclasses may override this method to provide access to integer values.
DataProviderAdapter
 Inherited
getObject(dataHolder:Object):Object
Subclasses may override this method to provide access to object values.
DataProviderAdapter
 Inherited
hashCode():int
YObject
  
[static] Constructs a new data provider for the LeftRightPlacer.
LeftRightPlacer_LeftRightDataProvider
Protected Methods
 MethodDefined By
 Inherited
DataProviderAdapter
  
Initializes this object.
LeftRightPlacer_LeftRightDataProvider
Constructor Detail
LeftRightPlacer_LeftRightDataProvider()Constructor
public function LeftRightPlacer_LeftRightDataProvider(nodePlacerMap:DataProvider, init:Boolean = true)

Constructs a new data provider for the LeftRightPlacer. The nodePlacerMap is a reference to the map where the node placer for each node in the graph is stored. The node placer of a node holds its modification matrix which can be used to determine the alignment of the node to its parent (if its "left").

Parameters
nodePlacerMap:DataProvider
 
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
getBool()method
override public function getBool(dataHolder:Object):Boolean

Determines if the given node is "left" of its parent node. Left is considered as a lower x coordinate when the alignment of the nodes is vertical (north or south) and a lower y coordinate when the alignment of the nodes is horizontal (east or west).

Parameters

dataHolder:Object — a node to check the placement to its parent node.

Returns
Booleantrue if the given node is left of its parent node.
getClass()method 
override public function getClass():Class

Returns
Class
initLeftRightPlacer_LeftRightDataProvider()method 
protected final function initLeftRightPlacer_LeftRightDataProvider(nodePlacerMap:DataProvider):void

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

Parameters

nodePlacerMap:DataProvider

See also

newLeftRightPlacer_LeftRightDataProvider()method 
public static function newLeftRightPlacer_LeftRightDataProvider(nodePlacerMap:DataProvider):LeftRightPlacer_LeftRightDataProvider

Constructs a new data provider for the LeftRightPlacer. The nodePlacerMap is a reference to the map where the node placer for each node in the graph is stored. The node placer of a node holds its modification matrix which can be used to determine the alignment of the node to its parent (if its "left").

Parameters

nodePlacerMap:DataProvider

Returns
LeftRightPlacer_LeftRightDataProvider