Packagecom.yworks.yfiles.layout.organic
Classpublic class GroupedShuffleLayouter
InheritanceGroupedShuffleLayouter Inheritance AbstractLayoutStage Inheritance YObject Inheritance Object

This class uses a customizable shuffle layout algorithm to recursively remove node overlaps from grouped graph structures. This class can be used as a LayoutStage in which case it will perform its work after the core layouter instance has performed its work.



Public Properties
 PropertyDefined By
 InheritedcoreLayouter : Layouter
Specifies the core layouter.
AbstractLayoutStage
  groupBoundsCalculator : GroupBoundsCalculator
Getter: Returns the currently installed GroupBoundsCalculator instance Setter: Sets the new GroupBoundsCalculator instance.
GroupedShuffleLayouter
  shuffleLayouter : Layouter
Specifies the layouter instance, that will be used for shuffling (removing node overlaps).
GroupedShuffleLayouter
Public Methods
 MethodDefined By
  
GroupedShuffleLayouter(init:Boolean = true)
GroupedShuffleLayouter
  
canLayout(graph:LayoutGraph):Boolean
[override]
GroupedShuffleLayouter
  
doLayout(graph:LayoutGraph):void
[override]
GroupedShuffleLayouter
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
GroupedShuffleLayouter
 Inherited
hashCode():int
YObject
  
[static]
GroupedShuffleLayouter
  
[static] Creates a new instance of GroupedShuffleLayouter The given core layouter instance will get to perform its work before the actual shuffling takes place.
GroupedShuffleLayouter
Protected Methods
 MethodDefined By
 Inherited
canLayoutCore(graph:LayoutGraph):Boolean
Queries the core layouter whether or not the given graph can be laid out.
AbstractLayoutStage
 Inherited
Invokes the layout routine of the core layouter.
AbstractLayoutStage
 Inherited
AbstractLayoutStage
 Inherited
AbstractLayoutStage
  
Initializes this object.
GroupedShuffleLayouter
  
Initializes this object.
GroupedShuffleLayouter
Property Detail
groupBoundsCalculatorproperty
groupBoundsCalculator:GroupBoundsCalculator

Getter: Returns the currently installed GroupBoundsCalculator instance

Setter: Sets the new GroupBoundsCalculator instance.


Implementation
    public function get groupBoundsCalculator():GroupBoundsCalculator
    public function set groupBoundsCalculator(value:GroupBoundsCalculator):void
shuffleLayouterproperty 
shuffleLayouter:Layouter

Specifies the layouter instance, that will be used for shuffling (removing node overlaps).


Implementation
    public function get shuffleLayouter():Layouter
    public function set shuffleLayouter(value:Layouter):void
Constructor Detail
GroupedShuffleLayouter()Constructor
public function GroupedShuffleLayouter(init:Boolean = true)

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
canLayout()method
override public function canLayout(graph:LayoutGraph):Boolean

Parameters

graph:LayoutGraph

Returns
Boolean
doLayout()method 
override public function doLayout(graph:LayoutGraph):void

Parameters

graph:LayoutGraph

getClass()method 
override public function getClass():Class

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

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

See also

initGroupedShuffleLayouter2()method 
protected final function initGroupedShuffleLayouter2(core:Layouter):void

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

Parameters

core:Layouter

See also

newGroupedShuffleLayouter1()method 
public static function newGroupedShuffleLayouter1():GroupedShuffleLayouter

Returns
GroupedShuffleLayouter
newGroupedShuffleLayouter2()method 
public static function newGroupedShuffleLayouter2(core:Layouter):GroupedShuffleLayouter

Creates a new instance of GroupedShuffleLayouter The given core layouter instance will get to perform its work before the actual shuffling takes place.

Parameters

core:Layouter

Returns
GroupedShuffleLayouter