| Package | com.yworks.yfiles.layout.hierarchic.incremental |
| Class | public class MultiComponentLayerer |
| Inheritance | MultiComponentLayerer  YObject Object |
| Implements | Layerer |
See also
| Property | Defined By | ||
|---|---|---|---|
| componentComparator : Comparator
Getter:
Returns the current component Comparator or null. | MultiComponentLayerer | ||
| merger : LayeredComponentsMerger
Getter:
Returns the merger. | MultiComponentLayerer | ||
| singleComponentLayerer : Layerer
Getter:
Returns the Layerer instance that is used for delegation. | MultiComponentLayerer | ||
| Method | Defined By | ||
|---|---|---|---|
MultiComponentLayerer(singleComponentLayerer:Layerer, init:Boolean = true)
Creates a new instance of MultiComponentLayerer using the given delegate and a new instance of com.yworks.yfiles.layout.hierarchic.incremental.DefaultLayeredComponentsMerger as the merger and no component comparator. | MultiComponentLayerer | ||
| MultiComponentLayerer | |||
 | equals(o:Object):Boolean | YObject | |
getClass():Class [override] | MultiComponentLayerer | ||
| hashCode():int | YObject | |
[static]
Creates a new instance of MultiComponentLayerer using the given delegate and a new instance of com.yworks.yfiles.layout.hierarchic.incremental.DefaultLayeredComponentsMerger as the merger and no component comparator. | MultiComponentLayerer | ||
newMultiComponentLayerer2(singleComponentLayerer:Layerer, merger:LayeredComponentsMerger, componentComparator:Comparator):MultiComponentLayerer [static]
Creates a new instance of MultiComponentLayerer using the given delegates. | MultiComponentLayerer | ||
| Method | Defined By | ||
|---|---|---|---|
initMultiComponentLayerer1(singleComponentLayerer:Layerer):void
Initializes this object. | MultiComponentLayerer | ||
initMultiComponentLayerer2(singleComponentLayerer:Layerer, merger:LayeredComponentsMerger, componentComparator:Comparator):void
Initializes this object. | MultiComponentLayerer | ||
sort(nodeLists:Vector.<Object>, componentIndexProvider:DataProvider):void
Callback method that is called during assignLayers(). | MultiComponentLayerer | ||
| componentComparator | property |
Hide Inherited Public Methods
Show Inherited Public MethodscomponentComparator:Comparator
Getter:
Returns the current component Comparator or null.
null
public function get componentComparator():Comparator public function set componentComparator(value:Comparator):void| merger | property |
merger:LayeredComponentsMergerGetter: Returns the merger.
Setter: Sets the new merger instance. public function get merger():LayeredComponentsMerger public function set merger(value:LayeredComponentsMerger):voidReferenceError — if the argument is null
|
| singleComponentLayerer | property |
singleComponentLayerer:LayererGetter: Returns the Layerer instance that is used for delegation.
Setter: Sets the new delegate Layerer instance. public function get singleComponentLayerer():Layerer public function set singleComponentLayerer(value:Layerer):voidReferenceError — if the argument is null
|
| MultiComponentLayerer | () | Constructor |
public function MultiComponentLayerer(singleComponentLayerer:Layerer, init:Boolean = true)Creates a new instance of MultiComponentLayerer using the given delegate and a new instance of com.yworks.yfiles.layout.hierarchic.incremental.DefaultLayeredComponentsMerger as the merger and no component comparator.
ParameterssingleComponentLayerer:Layerer | |
init:Boolean (default = true) |
See also
| assignLayers | () | method |
public function assignLayers(graph:LayoutGraph, layers:Layers, ldp:LayoutDataProvider):voidParameters
graph:LayoutGraph | |
layers:Layers | |
ldp:LayoutDataProvider |
| getClass | () | method |
override public function getClass():ClassReturnsClass |
| initMultiComponentLayerer1 | () | method |
protected final function initMultiComponentLayerer1(singleComponentLayerer:Layerer):void
Initializes this object. See the documentation of the corresponding factory method newMultiComponentLayerer1() for details.
Parameters
singleComponentLayerer:Layerer |
See also
| initMultiComponentLayerer2 | () | method |
protected final function initMultiComponentLayerer2(singleComponentLayerer:Layerer, merger:LayeredComponentsMerger, componentComparator:Comparator):void
Initializes this object. See the documentation of the corresponding factory method newMultiComponentLayerer2() for details.
Parameters
singleComponentLayerer:Layerer | |
merger:LayeredComponentsMerger | |
componentComparator:Comparator |
See also
| newMultiComponentLayerer1 | () | method |
public static function newMultiComponentLayerer1(singleComponentLayerer:Layerer):MultiComponentLayererCreates a new instance of MultiComponentLayerer using the given delegate and a new instance of com.yworks.yfiles.layout.hierarchic.incremental.DefaultLayeredComponentsMerger as the merger and no component comparator.
Parameters
singleComponentLayerer:Layerer |
MultiComponentLayerer |
See also
| newMultiComponentLayerer2 | () | method |
public static function newMultiComponentLayerer2(singleComponentLayerer:Layerer, merger:LayeredComponentsMerger, componentComparator:Comparator):MultiComponentLayererCreates a new instance of MultiComponentLayerer using the given delegates.
Parameters
singleComponentLayerer:Layerer | |
merger:LayeredComponentsMerger | |
componentComparator:Comparator |
MultiComponentLayerer |
| sort | () | method |
protected function sort(nodeLists:Vector.<Object>, componentIndexProvider:DataProvider):void
Callback method that is called during assignLayers().
It is responsible for sorting an array consisting of com.yworks.yfiles.base.NodeList s, each containing nodes that belong to a different component. By default this method uses the ComponentComparator (componentComparator) to sort the list or does nothing if that instance is null.
Parameters
nodeLists:Vector.<Object> — the array of NodeLists each containing all nodes that belong to the same component
| |
componentIndexProvider:DataProvider — a DataProvider that can be used to query the nodes' component indices via com.yworks.yfiles.base.DataProvider.getInt() and/or com.yworks.yfiles.base.DataProvider.getObject().
|
See also