Packagecom.flextoolbox.controls.treeMapClasses
Classpublic class LiteTreeMapBranchRenderer
InheritanceLiteTreeMapBranchRenderer Inheritance BaseTreeMapBranchRenderer Inheritance mx.core.UIComponent

A very simple branch renderer for the TreeMap control. If the TreeMap has branch selection enabled, clicking the branch renderer will select the branch. If the TreeMap has zoom enabled, double clicking or ctrl-clicking the branch renderer will zoom the branch.

See also

com.flextoolbox.controls.TreeMap


Public Properties
 PropertyDefined by
 Inheriteddata : Object
BaseTreeMapBranchRenderer
 InheriteditemCount : int
BaseTreeMapBranchRenderer
  selected : Boolean
[write-only]
LiteTreeMapBranchRenderer
 InheritedtreeMapData : BaseTreeMapData
BaseTreeMapBranchRenderer
Protected Properties
 PropertyDefined by
  headerText : TextField
LiteTreeMapBranchRenderer
 Inheriteditems : Array
BaseTreeMapBranchRenderer
  mouseIsOver : Boolean = false
LiteTreeMapBranchRenderer
 InheritedtreeMapBranchData : TreeMapBranchData
BaseTreeMapBranchRenderer
  zoomCursorID : int = 0
LiteTreeMapBranchRenderer
Public Methods
 MethodDefined by
  
LiteTreeMapBranchRenderer
 Inherited
BaseTreeMapBranchRenderer
 Inherited
addItemAt(item:TreeMapItemLayoutData, index:int):void
BaseTreeMapBranchRenderer
 Inherited
BaseTreeMapBranchRenderer
 Inherited
itemsToArray():Array
BaseTreeMapBranchRenderer
 Inherited
BaseTreeMapBranchRenderer
 Inherited
BaseTreeMapBranchRenderer
 Inherited
removeItemAt(index:int):void
BaseTreeMapBranchRenderer
Protected Methods
 MethodDefined by
  
clickHandler(event:MouseEvent):void
LiteTreeMapBranchRenderer
  
doubleClickHandler(event:MouseEvent):void
LiteTreeMapBranchRenderer
 Inherited
layoutContents(contentBounds:Rectangle):void
BaseTreeMapBranchRenderer
  
rollOutHandler(event:MouseEvent):void
LiteTreeMapBranchRenderer
  
rollOverHandler(event:MouseEvent):void
LiteTreeMapBranchRenderer
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
BaseTreeMapBranchRenderer
Events
 EventSummaryDefined by
    LiteTreeMapBranchRenderer
    LiteTreeMapBranchRenderer
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.
LiteTreeMapBranchRenderer
  
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>

LiteTreeMapBranchRenderer
  
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.
LiteTreeMapBranchRenderer
  
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>

LiteTreeMapBranchRenderer
  
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.
LiteTreeMapBranchRenderer
  
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.
LiteTreeMapBranchRenderer
  
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".
LiteTreeMapBranchRenderer
  
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.
LiteTreeMapBranchRenderer
  
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".
LiteTreeMapBranchRenderer
  
borderThickness
Type: Number   Format: Length   CSS Inheritance: no
Bounding box thickness. Only used when borderStyle is set to "solid". The default value is 1.
LiteTreeMapBranchRenderer
  
color
Type: uint   Format: Color   CSS Inheritance: yes
Color of text in the component, including the component label. The default value is 0x0B333C.
LiteTreeMapBranchRenderer
  
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.
LiteTreeMapBranchRenderer
  
disabledColor
Type: uint   Format: Color   CSS Inheritance: yes
Color of text in the component if it is disabled. The default value is 0xAAB3B3.
LiteTreeMapBranchRenderer
  
dropShadowColor
Type: uint   Format: Color   CSS Inheritance: yes
Color of the drop shadow. The default value is 0x000000.
LiteTreeMapBranchRenderer
  
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.

LiteTreeMapBranchRenderer
  
fontAntiAliasType
Type: String   CSS Inheritance: yes
Sets the antiAliasType property of internal TextFields. The possible values are "normal" (flash.text.AntiAliasType.NORMAL) and "advanced" (flash.text.AntiAliasType.ADVANCED).

The default value is "advanced", which enables the FlashType renderer if you are using an embedded FlashType font. Set to "normal" to disable the FlashType renderer.

This style has no effect for system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

The default value is "advanced".
LiteTreeMapBranchRenderer
  
fontFamily
Type: String   CSS Inheritance: yes
Name of the font to use. Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font. The default value is "Verdana".
LiteTreeMapBranchRenderer
  
fontGridFitType
Type: String   CSS Inheritance: yes
Sets the gridFitType property of internal TextFields that represent text in Flex controls. The possible values are "none" (flash.text.GridFitType.NONE), "pixel" (flash.text.GridFitType.PIXEL), and "subpixel" (flash.text.GridFitType.SUBPIXEL).

This property only applies when you are using an embedded FlashType font and the fontAntiAliasType property is set to "advanced".

This style has no effect for system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

The default value is "pixel".
LiteTreeMapBranchRenderer
  
fontSharpness
Type: Number   CSS Inheritance: yes
Sets the sharpness property of internal TextFields that represent text in Flex controls. This property specifies the sharpness of the glyph edges. The possible values are Numbers from -400 through 400.

This property only applies when you are using an embedded FlashType font and the fontAntiAliasType property is set to "advanced".

This style has no effect for system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

The default value is 0.
LiteTreeMapBranchRenderer
  
fontSize
Type: Number   Format: Length   CSS Inheritance: yes
Height of the text, in pixels. The default value is 10 for all controls except the ColorPicker control. For the ColorPicker control, the default value is 11.
LiteTreeMapBranchRenderer
  
fontStyle
Type: String   CSS Inheritance: yes
Determines whether the text is italic font. Recognized values are "normal" and "italic". The default value is "normal".
LiteTreeMapBranchRenderer
  
fontThickness
Type: Number   CSS Inheritance: yes
Sets the thickness property of internal TextFields that represent text in Flex controls. This property specifies the thickness of the glyph edges. The possible values are Numbers from -200 to 200.

This property only applies when you are using an embedded FlashType font and the fontAntiAliasType property is set to "advanced".

This style has no effect on system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

The default value is 0.
LiteTreeMapBranchRenderer
  
fontWeight
Type: String   CSS Inheritance: yes
Determines whether the text is boldface. Recognized values are normal and bold. The default value for Button controls is bold. The default value for all other controls is normal.
LiteTreeMapBranchRenderer
  
kerning
Type: Boolean   CSS Inheritance: yes
A Boolean value that indicates whether kerning is enabled (true) or disabled (false). Kerning adjusts the gap between certain character pairs to improve readability, and should be used only when necessary, such as with headings in large fonts. Kerning is supported for embedded FlashType fonts only. Certain fonts, such as Verdana, and monospaced fonts, such as Courier New, do not support kerning. The default value is false.
LiteTreeMapBranchRenderer
  
letterSpacing
Type: Number   CSS Inheritance: yes
The number of additional pixels to appear between each character. A positive value increases the character spacing beyond the normal spacing, while a negative value decreases it. The default value is 0.
LiteTreeMapBranchRenderer
  
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.

LiteTreeMapBranchRenderer
  
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.

LiteTreeMapBranchRenderer
  
shadowDirection
Type: String   CSS Inheritance: no
Direction of the drop shadow. Possible values are "left", "center", and "right". The default value is "center".
LiteTreeMapBranchRenderer
  
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.
LiteTreeMapBranchRenderer
  
textAlign
Type: String   CSS Inheritance: yes
Alignment of text within a container. Possible values are "left", "right", or "center".

The default value for most components is "left". For the FormItem component, the default value is "right". For the Button, LinkButton, and AccordionHeader components, the default value is "center", and this property is only recognized when the labelPlacement property is set to "left" or "right". If labelPlacement is set to "top" or "bottom", the text and any icon are centered.

LiteTreeMapBranchRenderer
  
textDecoration
Type: String   CSS Inheritance: yes
Determines whether the text is underlined. Possible values are "none" and "underline". The default value is "none".
LiteTreeMapBranchRenderer
  
textIndent
Type: Number   Format: Length   CSS Inheritance: yes
Offset of first line of text from the left side of the container, in pixels. The default value is 0.
LiteTreeMapBranchRenderer
Property detail
headerTextproperty
protected var headerText:TextField
mouseIsOverproperty 
protected var mouseIsOver:Boolean = false
selectedproperty 
selected:Boolean  [write-only]Implementation
    public function set selected(value:Boolean):void
zoomCursorIDproperty 
protected var zoomCursorID:int = 0
Constructor detail
LiteTreeMapBranchRenderer()constructor
public function LiteTreeMapBranchRenderer()
Method detail
clickHandler()method
protected function clickHandler(event:MouseEvent):voidParameters
event:MouseEvent
doubleClickHandler()method 
protected function doubleClickHandler(event:MouseEvent):voidParameters
event:MouseEvent
rollOutHandler()method 
protected function rollOutHandler(event:MouseEvent):voidParameters
event:MouseEvent
rollOverHandler()method 
protected function rollOverHandler(event:MouseEvent):voidParameters
event:MouseEvent
Event detail
branchSelectevent 
Event object type: com.flextoolbox.events.TreeMapEvent

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