Packagetwaver
Interfacepublic interface IElement extends IData, IStyle, flash.events.IEventDispatcher, IClient
Implementors Element

This class defines the special data that works with ElementBox. Element is a special data works with element box and used to drive network component. Element is the very top level defination for all managed objects defined in TWaver Flex. It extends from Data and carries more telecom business information, such as network layer, alarm information etc. Node, Link, Group, SubNetwork and other often used objects are all subclasses of this element interface.

Each element can carry a layer id to indicate it's layer on network. All elements with the same layer id value are organized in one layer. Each element can carry an alarm state object to contain all alarm information. Each element should provides an UI class name to tell TWaver Flex which UI class should be used to draw this element on network.

See also

twaver.ElementBox
twaver.AlarmState
twaver.LayerBox


Public Properties
 PropertyDefined By
  alarmState : AlarmState
[read-only] Get alarm state object of this element.
IElement
 Inheritedchildren : ICollection
[read-only] Get all children data as a collection.
IData
 InheritedchildrenCount : int
[read-only] Get total children count.
IData
 InheritedclientProperties : ICollection
[read-only] Get a ICollection that contians all client proerty name.
IClient
  elementUIClass : Class
[read-only] Get UI class name for this element.
IElement
 InheritedhasChildren : Boolean
[read-only] Check whether this data has children data.
IData
 Inheritedicon : String
The small icon of this data.
IData
 Inheritedid : Object
[read-only] The ID of this data.
IData
  layerID : Object
Get layer id of this element.
IElement
 Inheritedname : String
Get the name of this data.
IData
 Inheritedparent : IData
Get parent data.
IData
 InheritedstyleProperties : ICollection
[read-only] Get a ICollection that contians all style proerty name.
IStyle
 InheritedtoolTip : String
Get tooltip of this data.
IData
Public Methods
 MethodDefined By
 Inherited
addChild(child:IData, index:int = 0):Boolean
Add the specified data as a child of current data at the specified children index location.
IData
 Inherited
addPropertyChangeListener(listener:Function, priority:int = 0, useWeakReference:Boolean = false):void
Add a property change listener on this data so it can be notified on any property changed.
IData
 Inherited
clearChildren():Boolean
Clear all children objects from this data.
IData
 Inherited
deserializeXML(serializer:XMLSerializer, dataXML:XML):void
Deserialize data from specified XML data.
IData
 Inherited
dispatchPropertyChangeEvent(property:String, oldValue:Object, newValue:Object):Boolean
Dispatch property change event.
IData
 Inherited
getChildAt(index:int):IData
Get child data from specified children location.
IData
 Inherited
getClient(clientProp:String):*
Get the specified client property.
IClient
 Inherited
getPropertyValue(property:String):Object
Get an user defined property on this data.
IData
 Inherited
getStyle(styleProp:String, returnDefaultIfNull:Boolean = true):*
Get the style property value.
IStyle
 Inherited
hasOwnProperty(name:String):Boolean
Whether current data has created specified property.
IData
  
Check whether this element has been adjusted to the bottom.
IElement
 Inherited
isDescendantOf(data:IData):Boolean
Check whether this data is a descendant of the specified data.
IData
 Inherited
isParentOf(data:IData):Boolean
Check whether this data is the parent of specified data.
IData
 Inherited
isRelatedTo(data:IData):Boolean
Check whether this data and the specified data has any relationship of descendant.
IData
 Inherited
removeChild(child:IData):Boolean
Remove the specified child data from children of current data.
IData
 Inherited
removePropertyChangeListener(listener:Function):void
Remove the specified property change listener from this data.
IData
 Inherited
serializeXML(serializer:XMLSerializer, newInstance:IData):void
Serialize this data into XML.
IData
 Inherited
setClient(clientProp:String, newValue:*):IClient
Set a client property by specified property name and property value.
IClient
 Inherited
setPropertyValue(property:String, value:Object):void
Set an user defined property on this data.
IData
 Inherited
setStyle(styleProp:String, newValue:*):IStyle
Set a style property for an element/data.
IStyle
 Inherited
toChildren(matchFunction:Function = null):ICollection
Return all children as a collection filtered by the specified function.
IData
 Inherited
toString():String
IData
Property Detail
alarmStateproperty
alarmState:AlarmState  [read-only]

Get alarm state object of this element. Alarm state is a class used to carry all alarm information for this element.


Implementation
    public function get alarmState():AlarmState

See also

elementUIClassproperty 
elementUIClass:Class  [read-only]

Get UI class name for this element. UI class is the class responsible for rending this element on network canvas. Each element should provides UI class name to TWaver Flex so in the runtime TWaver Flex is able to create new UI class instance for this element.


Implementation
    public function get elementUIClass():Class
layerIDproperty 
layerID:Object

Get layer id of this element.


Implementation
    public function get layerID():Object
    public function set layerID(value:Object):void
Method Detail
isAdjustedToBottom()method
public function isAdjustedToBottom():Boolean

Check whether this element has been adjusted to the bottom.

Returns
Boolean — true if this element has been adjusted to the bottom, false otherwise.