Packagetwaver
Classpublic class Group
InheritanceGroup Inheritance Follower Inheritance Node Inheritance Element Inheritance Data Inheritance flash.events.EventDispatcher

Group is a special node and follower that will display all its children element in a special shape area. This group can expanded or closed. When group expanded, all inside children will visible in their own location, group it self will shows as a special shape with in a size that can just cover all children. Double click expanded group, the group will be closed. At this time, group will display like a normal node with its image and location, all inside children will invisible.

Group is a very useful container element. You can use this to reorganize the data on the network to make it more clear and easy to understand.

Please note that group is different with SubNetwork. SubNetwork displays all children elements in a inside, lower layer map but group not. Group and its children elements are still in the same map and topology, just can expanded or closed by group.

See also

twaver.SubNetwork


Public Properties
 PropertyDefined By
 InheritedagentLinks : ICollection
[read-only] Get all agential links of this node.
Node
 InheritedalarmState : AlarmState
[read-only] Get alarm state object of this element.
Element
 InheritedcenterLocation : Point
Get the location of this node's center point.
Node
 Inheritedchildren : ICollection
[read-only] Get all children data objects of this data object.
Data
 InheritedchildrenCount : int
[read-only] Get all children total count for this data.
Data
 InheritedclientProperties : ICollection
[read-only] Get a ICollection that contians all client proerty name.
Data
  elementUIClass : Class
[override] [read-only] Get element ui class name.
Group
  expanded : Boolean
Check whether this group is in expanded status.
Group
 Inheritedfollowers : ICollection
[read-only] Get all followers of this node with a collection.
Node
 InheritedfromAgentLinks : ICollection
[read-only] Get all agential from/start links of this node with a collection.
Node
 InheritedfromLinks : ICollection
[read-only] Get all links start from this node.
Node
 InheritedhasChildren : Boolean
[read-only] Check whether this data has children objects.
Data
 Inheritedheight : Number
Get node height value.
Node
 Inheritedhost : Node
Get the host node of this follower.
Follower
 Inheritedicon : String
Get icon value for this data.
Data
 Inheritedid : Object
[read-only] Get the ID value of this data.
Data
 Inheritedimage : String
Get image url of this node.
Node
 InheritedlayerID : Object
Get layer ID of this element.
Element
 Inheritedlinks : ICollection
[read-only] Get all connected links of this node with a collection.
Node
  location : Point
[override] Set the location for this node.
Group
 InheritedloopedLinks : ICollection
[read-only] Get all looped links on this node with a collection.
Node
 Inheritedname : String
Get name of this data.
Data
 Inheritedparent : IData
Get parent data object.
Data
 Inheritedrect : Rectangle
[read-only] Get node bounds.
Node
 Inheritedsize : Size
[read-only] Get node size.
Node
 InheritedstyleProperties : ICollection
[read-only] Get a ICollection that contians all style proerty name.
Element
 InheritedtoAgentLinks : ICollection
[read-only] Get all agential to/end links of this node with a collection.
Node
 InheritedtoLinks : ICollection
[read-only] Get all to/end links end to this node.
Node
 InheritedtoolTip : String
Get the tooltip text of this data.
Data
 Inheritedwidth : Number
Get node width.
Node
 Inheritedx : Number
[read-only] Get x location of this node.
Node
 Inheritedy : Number
[read-only] Get y location of this node.
Node
Public Methods
 MethodDefined By
  
Group(id:Object = null)
Constructor.
Group
 Inherited
addChild(child:IData, index:int = -1):Boolean
Add a child data object for this data.
Data
 Inherited
addPropertyChangeListener(listener:Function, priority:int = 0, useWeakReference:Boolean = false):void
Add a property change listener to this data to monitoring property change event.
Data
 Inherited
clearChildren():Boolean
Clear all children from this data.
Data
 Inherited
deserializeXML(serializer:XMLSerializer, xml:XML):void
[override] inheritDoc
Element
 Inherited
dispatchPropertyChangeEvent(property:String, oldValue:Object, newValue:Object):Boolean
Dispatch property change event to all installed listeners.
Data
 Inherited
getChildAt(index:int):IData
Get child as specified index location.
Data
 Inherited
getClient(clientProp:String):*
Get specified client property value.
Data
 Inherited
getPropertyValue(property:String):Object
[override] Get an user defined property on this data.
Element
 Inherited
getStyle(styleProp:String, returnDefaultIfNull:Boolean = true):*
Get the specified style property value.
Element
 Inherited
hasAgentLinks():Boolean
Check whether this node has agential links.
Node
 Inherited
hasOwnProperty(name:String):Boolean
Whether this data has specified property.
Data
  
[override] Check whether this element has been adjusted to bottom.
Group
 Inherited
isDescendantOf(data:IData):Boolean
Check whether this data is a descendant of the specified data object.
Data
 Inherited
isHostOn(node:Node):Boolean
Check whether the specified node is my host or on my host chain.
Follower
 Inherited
isLoopedHostOn(follower:Follower):Boolean
Check whether specified follower is on a looped host chain.
Follower
 Inherited
isParentOf(data:IData):Boolean
Check whether this data is the parent of specified data.
Data
 Inherited
isRelatedTo(data:IData):Boolean
Check whether this data has descendant relationship with the specified data.
Data
 Inherited
removeChild(child:IData):Boolean
Remove the specified child object.
Data
 Inherited
removePropertyChangeListener(listener:Function):void
Remove the specified property change listener.
Data
  
Reverse the expand status.
Group
  
serializeXML(serializer:XMLSerializer, newInstance:IData):void
[override] inheritDoc
Group
 Inherited
setCenterLocation(x:Number, y:Number):void
Set a new location for this node's center point.
Node
 Inherited
setClient(clientProp:String, newValue:*):IClient
Set client property for this data.
Data
 Inherited
setLocation(x:Number, y:Number):void
Set a new location for this node.
Node
 Inherited
setPropertyValue(property:String, value:Object):void
[override] Set an user defined property on this data.
Element
 Inherited
setSize(width:Number, height:Number):void
Set node size.
Node
 Inherited
setStyle(styleProp:String, newValue:*):IStyle
Set a style for this element.
Element
 Inherited
toChildren(matchFunction:Function = null):ICollection
Iterate children collection by given callback function.
Data
 Inherited
toString():String
[override]
Data
 Inherited
translate(dx:Number, dy:Number):void
Translate node location to specified offset.
Node
  
Call this to update group location by all children.
Group
Protected Methods
 MethodDefined By
 Inherited
deserializeClient(serializer:XMLSerializer, clientXML:XML, clientProp:String):void
Deserialize client property from given XML data.
Data
 Inherited
deserializeProperty(serializer:XMLSerializer, propertyXML:XML, property:String):void
[override] inheritDoc
Element
 Inherited
deserializeStyle(serializer:XMLSerializer, styleXML:XML, styleProp:String):void
Deserialize style from given XML data.
Element
 Inherited
handleHostPropertyChange(e:PropertyChangeEvent):void
Called when host property is changed.
Follower
  
onChildAdded(child:IData, index:int):void
[override] Called back when a child is added.
Group
  
onChildRemoved(child:IData, index:int):void
[override] Called back when a child is removed.
Group
 Inherited
onChildrenCleared(children:Array):void
Called back when all children are cleared from this data.
Data
 Inherited
onClientChanged(styleProp:String, oldValue:*, newValue:*):void
Called when client property is changed.
Data
 Inherited
onHostChanged(oldHost:Node, newHost:Node):void
Called when host node is changed.
Follower
 Inherited
onParentChanged(oldParent:IData, newParent:IData):void
[override] Called back when data parent changed.
Node
 Inherited
onPropertyChanged(property:String, oldValue:Object, newValue:Object):void
[override] Called back when a property of this data is changed.
Node
 Inherited
onStyleChanged(styleProp:String, oldValue:*, newValue:*):void
[override] Called when style property is changed.
Follower
 Inherited
serializeClient(serializer:XMLSerializer, clientPrope:String, newInstance:IData):void
Serialize given client property into the specified XML serializer.
Data
 Inherited
serializeProperty(serializer:XMLSerializer, property:String, newInstance:IData):void
Serialize given property into the specified XML serializer.
Data
 Inherited
serializeStyle(serializer:XMLSerializer, stylePrope:String, newInstance:IData):void
Serialize specified property into XML.
Element
 Inherited
updateFollower(e:PropertyChangeEvent):void
Update follower after host property is changed
Follower
 Inherited
updateFollowerImpl(e:PropertyChangeEvent):void
Core implementation of methd updateFollower
Follower
Property Detail
elementUIClassproperty
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.


Implementation
    public function get elementUIClass():Class
expandedproperty 
expanded:Boolean

Check whether this group is in expanded status.


Implementation
    public function get expanded():Boolean
    public function set expanded(value:Boolean):void
locationproperty 
location:Point[override]

Set the location for this node. Node on network canvas will be moved to the new location once this 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.


Implementation
    public function get location():Point
    public function set location(value:Point):void
Constructor Detail
Group()Constructor
public function Group(id:Object = null)

Constructor.

Parameters
id:Object (default = null) — the group id.
Method Detail
isAdjustedToBottom()method
override public function isAdjustedToBottom():Boolean

Check whether this element has been adjusted to bottom.

Returns
Boolean — true if has been adjusted to bottom, false otherwise.
onChildAdded()method 
override protected function onChildAdded(child:IData, index:int):void

Called back when a child is added. Subclasses can overwrite this method to do something.

Parameters

child:IData — the new added child data object
 
index:int — the index of the new added child data object

onChildRemoved()method 
override protected function onChildRemoved(child:IData, index:int):void

Called back when a child is removed. Subclasses could overwrite this method to do something when a child is removed from this data.

Parameters

child:IData — the removed child data.
 
index:int — the index of the removed child data.

reverseExpanded()method 
public function reverseExpanded():void

Reverse the expand status. If expanded, then close it; if closed, then expand it.

serializeXML()method 
override public function serializeXML(serializer:XMLSerializer, newInstance:IData):void

inheritDoc

Parameters

serializer:XMLSerializer
 
newInstance:IData

updateLocationFromChildren()method 
public function updateLocationFromChildren():void

Call this to update group location by all children.