| Package | com.yworks.yfiles.layout |
| Class | public class FixNodeLayoutStage |
| Inheritance | FixNodeLayoutStage  AbstractLayoutStage YObject Object |
| Property | Defined By | ||
|---|---|---|---|
 | coreLayouter : Layouter
Specifies the core layouter. | AbstractLayoutStage | |
| fixPointPolicy : int
Specifies the fix point calculation policy used in calculateFixPoint() to determine which point in the corresponding rectangle should be considered fixed. | FixNodeLayoutStage | ||
| includingEdges : Boolean
Determines whether or not subgraph edges should be taken into account when calculating the bounding box of the fixed nodes. | FixNodeLayoutStage | ||
| includingLabels : Boolean
Determines whether or not label geometries should be taken into account when calculating the bounding box of the fixed nodes. | FixNodeLayoutStage | ||
| Method | Defined By | ||
|---|---|---|---|
FixNodeLayoutStage(init:Boolean = true)
Initializes a new FixNodeLayoutStage. | FixNodeLayoutStage | ||
canLayout(graph:LayoutGraph):Boolean [override] | FixNodeLayoutStage | ||
doLayout(graph:LayoutGraph):void [override] | FixNodeLayoutStage | ||
| equals(o:Object):Boolean | YObject | |
getClass():Class [override] | FixNodeLayoutStage | ||
| hashCode():int | YObject | |
[static]
Initializes a new FixNodeLayoutStage. | FixNodeLayoutStage | ||
[static]
Initializes a new FixNodeLayoutStage. | FixNodeLayoutStage | ||
| Method | Defined By | ||
|---|---|---|---|
Calculates the bounding box of the specified nodes. | FixNodeLayoutStage | ||
Calculates the fix point of the specified rectangle according to the policy returned by fixPointPolicy. | FixNodeLayoutStage | ||
Calculates the fix point for the specified nodes in the specified graph. | FixNodeLayoutStage | ||
| canLayoutCore(graph:LayoutGraph):Boolean
Queries the core layouter whether or not the given graph can be laid out. | AbstractLayoutStage | |
| doLayoutCore(graph:LayoutGraph):void
Invokes the layout routine of the core layouter. | AbstractLayoutStage | |
| initAbstractLayoutStage1():void | AbstractLayoutStage | |
| initAbstractLayoutStage2(core:Layouter):void | AbstractLayoutStage | |
initFixNodeLayoutStage1():void
Initializes this object. | FixNodeLayoutStage | ||
initFixNodeLayoutStage2(core:Layouter):void
Initializes this object. | FixNodeLayoutStage | ||
| Constant | Defined By | ||
|---|---|---|---|
| FIXED_NODE_DPKEY : Object = y.layout.FixNodeLayoutStage.FIXED_NODE_DPKEY [static]
com.yworks.yfiles.base.DataProvider key to specify a DataProvider whose com.yworks.yfiles.base.DataProvider.getBool() method is used to determine which nodes should be considered fixed. | FixNodeLayoutStage | ||
| FIX_POINT_POLICY_CENTER : int = 1 [static]
Fix point calculation policy that results in the center of a given rectangle to be considered the fix point. | FixNodeLayoutStage | ||
| FIX_POINT_POLICY_LOWER_LEFT : int = 5 [static]
Fix point calculation policy that results in the lower left corner of a given rectangle to be considered the fix point. | FixNodeLayoutStage | ||
| FIX_POINT_POLICY_LOWER_RIGHT : int = 4 [static]
Fix point calculation policy that results in the lower right corner of a given rectangle to be considered the fix point. | FixNodeLayoutStage | ||
| FIX_POINT_POLICY_UPPER_LEFT : int = 2 [static]
Fix point calculation policy that results in the upper left corner of a given rectangle to be considered the fix point. | FixNodeLayoutStage | ||
| FIX_POINT_POLICY_UPPER_RIGHT : int = 3 [static]
Fix point calculation policy that results in the upper right corner of a given rectangle to be considered the fix point. | FixNodeLayoutStage | ||
| fixPointPolicy | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesfixPointPolicy:intSpecifies the fix point calculation policy used in calculateFixPoint() to determine which point in the corresponding rectangle should be considered fixed.
By default, FIX_POINT_POLICY_CENTER is used.
public function get fixPointPolicy():int public function set fixPointPolicy(value:int):voidSee also
| includingEdges | property |
includingEdges:BooleanDetermines whether or not subgraph edges should be taken into account when calculating the bounding box of the fixed nodes.
By default, this property is set to false, i.e. subgraph edges are not taken into account.
public function get includingEdges():Boolean public function set includingEdges(value:Boolean):voidSee also
| includingLabels | property |
includingLabels:BooleanDetermines whether or not label geometries should be taken into account when calculating the bounding box of the fixed nodes.
By default, this property is set to false, i.e. label geometries are not taken into account.
public function get includingLabels():Boolean public function set includingLabels(value:Boolean):voidSee also
| FixNodeLayoutStage | () | Constructor |
public function FixNodeLayoutStage(init:Boolean = true)
Initializes a new FixNodeLayoutStage.
init:Boolean (default = true) |
| calculateBounds | () | method |
protected function calculateBounds(graph:LayoutGraph, fixed:NodeList):Rectangle2DCalculates the bounding box of the specified nodes. The return values of methods includingEdges and includingLabels determine whether or not edges and labels are taken into account when calculating the box.
Parameters
graph:LayoutGraph — the graph associated to the specified nodes.
| |
fixed:NodeList — the list of nodes that determine the bounding box.
|
Rectangle2D — the bounding box of the specified nodes.
|
See also
| calculateFixPoint | () | method |
protected function calculateFixPoint(bounds:Rectangle2D):YPoint
Calculates the fix point of the specified rectangle according to the policy returned by fixPointPolicy.
If the specified rectangle is null or the rectangle has negative width or negative height, null will be returned.
Parameters
bounds:Rectangle2D — the rectangle for which to determine the fix point.
|
YPoint — the fix point of the specified rectangle or null if nothing should be fixed.
|
See also
| calculateFixPoint2 | () | method |
protected function calculateFixPoint2(graph:LayoutGraph, fixed:NodeList):YPointCalculates the fix point for the specified nodes in the specified graph. The default implementation calls calculateBounds() and calculateFixPoint().
Parameters
graph:LayoutGraph — the graph associated to the specified nodes.
| |
fixed:NodeList — the list of nodes for which a fix point has to be determined.
|
YPoint — the fix point for the specified nodes in the specified graph.
|
See also
| canLayout | () | method |
override public function canLayout(graph:LayoutGraph):BooleanParameters
graph:LayoutGraph |
Boolean |
| doLayout | () | method |
| getClass | () | method |
override public function getClass():ClassReturnsClass |
| initFixNodeLayoutStage1 | () | method |
protected final function initFixNodeLayoutStage1():void
Initializes this object. See the documentation of the corresponding factory method newFixNodeLayoutStage1() for details.
See also
| initFixNodeLayoutStage2 | () | method |
protected final function initFixNodeLayoutStage2(core:Layouter):void
Initializes this object. See the documentation of the corresponding factory method newFixNodeLayoutStage2() for details.
Parameters
core:Layouter |
See also
| newFixNodeLayoutStage1 | () | method |
public static function newFixNodeLayoutStage1():FixNodeLayoutStage
Initializes a new FixNodeLayoutStage.
FixNodeLayoutStage |
| newFixNodeLayoutStage2 | () | method |
public static function newFixNodeLayoutStage2(core:Layouter):FixNodeLayoutStage
Initializes a new FixNodeLayoutStage.
Parameters
core:Layouter — the core layout algorithm for this stage.
|
FixNodeLayoutStage |
| FIX_POINT_POLICY_CENTER | Constant |
public static const FIX_POINT_POLICY_CENTER:int = 1Fix point calculation policy that results in the center of a given rectangle to be considered the fix point.
See also
| FIX_POINT_POLICY_LOWER_LEFT | Constant |
public static const FIX_POINT_POLICY_LOWER_LEFT:int = 5Fix point calculation policy that results in the lower left corner of a given rectangle to be considered the fix point.
See also
| FIX_POINT_POLICY_LOWER_RIGHT | Constant |
public static const FIX_POINT_POLICY_LOWER_RIGHT:int = 4Fix point calculation policy that results in the lower right corner of a given rectangle to be considered the fix point.
See also
| FIX_POINT_POLICY_UPPER_LEFT | Constant |
public static const FIX_POINT_POLICY_UPPER_LEFT:int = 2Fix point calculation policy that results in the upper left corner of a given rectangle to be considered the fix point.
See also
| FIX_POINT_POLICY_UPPER_RIGHT | Constant |
public static const FIX_POINT_POLICY_UPPER_RIGHT:int = 3Fix point calculation policy that results in the upper right corner of a given rectangle to be considered the fix point.
See also
| FIXED_NODE_DPKEY | Constant |
public static const FIXED_NODE_DPKEY:Object = y.layout.FixNodeLayoutStage.FIXED_NODE_DPKEY
com.yworks.yfiles.base.DataProvider key to specify a DataProvider whose com.yworks.yfiles.base.DataProvider.getBool() method is used to determine which nodes should be considered fixed.
See also