Packagecom.yworks.yfiles.layout.grouping
Classpublic class IsolatedGroupComponentLayouter
InheritanceIsolatedGroupComponentLayouter Inheritance ComponentLayouter Inheritance AbstractLayoutStage Inheritance YObject Inheritance Object

A special component layouter that handles hierarchically grouped graphs in a special way. Unlike com.yworks.yfiles.layout.ComponentLayouter this layout stage allows isolated subgraphs within a group to be laid out as a separate component.

The orthogonal group layouter com.yworks.yfiles.layout.orthogonal.OrthogonalGroupLayouter uses this layout stage as component layouter.

See also

com.yworks.yfiles.layout.ComponentLayouter
com.yworks.yfiles.layout.orthogonal.OrthogonalGroupLayouter

Public Properties
 PropertyDefined By
 InheritedcomponentArrangement : Boolean
Specifies whether or not the separately laid out components of the input graph should be arranged by this class.
ComponentLayouter
 InheritedcomponentSpacing : Number
Specifies the current component spacing.
ComponentLayouter
 InheritedconsiderLabels : Boolean
Determines whether or not to take node and edge labels into account when calculating the bounding box of the graph components.
ComponentLayouter
 InheritedcoreLayouter : Layouter
Specifies the core layouter.
AbstractLayoutStage
 InheritedgridSpacing : Number
Specifies the current grid spacing.
ComponentLayouter
 InheritedgroupingActive : Boolean
Getter: Determines whether or not grouping information bound to the graph will be used to calculate the components.
ComponentLayouter
 InheritedpreferredLayoutSize : YDimension
Specifies the preferred layout size for this layouter.
ComponentLayouter
 Inheritedstyle : int
Specifies the component arrangement style used by this ComponentLayouter.
ComponentLayouter
Public Methods
 MethodDefined By
  
IsolatedGroupComponentLayouter(init:Boolean = true)
Create a new instance of IsolatedGroupComponentLayouter.
IsolatedGroupComponentLayouter
  
canLayout(graph:LayoutGraph):Boolean
[override] Returns true, iff the coreLayouter returns true for all components of the graph.
IsolatedGroupComponentLayouter
  
doLayout(graph:LayoutGraph):void
[override]
IsolatedGroupComponentLayouter
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
IsolatedGroupComponentLayouter
 Inherited
hashCode():int
YObject
 Inherited
newComponentLayouter1():ComponentLayouter
[static] Initializes a new ComponentLayouter instance.
ComponentLayouter
 Inherited
newComponentLayouter2(coreLayouter:Layouter):ComponentLayouter
[static] Initializes a new ComponentLayouter instance.
ComponentLayouter
  
newIsolatedGroupComponentLayouter1():IsolatedGroupComponentLayouter
[static] Create a new instance of IsolatedGroupComponentLayouter.
IsolatedGroupComponentLayouter
  
newIsolatedGroupComponentLayouter2(coreLayouter:Layouter):IsolatedGroupComponentLayouter
[static] Create a new instance of IsolatedGroupComponentLayouter.
IsolatedGroupComponentLayouter
 Inherited
setPreferredLayoutSize(width:Number, height:Number):void
Sets the preferred layout size for this layouter.
ComponentLayouter
Protected Methods
 MethodDefined By
 Inherited
arrangeComponents(graph:LayoutGraph, nodes:Vector.<Object>, edges:Vector.<Object>, bbox:Vector.<Object>, boxes:Vector.<Object>):void
Produces a non-overlapping component graph layout.
ComponentLayouter
 Inherited
arrangeFields(graph:LayoutGraph, nodes:Vector.<Object>, edges:Vector.<Object>, bbox:Vector.<Object>, boxes:Vector.<Object>, circular:Boolean, fill:Boolean, fromSketch:Boolean):void
ComponentLayouter
 Inherited
calcBoundingBox(graph:LayoutGraph):Rectangle2D
Calculates and returns the bounding box of a graph component including node halos.
ComponentLayouter
 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
findGraphComponents(graph:LayoutGraph, compNumber:NodeMap):int
Determines which nodes will belong to the same graph component.
ComponentLayouter
  
findIsolatedGraphComponents(graph:LayoutGraph, compNumber:NodeMap):int
Determines which nodes will belong to the same graph component.
IsolatedGroupComponentLayouter
 Inherited
initAbstractLayoutStage1():void
AbstractLayoutStage
 Inherited
initAbstractLayoutStage2(core:Layouter):void
AbstractLayoutStage
 Inherited
initComponentLayouter1():void
Initializes this object.
ComponentLayouter
 Inherited
initComponentLayouter2(coreLayouter:Layouter):void
Initializes this object.
ComponentLayouter
  
initIsolatedGroupComponentLayouter1():void
Initializes this object.
IsolatedGroupComponentLayouter
  
initIsolatedGroupComponentLayouter2(coreLayouter:Layouter):void
Initializes this object.
IsolatedGroupComponentLayouter
 Inherited
setOrigin(graph:LayoutGraph, nl:NodeList, el:EdgeList, org:YPoint, r:YRectangle):void
Sets the origin for a subgraph.
ComponentLayouter
Public Constants
 ConstantDefined By
 InheritedGIVEN_COMPONENT_ID_DPKEY : Object = y.layout.ComponentLayouter.GIVEN_COMPONENT_ID_DPKEY
[static] DataProvider key that can be used to determine components by hand.
ComponentLayouter
 InheritedLAYOUT_NODE_DPKEY : Object = y.layout.ComponentLayouter.LAYOUT_NODE_DPKEY
[static] DataProvider key that can be used to determine which nodes should be laid out.
ComponentLayouter
 InheritedSTYLE_MASK : int = 31
[static] Use this constant for masking actual styles constants from style modifiers.
ComponentLayouter
 InheritedSTYLE_MODIFIER_AS_IS : int = 32
[static] Modifier constant that can be added to normal style constants to indicate that the arrangement strategy should take the initial positions of the components into account.
ComponentLayouter
 InheritedSTYLE_MODIFIER_NO_OVERLAP : int = 64
[static] Modifier constant that can be added to normal style constants to indicate that the arrangement strategy should produce a non-overlapping component layout.
ComponentLayouter
 InheritedSTYLE_MULTI_ROWS : int = 8
[static] Style specification constant describing a component arrangement strategy that places components in multiple rows.
ComponentLayouter
 InheritedSTYLE_MULTI_ROWS_COMPACT : int = 9
[static] Style specification constant describing a component arrangement strategy that places components in multiple rows.
ComponentLayouter
 InheritedSTYLE_MULTI_ROWS_HEIGHT_CONSTRAINED : int = 10
[static] Style specification constant describing a component arrangement strategy.
ComponentLayouter
 InheritedSTYLE_MULTI_ROWS_HEIGHT_CONSTRAINED_COMPACT : int = 11
[static] Style specification constant describing a component arrangement strategy.
ComponentLayouter
 InheritedSTYLE_MULTI_ROWS_WIDTH_CONSTRAINED : int = 12
[static] Style specification constant describing a component arrangement strategy.
ComponentLayouter
 InheritedSTYLE_MULTI_ROWS_WIDTH_CONSTRAINED_COMPACT : int = 13
[static] Style specification constant describing a component arrangement strategy.
ComponentLayouter
 InheritedSTYLE_NONE : int = 0
[static] Style specification constant describing no special component arrangement at all.
ComponentLayouter
 InheritedSTYLE_PACKED_CIRCLE : int = 6
[static] Style specification constant describing a component arrangement strategy that tries to place components like in a cloud around the biggest component.
ComponentLayouter
 InheritedSTYLE_PACKED_COMPACT_CIRCLE : int = 7
[static] Style specification constant describing a component arrangement strategy that tries to place components like in a cloud around the biggest component.
ComponentLayouter
 InheritedSTYLE_PACKED_COMPACT_RECTANGLE : int = 5
[static] Style specification constant describing a component arrangement strategy that tries to place components like in a rectangular cloud around the biggest component.
ComponentLayouter
 InheritedSTYLE_PACKED_RECTANGLE : int = 4
[static] Style specification constant describing a component arrangement strategy that tries to place components like in a rectangular cloud around the biggest component.
ComponentLayouter
 InheritedSTYLE_ROWS : int = 1
[static] Style specification constant describing a component arrangement strategy that tries to place components in multiple rows so that the overall aspect ratio of all components gets as close to the aspect ratio of the preferred layout size as possible.
ComponentLayouter
 InheritedSTYLE_SINGLE_COLUMN : int = 3
[static] Style specification constant describing a component arrangement strategy that places components above each other in a single column.
ComponentLayouter
 InheritedSTYLE_SINGLE_ROW : int = 2
[static] Style specification constant describing a component arrangement strategy that places components next to each other in a single row.
ComponentLayouter
Constructor Detail
IsolatedGroupComponentLayouter()Constructor
public function IsolatedGroupComponentLayouter(init:Boolean = true)

Create a new instance of IsolatedGroupComponentLayouter.

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

Returns true, iff the coreLayouter returns true for all components of the graph.

Parameters

graph:LayoutGraph

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

Parameters

graph:LayoutGraph

findIsolatedGraphComponents()method 
protected function findIsolatedGraphComponents(graph:LayoutGraph, compNumber:NodeMap):int

Determines which nodes will belong to the same graph component. Unlike com.yworks.yfiles.layout.ComponentLayouter this implementation identifies isolated subgraphs within a group also as separate components.

Parameters

graph:LayoutGraph
 
compNumber:NodeMap

Returns
int

See also

com.yworks.yfiles.layout.ComponentLayouter
getClass()method 
override public function getClass():Class

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

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

See also

newIsolatedGroupComponentLayouter1()
initIsolatedGroupComponentLayouter2()method 
protected final function initIsolatedGroupComponentLayouter2(coreLayouter:Layouter):void

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

Parameters

coreLayouter:Layouter

See also

newIsolatedGroupComponentLayouter2()
newIsolatedGroupComponentLayouter1()method 
public static function newIsolatedGroupComponentLayouter1():IsolatedGroupComponentLayouter

Create a new instance of IsolatedGroupComponentLayouter.

Returns
IsolatedGroupComponentLayouter
newIsolatedGroupComponentLayouter2()method 
public static function newIsolatedGroupComponentLayouter2(coreLayouter:Layouter):IsolatedGroupComponentLayouter

Create a new instance of IsolatedGroupComponentLayouter.

Parameters

coreLayouter:Layouter — the core layouter being invoked for each component of the graph.

Returns
IsolatedGroupComponentLayouter




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