Packageorg.un.flex.graphLayout.layout
Classpublic class HierarchicalLayoutDrawing
InheritanceHierarchicalLayoutDrawing Inheritance BaseLayoutDrawing

This class holds all the parameters needed for a drawing representation of a graph drawing with a Hierarchical Layout according to



Public Properties
 PropertyDefined by
 InheritedcenteredLayout : Boolean
Specifies if the center offset should be applied or not.
BaseLayoutDrawing
 InheritedcenterOffset : Point
Access to the offset of the center of the layout.
BaseLayoutDrawing
 InheritedoriginOffset : Point
Access to the offset of the origin of the layout.
BaseLayoutDrawing
Public Methods
 MethodDefined by
  
The constructor just initializes the internal data structures.
HierarchicalLayoutDrawing
  
addToChange(n:INode, v:Number):void
Adds a value to the change.
HierarchicalLayoutDrawing
  
addToModifier(n:INode, v:Number):void
Adds a value to the modifier
HierarchicalLayoutDrawing
  
addToPrelim(n:INode, v:Number):void
Add a value to the preliminary x value for a node.
HierarchicalLayoutDrawing
  
addToShift(n:INode, v:Number):void
Adds a value to the shift.
HierarchicalLayoutDrawing
 Inherited
Access the absolute cartesian coordinates of the given node.
BaseLayoutDrawing
  
Get the ancestor node for a node, default is the node itself.
HierarchicalLayoutDrawing
  
getChange(n:INode):Number
Get the change value for a node, default is 0.
HierarchicalLayoutDrawing
  
Get the current depth offset of a node.
HierarchicalLayoutDrawing
  
getModifier(n:INode):Number
Get the modifier value for a node, default is 0.
HierarchicalLayoutDrawing
 Inherited
getPolarPhi(n:INode):Number
access the polar angle part of the target coordinates of the given node.
BaseLayoutDrawing
 Inherited
getPolarR(n:INode):Number
access the polar radius part of the target coordinates of the given node.
BaseLayoutDrawing
  
getPrelim(n:INode):Number
Get the preliminary x value for a node.
HierarchicalLayoutDrawing
 Inherited
Access the cartesian coordinates of the given node.
BaseLayoutDrawing
  
getShift(n:INode):Number
Get the shift value for a node, default is 0.
HierarchicalLayoutDrawing
  
Get the thread pointer for a node, default is null.
HierarchicalLayoutDrawing
 Inherited
invalidate all node data sets
BaseLayoutDrawing
 Inherited
nodeDataValid(n:INode):Boolean
indicates if the data set for a given node is currently valid.
BaseLayoutDrawing
  
setAncestor(n:INode, a:INode):void
Set the ancestor for a node.
HierarchicalLayoutDrawing
 Inherited
setCartCoordinates(n:INode, p:Point):void
Set the target coordinates for node n according to the calculated layout in cartesian (i.e.
BaseLayoutDrawing
  
setChange(n:INode, v:Number):void
Set the change value for a node.
HierarchicalLayoutDrawing
  
setDepthOffset(n:INode, v:Number):void
Set the depth offset of a node.
HierarchicalLayoutDrawing
  
setModifier(n:INode, v:Number):void
Set the modifier value for a node.
HierarchicalLayoutDrawing
 Inherited
setPolarCoordinates(n:INode, polarR:Number, polarPhi:Number):void
Set the target coordinates for node n according to the calculated layout in Polar form.
BaseLayoutDrawing
  
setPrelim(n:INode, v:Number):void
Set the preliminary x value for a node.
HierarchicalLayoutDrawing
  
setShift(n:INode, v:Number):void
Set the shift value for a node.
HierarchicalLayoutDrawing
  
setThread(n:INode, t:INode):void
Set the thread pointer for a node.
HierarchicalLayoutDrawing
Constructor detail
HierarchicalLayoutDrawing()constructor
public function HierarchicalLayoutDrawing()

The constructor just initializes the internal data structures.

Method detail
addToChange()method
public function addToChange(n:INode, v:Number):void

Adds a value to the change.

Parameters
n:INode — The node for the change is to be modified ;-)
 
v:Number — The value to add.
addToModifier()method 
public function addToModifier(n:INode, v:Number):void

Adds a value to the modifier

Parameters
n:INode — The node for the modifier is to b modified ;-)
 
v:Number — The value to add.
addToPrelim()method 
public function addToPrelim(n:INode, v:Number):void

Add a value to the preliminary x value for a node.

Parameters
n:INode — The Node for which the value is needed.
 
v:Number — The prelim value for the node n to add.
addToShift()method 
public function addToShift(n:INode, v:Number):void

Adds a value to the shift.

Parameters
n:INode — The node for the shift is to be modified ;-)
 
v:Number — The value to add.
getAncestor()method 
public function getAncestor(n:INode):INode

Get the ancestor node for a node, default is the node itself.

Parameters
n:INode — The Node for which the ancestor is needed.

Returns
INode — The ancestor node.
getChange()method 
public function getChange(n:INode):Number

Get the change value for a node, default is 0.

Parameters
n:INode — The Node for which the change value is needed.

Returns
Number — The change value for the node n.
getDepthOffset()method 
public function getDepthOffset(n:INode):Number

Get the current depth offset of a node. The default is 0.

Parameters
n:INode — The node for which the depth offset it needed.

Returns
Number — The depth offset of the given node (or 0).
getModifier()method 
public function getModifier(n:INode):Number

Get the modifier value for a node, default is 0.

Parameters
n:INode — The Node for which the modifier is needed.

Returns
Number — The modifier value for the node n.
getPrelim()method 
public function getPrelim(n:INode):Number

Get the preliminary x value for a node.

Parameters
n:INode — The Node for which the value is needed.

Returns
Number — The prelim value for the node n.
getShift()method 
public function getShift(n:INode):Number

Get the shift value for a node, default is 0.

Parameters
n:INode — The Node for which the shift value is needed.

Returns
Number — The shift value for the node n.
getThread()method 
public function getThread(n:INode):INode

Get the thread pointer for a node, default is null.

Parameters
n:INode — The Node for which the thread is needed.

Returns
INode — The thread target node.
setAncestor()method 
public function setAncestor(n:INode, a:INode):void

Set the ancestor for a node.

Parameters
n:INode — The Node for which the ancestor is to be set.
 
a:INode — The ancestor node for the node n.
setChange()method 
public function setChange(n:INode, v:Number):void

Set the change value for a node.

Parameters
n:INode — The Node for which the change is to be set.
 
v:Number — The change value for the node n.
setDepthOffset()method 
public function setDepthOffset(n:INode, v:Number):void

Set the depth offset of a node. This results in a variation of the depth of the node within the same layer.

Parameters
n:INode — The node for which to set the offset.
 
v:Number — The offset value.
setModifier()method 
public function setModifier(n:INode, v:Number):void

Set the modifier value for a node.

Parameters
n:INode — The Node for which the modifier is to be set.
 
v:Number — The modifier value for the node n.
setPrelim()method 
public function setPrelim(n:INode, v:Number):void

Set the preliminary x value for a node.

Parameters
n:INode — The Node for which the value is needed.
 
v:Number — The prelim value for the node n.
setShift()method 
public function setShift(n:INode, v:Number):void

Set the shift value for a node.

Parameters
n:INode — The Node for which the shift is to be set.
 
v:Number — The shift value for the node n.
setThread()method 
public function setThread(n:INode, t:INode):void

Set the thread pointer for a node.

Parameters
n:INode — The Node for which the modifier is to be set.
 
t:INode — The thread target node for the node n.