Packagecom.flextoolbox.controls.treeMapClasses
Interfacepublic interface ITreeMapBranchRenderer extends ITreeMapItemRenderer, mx.core.IDataRenderer, mx.core.IUIComponent, flash.events.IEventDispatcher, mx.core.IFlexDisplayObject, mx.styles.IStyleClient, mx.core.IInvalidating
ImplementorsBaseTreeMapBranchRenderer

The interface that defines functionality required for a TreeMap control's branch renderers.

See also

com.flextoolbox.controls.TreeMap

Public Properties
 PropertyDefined by
  itemCount : int
[read-only] The number of items displayed in this branch.
ITreeMapBranchRenderer
 Inheritedselected : Boolean
ITreeMapItemRenderer
Public Methods
 MethodDefined by
  
addItem(item:TreeMapItemLayoutData):void
Adds an item to be displayed in this branch.
ITreeMapBranchRenderer
  
addItemAt(item:TreeMapItemLayoutData, index:int):void
Adds an item to a specific position in this branch.
ITreeMapBranchRenderer
  
getItemAt(index:int):TreeMapItemLayoutData
Returns the item at the specified index.
ITreeMapBranchRenderer
  
itemsToArray():Array
Returns an Array containing all items within this branch.
ITreeMapBranchRenderer
  
removeAllItems():void
Removes all items currently displayed in this branch.
ITreeMapBranchRenderer
  
removeItem(item:TreeMapItemLayoutData):void
Removes an item that is currently being displayed in this branch.
ITreeMapBranchRenderer
  
removeItemAt(index:int):void
Removes an item from a specific position in this branch.
ITreeMapBranchRenderer
Events
 EventSummaryDefined by
  
branchLayoutChange
TODO: Document this! ITreeMapBranchRenderer
  
branchSelect
TODO: Document this! ITreeMapBranchRenderer
  
branchZoom
TODO: Document this! ITreeMapBranchRenderer
Property detail
itemCountproperty
itemCount:int  [read-only]

The number of items displayed in this branch.

Implementation
    public function get itemCount():int
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 items within this branch.

Returns
Array
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
Event detail
branchLayoutChangeevent 
Event object type: com.flextoolbox.events.TreeMapLayoutEvent

TODO: Document this!

branchSelectevent  
Event object type: com.flextoolbox.events.TreeMapEvent

TODO: Document this!

branchZoomevent  
Event object type: com.flextoolbox.events.TreeMapEvent

TODO: Document this!




Access flextreemap on Google Groups for feedback and support
Copyright 2008 Josh Tynjala. All rights reserved.