Packageflare.vis.controls
Classpublic class ControlList
InheritanceControlList Inheritance flash.utils.Proxy
Implementsmx.core.IMXMLObject

A ControlList maintains a sequential chain of controls for interacting with a visualization. Controls may perform operations such as selection, panning, zooming, and expand/contract. Controls can be added to a ControlList using the add method. Once added, controls can be retrieved and set using their index in the lists, either with array notation ([]) or with the getControlAt and setControlAt methods.



Public Properties
 PropertyDefined by
  length : uint
[read-only] The number of controls in the list.
ControlList
  list : Array
[write-only] An array of the controls contained in the control list.
ControlList
  visualization : Visualization
The visualization manipulated by these controls.
ControlList
Protected Properties
 PropertyDefined by
  _list : Array
ControlList
  _vis : Visualization
ControlList
Public Methods
 MethodDefined by
  
ControlList(... controls)
Creates a new ControlList.
ControlList
  
add(ic:IControl):void
Adds a control to the end of this list.
ControlList
  
addAt(ic:IControl, idx:int):void
Adds a control at the specified index in the list.
ControlList
  
clear():void
Removes all controls from this list.
ControlList
  
Returns the control at the specified position in the list
ControlList
  
Removes an control from this list.
ControlList
  
Removes the control at the specified position in the list
ControlList
  
Set the control at the specified position in the list
ControlList
Protected Methods
 MethodDefined by
  
getProperty(name:*):*
Proxy method for retrieving controls from the internal array.
ControlList
  
setProperty(name:*, value:*):void
Proxy method for setting controls in the internal array.
ControlList
Property detail
lengthproperty
length:uint  [read-only]

The number of controls in the list.

Implementation
    public function get length():uint
_listproperty 
protected var _list:Array
listproperty 
list:Array  [write-only]

An array of the controls contained in the control list.

Implementation
    public function set list(value:Array):void
_visproperty 
protected var _vis:Visualization
visualizationproperty 
visualization:Visualization  [read-write]

The visualization manipulated by these controls.

Implementation
    public function get visualization():Visualization
    public function set visualization(value:Visualization):void
Constructor detail
ControlList()constructor
public function ControlList(... controls)

Creates a new ControlList.

Parameters
... controls — an ordered set of controls to include in the list.
Method detail
add()method
public function add(ic:IControl):void

Adds a control to the end of this list.

Parameters
ic:IControl — the control to add
addAt()method 
public function addAt(ic:IControl, idx:int):void

Adds a control at the specified index in the list.

Parameters
ic:IControl — the control to add
 
idx:int — the index into the list
clear()method 
public function clear():void

Removes all controls from this list.

getControlAt()method 
public function getControlAt(i:uint):IControl

Returns the control at the specified position in the list

Parameters
i:uint — the index into the control list

Returns
IControl — the requested control
getProperty()method 
flash_proxy override function getProperty(name:*):*

Proxy method for retrieving controls from the internal array.

Parameters
name:*

Returns
*
remove()method 
public function remove(ic:IControl):IControl

Removes an control from this list.

Parameters
ic:IControl — the control to remove

Returns
IControl — true if the control was found and removed, false otherwise
removeControlAt()method 
public function removeControlAt(i:uint):IControl

Removes the control at the specified position in the list

Parameters
i:uint — the index into the control list

Returns
IControl — the removed control
setControlAt()method 
public function setControlAt(i:uint, ic:IControl):IControl

Set the control at the specified position in the list

Parameters
i:uint — the index into the control list
 
ic:IControl — the control to place in the list

Returns
IControl — the control previously at the index
setProperty()method 
flash_proxy override function setProperty(name:*, value:*):void

Proxy method for setting controls in the internal array.

Parameters
name:*
 
value:*