Packagecom.flextoolbox.controls.treeMapClasses
Classpublic class BaseTreeMapBranchRenderer
InheritanceBaseTreeMapBranchRenderer Inheritance mx.core.UIComponent
ImplementsIDropInTreeMapItemRenderer, ITreeMapBranchRenderer
SubclassesLiteTreeMapBranchRenderer, TreeMapBranchRenderer

Some basic functionality for a branch renderer of the TreeMap control. Please consider this an abstract class that should be subclassed.

See also

com.flextoolbox.controls.TreeMap


Public Properties
 PropertyDefined by
  data : Object
BaseTreeMapBranchRenderer
  itemCount : int
[read-only] The number of items displayed in this branch.
BaseTreeMapBranchRenderer
  selected : Boolean
Indicates if the item is selected or not.
BaseTreeMapBranchRenderer
  treeMapData : BaseTreeMapData
When a component is used as a drop-in item renderer Flex initializes the treeMapData property of the component with the additional data from the TreeMap control.
BaseTreeMapBranchRenderer
Public Methods
 MethodDefined by
  
Constructor.
BaseTreeMapBranchRenderer
  
Adds an item to be displayed in this branch.
BaseTreeMapBranchRenderer
  
addItemAt(item:TreeMapItemLayoutData, index:int):void
Adds an item to a specific position in this branch.
BaseTreeMapBranchRenderer
  
Returns the item at the specified index.
BaseTreeMapBranchRenderer
  
itemsToArray():Array
Returns an Array containing all TreeMapItemLayoutData instances displayed by this branch.
BaseTreeMapBranchRenderer
  
Removes all items currently displayed in this branch.
BaseTreeMapBranchRenderer
  
Removes an item that is currently being displayed in this branch.
BaseTreeMapBranchRenderer
  
removeItemAt(index:int):void
Removes an item from a specific position in this branch.
BaseTreeMapBranchRenderer
Protected Methods
 MethodDefined by
  
layoutContents(contentBounds:Rectangle):void
Positions the children.
BaseTreeMapBranchRenderer
Property detail
dataproperty
data:Object  [read-write]

Implementation
    public function get data():Object
    public function set data(value:Object):void
itemCountproperty 
itemCount:int  [read-only]

The number of items displayed in this branch.

Implementation
    public function get itemCount():int
selectedproperty 
selected:Boolean  [read-write]

Indicates if the item is selected or not.

Implementation
    public function get selected():Boolean
    public function set selected(value:Boolean):void
treeMapDataproperty 
treeMapData:BaseTreeMapData  [read-write]

When a component is used as a drop-in item renderer Flex initializes the treeMapData property of the component with the additional data from the TreeMap control. The component can then use the treeMapData property and the data property to display the appropriate information as a drop-in item renderer.

You do not set this property in MXML or ActionScript; Flex sets it when the component is used as a drop-in item renderer.

Implementation
    public function get treeMapData():BaseTreeMapData
    public function set treeMapData(value:BaseTreeMapData):void
Constructor detail
BaseTreeMapBranchRenderer()constructor
public function BaseTreeMapBranchRenderer()

Constructor.

Method detail
addItem()method
public function addItem(item:TreeMapItemLayoutData):void

Adds an item to be displayed in this branch.

Parameters
item:TreeMapItemLayoutData
addItemAt()method 
public function addItemAt(item:TreeMapItemLayoutData, index:int):void

Adds an item to a specific position in this branch.

Parameters
item:TreeMapItemLayoutData
 
index:int
getItemAt()method 
public function getItemAt(index:int):TreeMapItemLayoutData

Returns the item at the specified index.

Parameters
index:int

Returns
TreeMapItemLayoutData
itemsToArray()method 
public function itemsToArray():Array

Returns an Array containing all TreeMapItemLayoutData instances displayed by this branch.

Returns
Array
layoutContents()method 
protected function layoutContents(contentBounds:Rectangle):void

Positions the children. Subclasses should override this or updateDisplayList() to size and position chrome.

Parameters
contentBounds:Rectangle
removeAllItems()method 
public function removeAllItems():void

Removes all items currently displayed in this branch.

removeItem()method 
public function removeItem(item:TreeMapItemLayoutData):void

Removes an item that is currently being displayed in this branch.

Parameters
item:TreeMapItemLayoutData
removeItemAt()method 
public function removeItemAt(index:int):void

Removes an item from a specific position in this branch.

Parameters
index:int