Package | twaver |
Class | public class Grid |
Inheritance | Grid ![]() ![]() ![]() ![]() ![]() |
Grid is a good element to present a grid-like telecom equipment panel or chassis. You can divide an equipment rick or slot with columns or rows, add cards, ports on the grid at the cells, then very easy to build a complex equipment panel.
Check out "Grid Editor Demo" in TWaver Flex online demo and the related source code to know more about the usage of grid element
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. | Grid | ||
![]() | 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 | |
![]() | host : Node
Get the host node of this follower. | Follower | |
![]() | 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 [override]
Set the location for this node. | Follower | |
![]() | 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 | ||
---|---|---|---|
Grid(id:Object = null)
The constructor of grid element. | Grid | ||
![]() |
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 | |
getCellObject(point:Point):Object
Get the cell object of the specified location. | Grid | ||
getCellRect(rowIndex:Number, columnIndex:Number):Rectangle
Get the cell bounds by specified row and column index. | Grid | ||
![]() | 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 | |
![]() |
Check whether the specified node is my host or on
my host chain. | Follower | |
![]() | isLoopedHostOn(follower:Follower):Boolean
Check whether specified follower is on a looped host chain. | Follower | |
![]() | 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
| Follower | |
![]() | 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 |
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
Grid | () | Constructor |
public function Grid(id:Object = null)
The constructor of grid element.
Parametersid:Object (default = null ) — the ID of grid element.
|
getCellObject | () | method |
public function getCellObject(point:Point):Object
Get the cell object of the specified location. The returned object is a simple object with "rowIndex", "columnIndex" and "rect" values.
Parameters
point:Point — the cell this point located.
|
Object — the cell object specified point is located.
|
getCellRect | () | method |
public function getCellRect(rowIndex:Number, columnIndex:Number):Rectangle
Get the cell bounds by specified row and column index.
Parameters
rowIndex:Number — row index of the cell
| |
columnIndex:Number — column index of the cell
|
Rectangle — specified cell bounds
|