Packageorg.un.flex.graphLayout.visual
Interfacepublic interface IVisualNode extends IVisualItem
ImplementorsVisualNode

The visual node interface, this includes lots of access methods for location properties, movement properties. Some of them may become obsolete and may be removed in the future.


Public Properties
 PropertyDefined by
  centered : Boolean
Property to indicate if the node should be centered around it's geometrical center (i.e.
IVisualNode
 Inheriteddata : Object
Access to the items data object.
IVisualItem
 Inheritedid : int
Access to the item's unique id.
IVisualItem
  isVisible : Boolean
Method to specify if the current Visual node is considered to be visible or not.
IVisualNode
  moveable : Boolean
[read-only] This specifies if a node is moveable.
IVisualNode
  node : INode
[read-only] Property for access to the associated graph node of this visual node.
IVisualNode
  orientAngle : Number
A layouter can optionally set an orientation angle paramter in the node.
IVisualNode
  rawview : UIComponent
[read-only] Same as 'view', only exists as a legacy function and will vanish eventually.
IVisualNode
 Inheritedvgraph : IVisualGraph
Access to the associated VisualGraph of this item.
IVisualItem
  view : UIComponent
Access to a visual node's UIComponent (or view).
IVisualNode
  viewX : Number
Convenient access to the X coordinate of a node's view (or UIComponent).
IVisualNode
  viewY : Number
Convenient access to the Y coordinate of a node's view (or UIComponent).
IVisualNode
  x : Number
Access to the target X coordinate of this VisualNode.
IVisualNode
  y : Number
Access to the target Y coordinate of this VisualNode.
IVisualNode
Public Methods
 MethodDefined by
  
commit():void
This method set the coordinates of the visual node's view to the internal coordinates of the visual node, thus effectively placing the view at the point where the visual coordinates point to.
IVisualNode
  
refresh():void
This method updates the internal coordinates of the visual node with the current coordinates of the visual node's view (i.e.
IVisualNode
Property detail
centeredproperty
centered:Boolean  [read-write]

Property to indicate if the node should be centered around it's geometrical center (i.e. the center of it's view) or if it's origin would be the usual upper left corner. The value will be applied by the commit() and refresh() methods.

Implementation
    public function get centered():Boolean
    public function set centered(value:Boolean):void

See also

commit()
refresh()
isVisibleproperty 
isVisible:Boolean  [read-write]

Method to specify if the current Visual node is considered to be visible or not. This is important for most layouters.

Implementation
    public function get isVisible():Boolean
    public function set isVisible(value:Boolean):void
moveableproperty 
moveable:Boolean  [read-only]

This specifies if a node is moveable. This is currently not used by any layouter and thus not effective. Do not use for now!

Implementation
    public function get moveable():Boolean
nodeproperty 
node:INode  [read-only]

Property for access to the associated graph node of this visual node.

Implementation
    public function get node():INode
orientAngleproperty 
orientAngle:Number  [read-write]

A layouter can optionally set an orientation angle paramter in the node. Right now we hardcode this as one single parameter. If we need more in the future, we can replace this by a hash with multiple keys. This parameter may be accessed by the nodeRenderer for instance. The value is in degrees.

Implementation
    public function get orientAngle():Number
    public function set orientAngle(value:Number):void
rawviewproperty 
rawview:UIComponent  [read-only]

Same as 'view', only exists as a legacy function and will vanish eventually.

Implementation
    public function get rawview():UIComponent

See also

view
viewproperty 
view:UIComponent  [read-write]

Access to a visual node's UIComponent (or view).

Implementation
    public function get view():UIComponent
    public function set view(value:UIComponent):void
viewXproperty 
viewX:Number  [read-write]

Convenient access to the X coordinate of a node's view (or UIComponent). This method accesses the view property of this object in, thus creating the view on demand as well.

Implementation
    public function get viewX():Number
    public function set viewX(value:Number):void

See also

view
viewYproperty 
viewY:Number  [read-write]

Convenient access to the Y coordinate of a node's view (or UIComponent). This method accesses the view property of this object in, thus creating the view on demand as well.

Implementation
    public function get viewY():Number
    public function set viewY(value:Number):void

See also

view
xproperty 
x:Number  [read-write]

Access to the target X coordinate of this VisualNode. The commit() method will actually apply these coordinates in the node's UIComponent.

Implementation
    public function get x():Number
    public function set x(value:Number):void

See also

commit()
yproperty 
y:Number  [read-write]

Access to the target Y coordinate of this VisualNode. The commit() method will actually apply these coordinates in the node's UIComponent.

Implementation
    public function get y():Number
    public function set y(value:Number):void

See also

commit()
Method detail
commit()method
public function commit():void

This method set the coordinates of the visual node's view to the internal coordinates of the visual node, thus effectively placing the view at the point where the visual coordinates point to.

refresh()method 
public function refresh():void

This method updates the internal coordinates of the visual node with the current coordinates of the visual node's view (i.e. it's current real coordinates).