Packagecom.yworks.yfiles.layout.grouping
Classpublic class GroupNodeHider
InheritanceGroupNodeHider Inheritance AbstractLayoutStage Inheritance YObject Inheritance Object

A layout stage for hierarchically grouped graphs. Activating this stage removes all group nodes and adjacent edges from the graph before passing it on to its core layouter. After the core layouter has arranged the graph, the hidden elements will be reinserted in the graph again.


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.
GroupNodeHider
  hidingEmptyGroupNodes : Boolean
Specifies whether or not group nodes without children will be hidden.
GroupNodeHider
Public Methods
 MethodDefined By
  
GroupNodeHider(init:Boolean = true)
Creates a new instance of GroupNodeHider
GroupNodeHider
  
canLayout(graph:LayoutGraph):Boolean
[override]
GroupNodeHider
  
doLayout(graph:LayoutGraph):void
[override]
GroupNodeHider
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
GroupNodeHider
 Inherited
hashCode():int
YObject
  
hideGroupNodes(graph:LayoutGraph):void
Hides the group nodes and adjacent edges from the graph.
GroupNodeHider
  
newGroupNodeHider1():GroupNodeHider
[static] Creates a new instance of GroupNodeHider
GroupNodeHider
  
newGroupNodeHider2(coreLayouter:Layouter):GroupNodeHider
[static] Creates a new instance of GroupNodeHider.
GroupNodeHider
  
unhideGroupNodes(graph:LayoutGraph):void
Unhides group nodes and adjacent edges from the graph that were previously hidden using method hideGroupNodes().
GroupNodeHider
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
doLayoutCore(graph:LayoutGraph):void
Invokes the layout routine of the core layouter.
AbstractLayoutStage
 Inherited
initAbstractLayoutStage1():void
AbstractLayoutStage
 Inherited
initAbstractLayoutStage2(core:Layouter):void
AbstractLayoutStage
  
initGroupNodeHider1():void
Initializes this object.
GroupNodeHider
  
initGroupNodeHider2(coreLayouter:Layouter):void
Initializes this object.
GroupNodeHider
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
hidingEmptyGroupNodesproperty 
hidingEmptyGroupNodes:Boolean

Specifies whether or not group nodes without children will be hidden. Defaults to true.


Implementation
    public function get hidingEmptyGroupNodes():Boolean
    public function set hidingEmptyGroupNodes(value:Boolean):void
Constructor Detail
GroupNodeHider()Constructor
public function GroupNodeHider(init:Boolean = true)

Creates a new instance of GroupNodeHider

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
hideGroupNodes()method 
public function hideGroupNodes(graph:LayoutGraph):void

Hides the group nodes and adjacent edges from the graph. Furthermore this method removes all grouping related DataProviders from the input graph.

Parameters

graph:LayoutGraph

initGroupNodeHider1()method 
protected final function initGroupNodeHider1():void

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

See also

newGroupNodeHider1()
initGroupNodeHider2()method 
protected final function initGroupNodeHider2(coreLayouter:Layouter):void

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

Parameters

coreLayouter:Layouter

See also

newGroupNodeHider2()
newGroupNodeHider1()method 
public static function newGroupNodeHider1():GroupNodeHider

Creates a new instance of GroupNodeHider

Returns
GroupNodeHider
newGroupNodeHider2()method 
public static function newGroupNodeHider2(coreLayouter:Layouter):GroupNodeHider

Creates a new instance of GroupNodeHider.

Parameters

coreLayouter:Layouter — the core layouter used by this layout stage.

Returns
GroupNodeHider
unhideGroupNodes()method 
public function unhideGroupNodes(graph:LayoutGraph):void

Unhides group nodes and adjacent edges from the graph that were previously hidden using method hideGroupNodes(). Furthermore this method restores all previously removed grouping related DataProviders on the input graph.

Parameters

graph:LayoutGraph

See also

hideGroupNodes()




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