Package | twaver |
Class | public class ShapeLink |
Inheritance | ShapeLink ![]() ![]() ![]() ![]() |
Property | Defined By | ||
---|---|---|---|
![]() | alarmState : AlarmState [read-only]
Get alarm state object of this element. | Element | |
![]() | bundleCount : int [read-only] | Link | |
![]() | bundleIndex : int [read-only] | Link | |
![]() | bundleLinks : BundleLinks [read-only]
Get link bundle information. | Link | |
![]() | 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. | ShapeLink | ||
![]() | fromAgent : Node [read-only]
Get from/start agent. | Link | |
![]() | fromNode : Node
Get the start/from node of this link. | Link | |
![]() | hasChildren : Boolean [read-only]
Check whether this data has children objects. | Data | |
![]() | icon : String
Get icon value for this data. | Data | |
![]() | id : Object [read-only]
Get the ID value of this data. | Data | |
![]() | layerID : Object
Get layer ID of this element. | Element | |
![]() | name : String
Get name of this data. | Data | |
![]() | parent : IData
Get parent data object. | Data | |
points : ICollection
Get all trace points of this shape link with a collection. | ShapeLink | ||
![]() | styleProperties : ICollection [read-only]
Get a ICollection that contians all style proerty name. | Element | |
![]() | toAgent : Node [read-only]
Get end/to agent. | Link | |
![]() | toNode : Node
Get end/to node of this link. | Link | |
![]() | toolTip : String
Get the tooltip text of this data. | Data |
Method | Defined By | ||
---|---|---|---|
Create a shape link by specified ID, from node and to node. | ShapeLink | ||
![]() |
Add a child data object for this data. | Data | |
addPoint(point:Point):void
Add a new trace point for this shape link. | ShapeLink | ||
addPointAt(point:Point, index:int):void
Add a new trace point at specified location for this shape link. | ShapeLink | ||
![]() | addPropertyChangeListener(listener:Function, priority:int = 0, useWeakReference:Boolean = false):void
Add a property change listener to this data to monitoring property
change event. | Data | |
adjustToOrthogonal():void
Call this method to adjust the whole link path/shape in orthogonal style. | ShapeLink | ||
![]() | clearChildren():Boolean
Clear all children from this data. | Data | |
![]() | deserializeXML(serializer:XMLSerializer, xml:XML):void [override]
inheritDoc
| Element | |
dispatchPointsChangeEvent():void
Dispatch trace point changed event to all installed listeners. | ShapeLink | ||
![]() | 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 | |
![]() | hasOwnProperty(name:String):Boolean
Whether this data has specified property. | Data | |
![]() | isAdjustedToBottom():Boolean
Check whether this element has been adjusted to bottom. | Element | |
![]() | isBundleAgent():Boolean | Link | |
![]() | isDescendantOf(data:IData):Boolean
Check whether this data is a descendant of the specified data object. | Data | |
![]() | isLooped():Boolean
Chech whether this link is looped. | Link | |
![]() | 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 | |
removePoint(point:Point):void
Remove a trace point from this shape link. | ShapeLink | ||
removePointAt(index:int):void
Remove trace point as specified location. | ShapeLink | ||
![]() | removePropertyChangeListener(listener:Function):void
Remove the specified property change listener. | Data | |
![]() | resetBundleLinks():void | Link | |
![]() | reverseBundleExpanded():Boolean | Link | |
[override]
| ShapeLink | ||
![]() |
Set client property for this data. | Data | |
setPointAt(point:Point, index:int):void
Update the trace point of specified location with
specified new point. | ShapeLink | ||
![]() | setPropertyValue(property:String, value:Object):void [override]
Set an user defined property on this data. | Element | |
![]() |
Set a style for this element. | Element | |
![]() | toChildren(matchFunction:Function = null):ICollection
Iterate children collection by given callback function. | Data | |
![]() | toString():String [override]
| Data |
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
points | property |
points:ICollection
Get all trace points of this shape link with a collection.
public function get points():ICollection
public function set points(value:ICollection):void
ShapeLink | () | Constructor |
public function ShapeLink(id:Object = null, fromNode:Node = null, toNode:Node = null)
Create a shape link by specified ID, from node and to node.
Parametersid:Object (default = null ) — the element ID.
| |
fromNode:Node (default = null ) — from node of this link.
| |
toNode:Node (default = null ) — to node of this link
|
addPoint | () | method |
public function addPoint(point:Point):void
Add a new trace point for this shape link.
Parameters
point:Point — add a new trace point for this shape link.
|
addPointAt | () | method |
public function addPointAt(point:Point, index:int):void
Add a new trace point at specified location for this shape link. Use this method to insert a new trace point.
Parameters
point:Point — the point need to be added.
| |
index:int — the index location this point will be added.
|
adjustToOrthogonal | () | method |
public function adjustToOrthogonal():void
Call this method to adjust the whole link path/shape in orthogonal style. This will add more trace points to make sure the path looks orthogonal.
dispatchPointsChangeEvent | () | method |
public function dispatchPointsChangeEvent():void
Dispatch trace point changed event to all installed listeners.
removePoint | () | method |
public function removePoint(point:Point):void
Remove a trace point from this shape link.
Parameters
point:Point — the point to be removed.
|
removePointAt | () | method |
public function removePointAt(index:int):void
Remove trace point as specified location.
Parameters
index:int — the trace point that need to be removed.
|
serializeXML | () | method |
override public function serializeXML(serializer:XMLSerializer, newInstance:IData):void
Parameters
serializer:XMLSerializer | |
newInstance:IData |
setPointAt | () | method |
public function setPointAt(point:Point, index:int):void
Update the trace point of specified location with specified new point.
Parameters
point:Point — the new point updated with.
| |
index:int — the trace point location.
|