Packagecom.flextoolbox.controls.treeMapClasses
Classpublic class TreeMapBranchRenderer
InheritanceTreeMapBranchRenderer Inheritance BaseTreeMapBranchRenderer Inheritance mx.core.UIComponent

The default branch renderer for the TreeMap control. Includes a header with a label and a zoom button.

See also

com.flextoolbox.controls.TreeMap


Public Properties
 PropertyDefined by
 Inheriteddata : Object
BaseTreeMapBranchRenderer
  headerRenderer : IFactory
A factory used to create the header controls for the branch.
TreeMapBranchRenderer
 InheriteditemCount : int
The number of items displayed in this branch.
BaseTreeMapBranchRenderer
 Inheritedselected : Boolean
Indicates if the item is selected or not.
BaseTreeMapBranchRenderer
 InheritedtreeMapData : 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.
TreeMapBranchRenderer
 Inherited
Adds an item to be displayed in this branch.
BaseTreeMapBranchRenderer
 Inherited
addItemAt(item:TreeMapItemLayoutData, index:int):void
Adds an item to a specific position in this branch.
BaseTreeMapBranchRenderer
 Inherited
Returns the item at the specified index.
BaseTreeMapBranchRenderer
 Inherited
itemsToArray():Array
Returns an Array containing all TreeMapItemLayoutData instances displayed by this branch.
BaseTreeMapBranchRenderer
 Inherited
move(x:Number, y:Number):void
BaseTreeMapBranchRenderer
 Inherited
Removes all items currently displayed in this branch.
BaseTreeMapBranchRenderer
 Inherited
Removes an item that is currently being displayed in this branch.
BaseTreeMapBranchRenderer
 Inherited
removeItemAt(index:int):void
Removes an item from a specific position in this branch.
BaseTreeMapBranchRenderer
Protected Methods
 MethodDefined by
 Inherited
layoutContents(contentBounds:Rectangle):void
Positions the children.
BaseTreeMapBranchRenderer
Events
 EventSummaryDefined by
    TreeMapBranchRenderer
    TreeMapBranchRenderer
Styles
 StyleDescriptionDefined by
  
backgroundAlpha
Type: Number   CSS Inheritance: no
Alpha level of the color defined by the backgroundColor property, of the image or SWF file defined by the backgroundImage style. Valid values range from 0.0 to 1.0. The default value is 1.0.
TreeMapBranchRenderer
  
backgroundColor
Type: uint   Format: Color   CSS Inheritance: no
Background color of a component. You can have both a backgroundColor and a backgroundImage set. Some components do not have a background. The DataGrid control ignores this style. The default value is undefined, which means it is not set. If both this style and the backgroundImage style are undefined, the component has a transparent background.

For the Application container, this style specifies the background color while the application loads, and a background gradient while it is running. Flex calculates the gradient pattern between a color slightly darker than the specified color, and a color slightly lighter than the specified color.

The default skins of most Flex controls are partially transparent. As a result, the background color of a container partially "bleeds through" to controls that are in that container. You can avoid this by setting the alpha values of the control's fillAlphas property to 1, as the following example shows:

  <mx:Container backgroundColor="0x66CC66"/>
      <mx:ControlName ... fillAlphas="[1,1]"/>
  </mx:Container>

TreeMapBranchRenderer
  
backgroundDisabledColor
Type: uint   Format: Color   CSS Inheritance: yes
Background color of the component when it is disabled. The global default value is undefined. The default value for List controls is 0xDDDDDD (light gray). If a container is disabled, the background is dimmed, and the degree of dimming is controlled by the disabledOverlayAlpha style.
TreeMapBranchRenderer
  
backgroundImage
Type: Object   Format: File   CSS Inheritance: no
Background image of a component. This can be an absolute or relative URL or class. You can either have both a backgroundColor and a backgroundImage set at the same time. The background image is displayed on top of the background color. The default value is undefined, meaning "not set". If this style and the backgroundColor style are undefined, the component has a transparent background.

The default skins of most Flex controls are partially transparent. As a result, the background image of a container partially "bleeds through" to controls that are in that container. You can avoid this by setting the alpha values of the control's fillAlphas property to 1, as the following example shows:

  <mx:Container backgroundColor="0x66CC66"/>
      <mx:ControlName ... fillAlphas="[1,1]"/>
  </mx:Container>

TreeMapBranchRenderer
  
backgroundSize
Type: String   CSS Inheritance: no
Scales the image specified by backgroundImage to different percentage sizes. A value of "100%" stretches the image to fit the entire component. To specify a percentage value, you must include the percent sign (%). The default for the Application container is 100%. The default value for all other containers is auto, which maintains the original size of the image.
TreeMapBranchRenderer
  
borderColor
Type: uint   Format: Color   CSS Inheritance: no
Color of the border. The default value depends on the component class; if not overridden for the class, the default value is 0xB7BABC.
TreeMapBranchRenderer
  
borderSides
Type: String   CSS Inheritance: no
Bounding box sides. A space-delimited String that specifies the sides of the border to show. The String can contain "left", "top", "right", and "bottom" in any order. The default value is "left top right bottom", which shows all four sides. This style is only used when borderStyle is "solid".
TreeMapBranchRenderer
  
borderSkin
Type: Class   CSS Inheritance: no
The border skin class of the component. The mx.skins.halo.HaloBorder class is the default value for all components that do not explicitly set their own default. The Panel container has a default value of mx.skins.halo.PanelSkin. To determine the default value for a component, see the default.css file. The default value is mx.skins.halo.HaloBorder.
TreeMapBranchRenderer
  
borderStyle
Type: String   CSS Inheritance: no
Bounding box style. The possible values are "none", "solid", "inset", and "outset". The default value depends on the component class; if not overridden for the class, the default value is "inset". The default value for most Containers is "none".
TreeMapBranchRenderer
  
borderThickness
Type: Number   Format: Length   CSS Inheritance: no
Bounding box thickness. Only used when borderStyle is set to "solid". The default value is 1.
TreeMapBranchRenderer
  
cornerRadius
Type: Number   Format: Length   CSS Inheritance: no
Radius of component corners. The default value depends on the component class; if not overriden for the class, the default value is 0. The default value for ApplicationControlBar is 5.
TreeMapBranchRenderer
  
dropShadowColor
Type: uint   Format: Color   CSS Inheritance: yes
Color of the drop shadow. The default value is 0x000000.
TreeMapBranchRenderer
  
dropShadowEnabled
Type: Boolean   CSS Inheritance: no
Boolean property that specifies whether the component has a visible drop shadow. This style is used with borderStyle="solid". The default value is false.

Note: For drop shadows to appear on containers, set backgroundColor or backgroundImage properties. Otherwise, the shadow appears behind the container because the default background of a container is transparent.

TreeMapBranchRenderer
  
headerStyleName
Type: String   CSS Inheritance: no
Name of the CSS style declaration that specifies styles for the treemap branch headers. You can use this class selector to set the values of all the style properties of the TreeMapBranchHeader class.
TreeMapBranchRenderer
  
paddingLeft
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the component's left border and the left edge of its content area.

The default value is 0.

The default value for a Button control is 10.

The default value for the ComboBox control is 5.

The default value for the Form container is 16.

The default value for the Tree control is 2.

TreeMapBranchRenderer
  
paddingRight
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the component's right border and the right edge of its content area.

The default value is 0.

The default value for a Button control is 10.

The default value for the ComboBox control is 5.

The default value for the Form container is 16.

TreeMapBranchRenderer
  
shadowDirection
Type: String   CSS Inheritance: no
Direction of the drop shadow. Possible values are "left", "center", and "right". The default value is "center".
TreeMapBranchRenderer
  
shadowDistance
Type: Number   Format: Length   CSS Inheritance: no
Distance of the drop shadow. If the property is set to a negative value, the shadow appears above the component. The default value is 2.
TreeMapBranchRenderer
Property detail
headerRendererproperty
headerRenderer:IFactory  [read-write]

A factory used to create the header controls for the branch. The default value is a factory which creates a com.flextoolbox.controls.treeMapClasses.TreeMapBranchHeader. The created object must be a subclass of UIComponent and implement the mx.core.IDataRenderer interface. The data property is set to the branch renderer associated with the header.

Implementation
    public function get headerRenderer():IFactory
    public function set headerRenderer(value:IFactory):void

See also

TreeMapBranchHeader
Constructor detail
TreeMapBranchRenderer()constructor
public function TreeMapBranchRenderer()

Constructor.

Event detail
requestSelectevent 
Event object type: com.flextoolbox.events.TreeMapBranchEvent

requestZoomevent  
Event object type: com.flextoolbox.events.TreeMapBranchEvent