| Package | com.yworks.yfiles.layout.tree |
| Class | public class NodeOrderComparator |
| Inheritance | NodeOrderComparator  YObject Object |
| Implements | Comparator, Comparators_PartialOrder |
See also
| Method | Defined By | ||
|---|---|---|---|
NodeOrderComparator(init:Boolean = true) | NodeOrderComparator | ||
compare(a:Object, b:Object):int
Object is actually expected to be com.yworks.yfiles.base.Edge. | NodeOrderComparator | ||
 | equals(o:Object):Boolean | YObject | |
getClass():Class [override] | NodeOrderComparator | ||
| hashCode():int | YObject | |
[static] | NodeOrderComparator | ||
| Method | Defined By | ||
|---|---|---|---|
initNodeOrderComparator():void | NodeOrderComparator | ||
| Constant | Defined By | ||
|---|---|---|---|
| NODE_ORDER_DPKEY : Object = y.layout.tree.TreeLayouter.NODE_ORDER_DPKEY [static]
A data provider key that can be used to register a com.yworks.yfiles.base.DataProvider for each com.yworks.yfiles.base.Node in the graph that yields a com.yworks.bridge.util.Comparable object via the com.yworks.yfiles.base.DataProvider.getObject() method. | NodeOrderComparator | ||
| NodeOrderComparator | () | Constructor |
Hide Inherited Public Methods
Show Inherited Public Methodspublic function NodeOrderComparator(init:Boolean = true)init:Boolean (default = true) |
| compare | () | method |
public function compare(a:Object, b:Object):int
Object is actually expected to be com.yworks.yfiles.base.Edge.
Compares values returned by com.yworks.yfiles.base.DataProvider.getObject() for the target nodes (com.yworks.yfiles.base.Edge.target()) of the edges. null values or instances that do not implement the com.yworks.bridge.util.Comparable interface will be treated as (equal) smaller values.
Parameters
a:Object | |
b:Object |
int |
See also
| getClass | () | method |
override public function getClass():ClassReturnsClass |
| initNodeOrderComparator | () | method |
protected final function initNodeOrderComparator():void| newNodeOrderComparator | () | method |
| NODE_ORDER_DPKEY | Constant |
public static const NODE_ORDER_DPKEY:Object = y.layout.tree.TreeLayouter.NODE_ORDER_DPKEYA data provider key that can be used to register a com.yworks.yfiles.base.DataProvider for each com.yworks.yfiles.base.Node in the graph that yields a com.yworks.bridge.util.Comparable object via the com.yworks.yfiles.base.DataProvider.getObject() method. The values can be used by the various tree layouter implementations to sort the children of each node in the tree and use the order to influence the layout. To achieve this use this comparator and assign it to the layouter implementations comparator property.
See also