Package | twaver |
Class | public class Node |
Inheritance | Node ![]() ![]() ![]() |
Subclasses | Follower, RotatableNode |
var node:Node = new Node(); node.image = "router2Icon"; node.name = "STB"; node.location = new Point(614, 122); //... box.add(node);
Property | Defined By | ||
---|---|---|---|
agentLinks : ICollection [read-only]
Get all agential links of this node. | Node | ||
![]() | alarmState : AlarmState [read-only]
Get alarm state object of this element. | Element | |
centerLocation : Point
Get the location of this node's center point. | Node | ||
![]() | children : ICollection [read-only]
Get all children data objects of this data object. | Data | |
![]() | childrenCount : int [read-only]
Get all children total count for this data. | Data | |
![]() | clientProperties : ICollection [read-only]
Get a ICollection that contians all client proerty name. | Data | |
elementUIClass : Class [override] [read-only]
Get element ui class name. | Node | ||
followers : ICollection [read-only]
Get all followers of this node with a collection. | Node | ||
fromAgentLinks : ICollection [read-only]
Get all agential from/start links of this node with a collection. | Node | ||
fromLinks : ICollection [read-only]
Get all links start from this node. | Node | ||
![]() | hasChildren : Boolean [read-only]
Check whether this data has children objects. | Data | |
height : Number
Get node height value. | Node | ||
![]() | icon : String
Get icon value for this data. | Data | |
![]() | id : Object [read-only]
Get the ID value of this data. | Data | |
image : String
Get image url of this node. | Node | ||
![]() | layerID : Object
Get layer ID of this element. | Element | |
links : ICollection [read-only]
Get all connected links of this node with a collection. | Node | ||
location : Point
Get location of this node. | Node | ||
loopedLinks : ICollection [read-only]
Get all looped links on this node with a collection. | Node | ||
![]() | name : String
Get name of this data. | Data | |
![]() | parent : IData
Get parent data object. | Data | |
rect : Rectangle [read-only]
Get node bounds. | Node | ||
size : Size [read-only]
Get node size. | Node | ||
![]() | styleProperties : ICollection [read-only]
Get a ICollection that contians all style proerty name. | Element | |
toAgentLinks : ICollection [read-only]
Get all agential to/end links of this node with a collection. | Node | ||
toLinks : ICollection [read-only]
Get all to/end links end to this node. | Node | ||
![]() | toolTip : String
Get the tooltip text of this data. | Data | |
width : Number
Get node width. | Node | ||
x : Number [read-only]
Get x location of this node. | Node | ||
y : Number [read-only]
Get y location of this node. | Node |
Method | Defined By | ||
---|---|---|---|
Node(id:Object = null)
Constructor. | Node | ||
![]() |
Add a child data object for this data. | Data | |
![]() | addPropertyChangeListener(listener:Function, priority:int = 0, useWeakReference:Boolean = false):void
Add a property change listener to this data to monitoring property
change event. | Data | |
![]() | clearChildren():Boolean
Clear all children from this data. | Data | |
![]() | deserializeXML(serializer:XMLSerializer, xml:XML):void [override]
inheritDoc
| Element | |
![]() | dispatchPropertyChangeEvent(property:String, oldValue:Object, newValue:Object):Boolean
Dispatch property change event to all installed listeners. | Data | |
![]() | getChildAt(index:int):IData
Get child as specified index location. | Data | |
![]() | getClient(clientProp:String):*
Get specified client property value. | Data | |
![]() | getPropertyValue(property:String):Object [override]
Get an user defined property on this data. | Element | |
![]() | getStyle(styleProp:String, returnDefaultIfNull:Boolean = true):*
Get the specified style property value. | Element | |
hasAgentLinks():Boolean
Check whether this node has agential links. | Node | ||
![]() | hasOwnProperty(name:String):Boolean
Whether this data has specified property. | Data | |
![]() | isAdjustedToBottom():Boolean
Check whether this element has been adjusted to bottom. | Element | |
![]() | isDescendantOf(data:IData):Boolean
Check whether this data is a descendant of the specified data object. | Data | |
![]() | isParentOf(data:IData):Boolean
Check whether this data is the parent of specified data. | Data | |
![]() | isRelatedTo(data:IData):Boolean
Check whether this data has descendant relationship with the specified data. | Data | |
![]() | removeChild(child:IData):Boolean
Remove the specified child object. | Data | |
![]() | removePropertyChangeListener(listener:Function):void
Remove the specified property change listener. | Data | |
[override]
inheritDoc
| Node | ||
setCenterLocation(x:Number, y:Number):void
Set a new location for this node's center point. | Node | ||
![]() |
Set client property for this data. | Data | |
setLocation(x:Number, y:Number):void
Set a new location for this node. | Node | ||
![]() | setPropertyValue(property:String, value:Object):void [override]
Set an user defined property on this data. | Element | |
setSize(width:Number, height:Number):void
Set node size. | Node | ||
![]() |
Set a style for this element. | Element | |
![]() | toChildren(matchFunction:Function = null):ICollection
Iterate children collection by given callback function. | Data | |
![]() | toString():String [override]
| Data | |
translate(dx:Number, dy:Number):void
Translate node location to specified offset. | Node |
Method | Defined By | ||
---|---|---|---|
![]() | deserializeClient(serializer:XMLSerializer, clientXML:XML, clientProp:String):void
Deserialize client property from given XML data. | Data | |
![]() | deserializeProperty(serializer:XMLSerializer, propertyXML:XML, property:String):void [override]
inheritDoc
| Element | |
![]() | deserializeStyle(serializer:XMLSerializer, styleXML:XML, styleProp:String):void
Deserialize style from given XML data. | Element | |
![]() | onChildAdded(child:IData, index:int):void
Called back when a child is added. | Data | |
![]() | onChildRemoved(child:IData, index:int):void
Called back when a child is removed. | Data | |
![]() | onChildrenCleared(children:Array):void
Called back when all children are cleared from this data. | Data | |
![]() | onClientChanged(styleProp:String, oldValue:*, newValue:*):void
Called when client property is changed. | Data | |
[override]
Called back when data parent changed. | Node | ||
onPropertyChanged(property:String, oldValue:Object, newValue:Object):void [override]
Called back when a property of this data is changed. | Node | ||
![]() | onStyleChanged(styleProp:String, oldValue:*, newValue:*):void
Called when style property is changed. | Element | |
![]() |
Serialize given client property into the specified XML serializer. | Data | |
![]() |
Serialize given property into the specified
XML serializer. | Data | |
![]() |
Serialize specified property into XML. | Element |
agentLinks | property |
agentLinks:ICollection
[read-only] Get all agential links of this node.
public function get agentLinks():ICollection
centerLocation | property |
centerLocation:Point
Get the location of this node's center point.
public function get centerLocation():Point
public function set centerLocation(value:Point):void
elementUIClass | property |
elementUIClass:Class
[read-only] [override] Get element ui class name. UI class is used to paint/draw element on network canvas. TWaver Flex will create UI object for the element instance by this returned class name.
public function get elementUIClass():Class
followers | property |
followers:ICollection
[read-only] Get all followers of this node with a collection.
public function get followers():ICollection
fromAgentLinks | property |
fromAgentLinks:ICollection
[read-only] Get all agential from/start links of this node with a collection.
public function get fromAgentLinks():ICollection
fromLinks | property |
fromLinks:ICollection
[read-only] Get all links start from this node.
public function get fromLinks():ICollection
height | property |
height:Number
Get node height value.
public function get height():Number
public function set height(value:Number):void
image | property |
image:String
Get image url of this node. This image will be cached by TWaver and displays on network canvas.
public function get image():String
public function set image(value:String):void
links | property |
links:ICollection
[read-only] Get all connected links of this node with a collection.
public function get links():ICollection
location | property |
location:Point
Get location of this node.
public function get location():Point
public function set location(value:Point):void
loopedLinks | property |
loopedLinks:ICollection
[read-only] Get all looped links on this node with a collection.
public function get loopedLinks():ICollection
rect | property |
rect:Rectangle
[read-only] Get node bounds.
public function get rect():Rectangle
size | property |
toAgentLinks | property |
toAgentLinks:ICollection
[read-only] Get all agential to/end links of this node with a collection.
public function get toAgentLinks():ICollection
toLinks | property |
toLinks:ICollection
[read-only] Get all to/end links end to this node.
public function get toLinks():ICollection
width | property |
width:Number
Get node width.
public function get width():Number
public function set width(value:Number):void
x | property |
x:Number
[read-only] Get x location of this node.
public function get x():Number
y | property |
y:Number
[read-only] Get y location of this node.
public function get y():Number
Node | () | Constructor |
public function Node(id:Object = null)
Constructor.
Parametersid:Object (default = null ) — the node id used to indicate this node instance.
|
hasAgentLinks | () | method |
public function hasAgentLinks():Boolean
Check whether this node has agential links.
ReturnsBoolean — true if has agential links, false otherwise.
|
onParentChanged | () | method |
override protected function onParentChanged(oldParent:IData, newParent:IData):void
Called back when data parent changed. Subclasses could overwrite this method to do something when parent is changed.
Parameters
oldParent:IData — old parent before changed.
| |
newParent:IData — new parent after changed.
|
onPropertyChanged | () | method |
override protected function onPropertyChanged(property:String, oldValue:Object, newValue:Object):void
Called back when a property of this data is changed.
Parameters
property:String — property name changed
| |
oldValue:Object — old value before property change
| |
newValue:Object — new value after property change
|
serializeXML | () | method |
override public function serializeXML(serializer:XMLSerializer, newInstance:IData):void
inheritDoc
Parameters
serializer:XMLSerializer | |
newInstance:IData |
setCenterLocation | () | method |
public function setCenterLocation(x:Number, y:Number):void
Set a new location for this node's center point. Node on network canvas
will be moved to this new location once this location has been changed.
Please note that node location is the center point of this node.
Use setLocation
if you want use the left-top point as
the node location.
Parameters
x:Number — the x value of node center location
| |
y:Number — the y value of node center location
|
setLocation | () | method |
public function setLocation(x:Number, y:Number):void
Set a new location for this node. Node on network canvas
will be moved to this new location once this location has been changed.
Please note that node location is the left-top point of this node.
Use setCenterLocation
if you want use the node center as
the location.
Parameters
x:Number — the x value of location
| |
y:Number — the y value of location
|
setSize | () | method |
public function setSize(width:Number, height:Number):void
Set node size.
Parameters
width:Number — node width
| |
height:Number — node height
|
translate | () | method |
public function translate(dx:Number, dy:Number):void
Translate node location to specified offset. New location would be the old location+offset.
Parameters
dx:Number — location translation offset in x axis.
| |
dy:Number — location translation offset in y axis.
|