Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.controls 
Tree 
Packagemx.controls
Classpublic class Tree
InheritanceTree Inheritance List Inheritance ListBase Inheritance ScrollControlBase Inheritance UIComponent Inheritance FlexSprite Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Implements IIMESupport
Subclasses FileSystemTree

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The Tree control lets a user view hierarchical data arranged as an expandable tree. Each item in a tree can be a leaf or a branch. A leaf item is an end point in the tree. A branch item can contain leaf or branch items, or it can be empty.

By default, a leaf is represented by a text label next to a file icon. A branch is represented by a text label next to a folder icon, with a disclosure triangle that a user can open to expose children.

The Tree class uses an ITreeDataDescriptor or ITreeDataDescriptor2 object to parse and manipulate the data provider. The default tree data descriptor, an object of the DefaultDataDescriptor class, supports XML and Object classes; an Object class data provider must have all children in children fields.

The Tree control has the following default sizing characteristics:

CharacteristicDescription
Default sizeWide enough to accommodate the icon, label, and expansion triangle, if any, of the widest node in the first 7 displayed (uncollapsed) rows, and seven rows high, where each row is 20 pixels in height. If a scroll bar is required, the width of the scroll bar is not included in the width calculations.
Minimum size0 pixels.
Maximum size5000 by 5000.

MXML SyntaxexpandedHide MXML Syntax

The <mx:Tree> tag inherits all the tag attributes of its superclass, and adds the following tag attributes:

  <mx:Tree
    Properties
    dataDescriptor="Instance of DefaultDataDescriptor"
    dataProvider="null"
    dragMoveEnabled="true|false"
    firstVisibleItem="First item in the control"
    hasRoot="false|true"
    itemIcons="null"
    maxHorizontalScrollPosition="0"
    openItems="null"
    showRoot="true|false"
     
    Styles
    alternatingItemColors="undefined"
    backgroundDisabledColor="0xDDDDDD"
    defaultLeafIcon="'TreeNodeIcon' symbol in Assets.swf"
    depthColors="undefined"
    disclosureClosedIcon="'TreeDisclosureClosed' symbol in Assets.swf"
    disclosureOpenIcon="'TreeDisclosureOpen' symbol in Assets.swf"
    folderClosedIcon="'TreeFolderClosed' symbol in Assets.swf"
    folderOpenIcon="'TreeFolderOpen' symbol in Assets.swf"
    indentation="17"
    openDuration="250"
    openEasingFunction="undefined"
    paddingLeft="2"
    paddingRight="0"
    rollOverColor="0xAADEFF"
    selectionColor="0x7FCDFE"
    selectionDisabledColor="0xDDDDDD"
    selectionEasingFunction="undefined"
    textRollOverColor="0x2B333C"
    textSelectedColor="0x2B333C"
     
    Events
    change="No default"
    itemClose="No default"
    itemOpen="No default"
    itemOpening="No default"
  />
  

Default MXML PropertydataProvider

View the examples

See also



Public Properties
 PropertyDefined By
 InheritedaccessibilityDescription : String
A convenience accessor for the description property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityEnabled : Boolean
A convenience accessor for the silent property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance.
InteractiveObject
 InheritedaccessibilityName : String
A convenience accessor for the name property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
DisplayObject
 InheritedaccessibilityShortcut : String
A convenience accessor for the shortcut property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedactiveEffects : Array
[read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances.
UIComponent
 InheritedallowDragSelection : Boolean = false
A flag that indicates whether drag-selection is enabled.
ListBase
 InheritedallowMultipleSelection : Boolean
A flag that indicates whether you can allow more than one item to be selected at the same time.
ListBase
 Inheritedalpha : Number
Indicates the alpha transparency value of the object specified.
DisplayObject
 InheritedautomationDelegate : Object
The delegate object that handles the automation-related functionality.
UIComponent
 InheritedautomationEnabled : Boolean
[read-only] True if this component is enabled for automation, false otherwise.
UIComponent
 InheritedautomationName : String
Name that can be used as an identifier for this object.
UIComponent
 InheritedautomationOwner : DisplayObjectContainer
[read-only] The owner of this component for automation purposes.
UIComponent
 InheritedautomationParent : DisplayObjectContainer
[read-only] The parent of this component for automation purposes.
UIComponent
 InheritedautomationTabularData : Object
[read-only] An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.
UIComponent
 InheritedautomationValue : Array
[read-only] This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application.
UIComponent
 InheritedautomationVisible : Boolean
[read-only] True if this component is visible for automation, false otherwise.
UIComponent
 Inheritedbaseline : Object
The vertical distance in pixels from the anchor target to the control's baseline position.
UIComponent
 InheritedbaselinePosition : Number
[read-only] The y-coordinate of the baseline of the first line of text of the component.
UIComponent
 InheritedblendMode : String
A value from the BlendMode class that specifies which blend mode to use.
DisplayObject
 InheritedblendShader : Shader
[write-only] Sets a shader that is used for blending the foreground and background.
DisplayObject
 InheritedborderMetrics : EdgeMetrics
[read-only] Returns an EdgeMetrics object that has four properties: left, top, right, and bottom.
ScrollControlBase
 Inheritedbottom : Object
The vertical distance in pixels from the bottom edge of the component to the anchor target's bottom edge.
UIComponent
 InheritedbuttonMode : Boolean
Specifies the button mode of this sprite.
Sprite
 InheritedcacheAsBitmap : Boolean
If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the display object.
DisplayObject
 InheritedcacheHeuristic : Boolean
[write-only] Used by Flex to suggest bitmap caching for the object.
UIComponent
 InheritedcachePolicy : String
Specifies the bitmap caching policy for this object.
UIComponent
 InheritedclassName : String
[read-only] The name of this instance's class, such as "Button".
UIComponent
 InheritedcolumnCount : int
The number of columns to be displayed in a TileList control or items in a HorizontalList control.
ListBase
 InheritedcolumnWidth : Number
The width of the control's columns.
ListBase
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcontentMouseX : Number
[read-only] Returns the x position of the mouse, in the content coordinate system.
UIComponent
 InheritedcontentMouseY : Number
[read-only] Returns the y position of the mouse, in the content coordinate system.
UIComponent
 InheritedcontextMenu : NativeMenu
Specifies the context menu associated with this object.
InteractiveObject
 InheritedcurrentState : String
The current view state of the component.
UIComponent
 InheritedcursorManager : ICursorManager
[read-only] Gets the CursorManager that controls the cursor for this component and its peers.
UIComponent
 Inheriteddata : Object
The item in the data provider this component should render when this component is used as an item renderer or item editor.
ListBase
  dataDescriptor : mx.controls.treeClasses:ITreeDataDescriptor
Returns the current ITreeDataDescriptor.
Tree
  dataProvider : Object
[override] An object that contains the data to be displayed.
Tree
 InheriteddataTipField : String
Name of the field in the data provider items to display as the data tip.
ListBase
 InheriteddataTipFunction : Function
User-supplied function to run on each item to determine its dataTip.
ListBase
 Inheriteddepth : Number
Determines the order in which items inside of containers are rendered.
UIComponent
 Inheriteddescriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.
UIComponent
 InheriteddesignLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual element.
UIComponent
 Inheriteddocument : Object
A reference to the document object associated with this UIComponent.
UIComponent
 InheriteddoubleClickEnabled : Boolean
[override] Specifies whether the UIComponent object receives doubleClick events.
UIComponent
 InheriteddragEnabled : Boolean
A flag that indicates whether you can drag items out of this control and drop them on other controls.
ListBase
  dragMoveEnabled : Boolean
[override] Indicates that items can be moved instead of just copied from the Tree control as part of a drag-and-drop operation.
Tree
 InheriteddropEnabled : Boolean
A flag that indicates whether dragged items can be dropped onto the control.
ListBase
 InheriteddropTarget : DisplayObject
[read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.
Sprite
 Inheritededitable : Boolean
A flag that indicates whether or not the user can edit items in the data provider.
List
 InheritededitedItemPosition : Object
The column and row index of the item renderer for the data provider item being edited, if any.
List
 InheritededitedItemRenderer : IListItemRenderer
[read-only] A reference to the item renderer in the DataGrid control whose item is currently being edited.
List
 InheritededitorDataField : String = "text"
The name of the property of the item editor that contains the new data for the list item.
List
 InheritededitorHeightOffset : Number = 0
The height of the item editor, in pixels, relative to the size of the item renderer.
List
 InheritededitorUsesEnterKey : Boolean = false
A flag that indicates whether the item editor uses Enter key.
List
 InheritededitorWidthOffset : Number = 0
The width of the item editor, in pixels, relative to the size of the item renderer.
List
 InheritededitorXOffset : Number = 0
The x location of the upper-left corner of the item editor, in pixels, relative to the upper-left corner of the item.
List
 InheritededitorYOffset : Number = 0
The y location of the upper-left corner of the item editor, in pixels, relative to the upper-left corner of the item.
List
 Inheritedenabled : Boolean
Whether the component can accept user interaction.
UIComponent
 InheritedenableIME : Boolean
[read-only] A flag that indicates whether the IME should be enabled when the component receives focus.
List
 InheritederrorString : String
The text that displayed by a component's error tip when a component is monitored by a Validator and validation fails.
UIComponent
 InheritedexplicitHeight : Number
Number that specifies the explicit height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMinHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMinWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitWidth : Number
Number that specifies the explicit width of the component, in pixels, in the component's coordinates.
UIComponent
 Inheritedfilters : Array
An indexed array that contains each filter object currently associated with the display object.
DisplayObject
  firstVisibleItem : Object
The item that is currently displayed in the top row of the tree.
Tree
 InheritedflexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
UIComponent
 InheritedfocusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
UIComponent
 InheritedfocusManager : IFocusManager
Gets the FocusManager that controls focus for this component and its peers.
UIComponent
 InheritedfocusPane : Sprite
The focus pane associated with this object.
UIComponent
 InheritedfocusRect : Object
Specifies whether this object displays a focus rectangle.
InteractiveObject
 Inheritedgraphics : Graphics
[read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.
Sprite
 InheritedhasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus.
UIComponent
 InheritedhasLayoutMatrix3D : Boolean
[read-only] Contians true if the element has 3D Matrix.
UIComponent
  hasRoot : Boolean
[read-only] Indicates that the current dataProvider has a root item; for example, a single top node in a hierarchical structure.
Tree
 Inheritedheight : Number
[override] Number that specifies the height of the component, in pixels, in the parent's coordinates.
UIComponent
 InheritedhitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
Sprite
 InheritedhorizontalCenter : Object
The horizontal distance in pixels from the center of the component to the center of the anchor target's content area.
UIComponent
 InheritedhorizontalScrollPolicy : String
A property that indicates whether the horizontal scroll bar is always on, always off, or automatically changes based on the parameters passed to the setScrollBarProperties() method.
ScrollControlBase
 InheritedhorizontalScrollPosition : Number
The offset into the content from the left edge.
ScrollControlBase
 InheritediconField : String
The name of the field in the data provider object that determines what to display as the icon.
ListBase
 InheritediconFunction : Function
A user-supplied function to run on each item to determine its icon.
ListBase
 Inheritedid : String
ID of the component.
UIComponent
 InheritedimeMode : String
Specifies the IME (input method editor) mode.
List
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
UIComponent
 InheritedinheritingStyles : Object
The beginning of this component's chain of inheriting styles.
UIComponent
 Inheritedinitialized : Boolean
A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required).
UIComponent
 InheritedinstanceIndex : int
[read-only] The index of a repeated component.
UIComponent
 InheritedinstanceIndices : Array
An Array containing the indices required to reference this UIComponent object from its parent document.
UIComponent
 Inheritedis3D : Boolean
[read-only] Contains true when the element is in 3D.
UIComponent
 InheritedisDocument : Boolean
[read-only] Contains true if this UIComponent instance is a document object.
UIComponent
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
UIComponent
 InheriteditemEditor : IFactory
The class factory for the item editor to use for the control, if the editable property is set to true.
List
 InheriteditemEditorInstance : IListItemRenderer
A reference to the currently active instance of the item editor, if it exists.
List
  itemIcons : Object
An object that specifies the icons for the items.
Tree
 InheriteditemRenderer : IFactory
The custom item renderer for the control.
ListBase
 InheritedlabelField : String
The name of the field in the data provider items to display as the label.
ListBase
 InheritedlabelFunction : Function
A user-supplied function to run on each item to determine its label.
ListBase
 InheritedlayoutMatrix3D : Matrix3D
[write-only] The transform matrix that is used to calculate a component's layout relative to its siblings.
UIComponent
 Inheritedleft : Object
The horizontal distance in pixels from the left edge of the component to the anchor target's left edge.
UIComponent
 InheritedlistData : BaseListData
When a component is used as a drop-in item renderer or drop-in item editor, Flex initializes the listData property of the component with the additional data from the list control.
ListBase
 InheritedliveScrolling : Boolean = true
A flag that indicates whether scrolling is live as the scrollbar thumb is moved or the view is not updated until the thumb is released.
ScrollControlBase
 InheritedloaderInfo : LoaderInfo
[read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.
DisplayObject
 InheritedmaintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the middle of its bounding box.
UIComponent
 Inheritedmask : DisplayObject
The calling display object is masked by the specified mask object.
DisplayObject
 InheritedmaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
  maxHorizontalScrollPosition : Number
[override] The maximum value for the maxHorizontalScrollPosition property for the Tree control.
Tree
 InheritedmaxVerticalScrollPosition : Number
The maximum value for the verticalScrollPosition property.
ScrollControlBase
 InheritedmaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmeasuredHeight : Number
The default height of the component, in pixels.
UIComponent
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
UIComponent
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
UIComponent
 InheritedmeasuredWidth : Number
The default width of the component, in pixels.
UIComponent
 InheritedmenuSelectionMode : Boolean = false
A flag that indicates whether menu-style selection should be used.
ListBase
 InheritedminHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedminWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmoduleFactory : IFlexModuleFactory
A module factory is used as context for using embedded fonts and for finding the style manager that controls the styles for this component.
UIComponent
 InheritedmouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled.
DisplayObjectContainer
 InheritedmouseEnabled : Boolean
Specifies whether this object receives mouse messages.
InteractiveObject
 InheritedmouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
UIComponent
 InheritedmouseX : Number
[read-only] Indicates the x coordinate of the mouse position, in pixels.
DisplayObject
 InheritedmouseY : Number
[read-only] Indicates the y coordinate of the mouse position, in pixels.
DisplayObject
 Inheritedname : String
Indicates the instance name of the DisplayObject.
DisplayObject
 InheritednestLevel : int
Depth of this object in the containment hierarchy.
UIComponent
 InheritednonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
UIComponent
 InheritednullItemRenderer : IFactory
The custom item renderer for the control.
ListBase
 InheritednumAutomationChildren : int
[read-only] The number of automation children this container has.
UIComponent
 InheritednumChildren : int
[read-only] Returns the number of children of this object.
DisplayObjectContainer
 InheritedoffscreenExtraRowsOrColumns : int
The target number of extra rows or columns of item renderers to be used in the layout of the control.
ListBase
 InheritedopaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
DisplayObject
  openItems : Object
The items that have been opened or set opened.
Tree
 Inheritedowner : DisplayObjectContainer
The owner of this IVisualElement object.
UIComponent
 Inheritedparent : DisplayObjectContainer
[override] [read-only] The parent container or component for this component.
UIComponent
 InheritedparentApplication : Object
[read-only] A reference to the Application object that contains this UIComponent instance.
UIComponent
 InheritedparentDocument : Object
[read-only] A reference to the parent document object for this UIComponent.
UIComponent
 InheritedpercentHeight : Number
Number that specifies the height of a component as a percentage of its parent's size.
UIComponent
 InheritedpercentWidth : Number
Number that specifies the width of a component as a percentage of its parent's size.
UIComponent
 InheritedpostLayoutTransformOffsets : mx.geom:TransformOffsets
Defines a set of adjustments that can be applied to the object's transform in a way that is invisible to its parent's layout.
UIComponent
 InheritedprocessedDescriptors : Boolean
Set to true after immediate or deferred child creation, depending on which one happens.
UIComponent
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedrendererIsEditor : Boolean = false
Specifies whether the item renderer is also an item editor.
List
 Inheritedrepeater : IRepeater
[read-only] A reference to the Repeater object in the parent document that produced this UIComponent.
UIComponent
 InheritedrepeaterIndex : int
[read-only] The index of the item in the data provider of the Repeater that produced this UIComponent.
UIComponent
 InheritedrepeaterIndices : Array
An Array containing the indices of the items in the data provider of the Repeaters in the parent document that produced this UIComponent.
UIComponent
 Inheritedrepeaters : Array
An Array containing references to the Repeater objects in the parent document that produced this UIComponent.
UIComponent
 Inheritedright : Object
The horizontal distance in pixels from the right edge of the component to the anchor target's right edge.
UIComponent
 Inheritedroot : DisplayObject
[read-only] For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file.
DisplayObject
 Inheritedrotation : Number
[override] Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
UIComponent
 InheritedrotationX : Number
[override] Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 InheritedrotationY : Number
[override] Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 InheritedrotationZ : Number
[override] Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 InheritedrowCount : int
Number of rows to be displayed.
ListBase
 InheritedrowHeight : Number
The height of the rows in pixels.
ListBase
 Inheritedscale9Grid : Rectangle
The current scaling grid that is in effect.
DisplayObject
 InheritedscaleX : Number
[override] Number that specifies the horizontal scaling factor.
UIComponent
 InheritedscaleY : Number
[override] Number that specifies the vertical scaling factor.
UIComponent
 InheritedscaleZ : Number
[override] Number that specifies the scaling factor along the z axis.
UIComponent
 Inheritedscreen : Rectangle
[read-only] Returns an object that contains the size and position of the base drawing surface for this object.
UIComponent
 InheritedscrollRect : Rectangle
The scroll rectangle bounds of the display object.
DisplayObject
 InheritedscrollTipFunction : Function
A function that computes the string to be displayed as the ScrollTip.
ScrollControlBase
 Inheritedselectable : Boolean
A flag that indicates whether the list shows selected items as selected.
ListBase
 InheritedselectedIndex : int
The index in the data provider of the selected item.
ListBase
 InheritedselectedIndices : Array
An array of indices in the data provider of the selected items.
ListBase
 InheritedselectedItem : Object
A reference to the selected item in the data provider.
ListBase
 InheritedselectedItems : Array
An array of references to the selected items in the data provider.
ListBase
 InheritedselectedItemsCompareFunction : Function
A function used to compare items in the selectedItems property against items in the data provider.
ListBase
 InheritedshowDataTips : Boolean
A flag that indicates whether dataTips are displayed for text in the rows.
ListBase
 InheritedshowInAutomationHierarchy : Boolean
A flag that determines if an automation object shows in the automation hierarchy.
UIComponent
  showRoot : Boolean
Sets the visibility of the root item.
Tree
 InheritedshowScrollTips : Boolean = false
A flag that indicates whether a tooltip should appear near the scroll thumb when it is being dragged.
ScrollControlBase
 InheritedsoundTransform : flash.media:SoundTransform
Controls sound within this sprite.
Sprite
 Inheritedstage : Stage
[read-only] The Stage of the display object.
DisplayObject
 Inheritedstates : Array
The view states that are defined for this component.
UIComponent
 InheritedstyleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
UIComponent
 InheritedstyleManager : IStyleManager2
[read-only] Returns the StyleManager instance used by this component.
UIComponent
 InheritedstyleName : Object
The class style used by this component.
UIComponent
 InheritedstyleParent : IAdvancedStyleClient
[read-only] A component's parent is used to evaluate descendant selectors.
UIComponent
 InheritedsystemManager : ISystemManager
Returns the SystemManager object used by this component.
UIComponent
 InheritedtabChildren : Boolean
Determines whether the children of the object are tab enabled.
DisplayObjectContainer
 InheritedtabEnabled : Boolean
Specifies whether this object is in the tab order.
InteractiveObject
 InheritedtabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus via the TAB key This is similar to the tabEnabled property used by the Flash Player. This is usually true for components that handle keyboard input, but some components in controlbars have them set to false because they should not steal focus from another component like an editor.
UIComponent
 InheritedtabIndex : int
Specifies the tab ordering of objects in a SWF file.
InteractiveObject
 InheritedtextSnapshot : flash.text:TextSnapshot
[read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.
DisplayObjectContainer
 InheritedtoolTip : String
Text to display in the ToolTip.
UIComponent
 Inheritedtop : Object
The vertical distance in pixels from the top edge of the component to the anchor target's top edge.
UIComponent
 Inheritedtransform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
DisplayObject
 InheritedtransformX : Number
Sets the x coordinate for the transform center of the component.
UIComponent
 InheritedtransformY : Number
Sets the y coordinate for the transform center of the component.
UIComponent
 InheritedtransformZ : Number
Sets the z coordinate for the transform center of the component.
UIComponent
 Inheritedtransitions : Array
An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs.
UIComponent
 InheritedtweeningProperties : Array
Array of properties that are currently being tweened on this object.
UIComponent
 Inheriteduid : String
A unique identifier for the object.
UIComponent
 InheritedupdateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases of layout validation (provided that any were required).
UIComponent
 InheriteduseHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the mouse rolls over a sprite in which the buttonMode property is set to true.
Sprite
 InheritedvalidationSubField : String
Used by a validator to associate a subfield with this component.
UIComponent
 Inheritedvalue : Object
[read-only] The selected item, or the data or label field of the selected item.
ListBase
 InheritedvariableRowHeight : Boolean
A flag that indicates whether the individual rows can have different height.
ListBase
 InheritedverticalCenter : Object
The vertical distance in pixels from the center of the component to the center of the anchor target's content area.
UIComponent
 InheritedverticalScrollPolicy : String
A property that indicates whether the vertical scroll bar is always on, always off, or automatically changes based on the parameters passed to the setScrollBarProperties() method.
ScrollControlBase
 InheritedverticalScrollPosition : Number
The offset into the content from the top edge.
ScrollControlBase
 InheritedviewMetrics : EdgeMetrics
[read-only] An EdgeMetrics object taking into account the scroll bars, if visible.
ScrollControlBase
 Inheritedvisible : Boolean
[override] Whether or not the display object is visible.
UIComponent
 Inheritedwidth : Number
[override] Number that specifies the width of the component, in pixels, in the parent's coordinates.
UIComponent
 InheritedwordWrap : Boolean
A flag that indicates whether text in the row should be word wrapped.
ListBase
 Inheritedx : Number
[override] Number that specifies the component's horizontal position, in pixels, within its parent container.
UIComponent
 Inheritedy : Number
[override] Number that specifies the component's vertical position, in pixels, within its parent container.
UIComponent
 Inheritedz : Number
[override] Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.
UIComponent
Protected Properties
 PropertyDefined By
 InheritedactualCollection : ICollectionView
A copy of the value normally stored in collection used while running data changes effects.
ListBase
 InheritedactualIterator : IViewCursor
A copy of the value normally stored in iterator used while running data changes effects.
ListBase
 InheritedallowItemSizeChangeNotification : Boolean
[write-only] If false, renderers cannot invalidate size of List.
ListBase
 InheritedanchorBookmark : CursorBookmark
A bookmark to the item that is the anchor.
ListBase
 InheritedanchorIndex : int = -1
The offset of the item in the data provider that is the selection anchor point.
ListBase
 Inheritedborder : IFlexDisplayObject
The border object.
ScrollControlBase
 InheritedcachedItemsChangeEffect : IEffect = null
The effect that plays when changes occur in the data provider for the control, set through the itemsChangeEffect style.
ListBase
 InheritedcaretBookmark : CursorBookmark
A bookmark to the item under the caret.
ListBase
 InheritedcaretIndex : int = -1
The offset of the item in the data provider that is the selection caret point.
ListBase
 InheritedcaretIndicator : Sprite
The DisplayObject that contains the graphics that indicate which renderer is the caret.
ListBase
 InheritedcaretItemRenderer : IListItemRenderer
The renderer for the item under the caret.
ListBase
 InheritedcaretUID : String
The UID of the item under the caret.
ListBase
 Inheritedcollection : ICollectionView
An ICollectionView that represents the data provider.
ListBase
 InheritedcurrentCSSState : String
[read-only] The state to be used when matching CSS pseudo-selectors.
UIComponent
 InheriteddataEffectCompleted : Boolean = false
A flag that indicates that the a data change effect has just completed.
ListBase
 InheriteddataItemWrappersByRenderer : Dictionary
A dictionary mapping item renderers to the ItemWrappers used to supply their data.
ListBase
 InheriteddefaultColumnCount : int = 4
The default number of columns to display.
ListBase
 InheriteddefaultRowCount : int = 4
The default number of rows to display.
ListBase
 InheriteddragImage : IUIComponent
[read-only] Gets an instance of a class that displays the visuals during a drag and drop operation.
ListBase
 InheriteddragImageOffsets : Point
[read-only] Gets the offset of the drag image for drag and drop.
ListBase
 InheritedexplicitColumnCount : int = -1
The column count requested by explicitly setting the columnCount property.
ListBase
 InheritedexplicitColumnWidth : Number
The column width requested by explicitly setting the columnWidth.
ListBase
 InheritedexplicitRowCount : int = -1
The row count requested by explicitly setting rowCount.
ListBase
 InheritedexplicitRowHeight : Number
The row height requested by explicitly setting rowHeight.
ListBase
 InheritedfactoryMap : Dictionary
A map of item renderers by factory.
ListBase
 InheritedfreeItemRenderers : Array
A stack of unused item renderers.
ListBase
 InheritedfreeItemRenderersByFactory : Dictionary
A map of free item renderers by factory.
ListBase
 InheritedhasComplexLayoutMatrix : Boolean
[read-only] Returns true if the UIComponent has any non-translation (x,y) transform properties.
UIComponent
 InheritedhighlightIndicator : Sprite
The DisplayObject that contains the graphics that indicates which renderer is highlighted.
ListBase
 InheritedhighlightItemRenderer : IListItemRenderer
The renderer that is currently rolled over or under the caret.
ListBase
 InheritedhighlightUID : String
The UID of the item that is current rolled over or under the caret.
ListBase
 InheritedhorizontalScrollBar : ScrollBar
The horizontal scroll bar.
ScrollControlBase
 InheriteditemsNeedMeasurement : Boolean = true
A flag that indicates whether the columnWidth and rowHeight properties need to be calculated.
ListBase
 InheriteditemsSizeChanged : Boolean = false
A flag that indicates that the size of the renderers may have changed.
ListBase
 Inheritediterator : IViewCursor
The main IViewCursor used to fetch items from the data provider and pass the items to the renderers.
ListBase
 InheritediteratorValid : Boolean = true
A flag that indicates that a page fault as occurred and that the iterator's position is not valid (not positioned at the topmost item being displayed).
ListBase
 InheritedkeySelectionPending : Boolean = false
A flag that indicates if keyboard selection was interrupted by a page fault.
ListBase
 InheritedlastDropIndex : int
The most recently calculated index where the drag item should be added to the drop target.
ListBase
 InheritedlastSeekPending : ListBaseSeekPending
The most recent seek that caused a page fault.
ListBase
 InheritedlistContent : ListBaseContentHolder
An internal display object that parents all of the item renderers, selection and highlighting indicators and other supporting graphics.
ListBase
 InheritedlistContentStyleFilters : Object
[read-only] The set of styles to pass from the ListBase to the listContent.
ListBase
 InheritedlistItems : Array
[read-only] An Array of Arrays that contains the itemRenderer instances that render each data provider item.
ListBase
 InheritedmaskShape : Shape
The mask.
ScrollControlBase
 InheritedmeasuringObjects : Dictionary
cache of measuring objects by factory
List
 InheritedmodifiedCollectionView : ModifiedCollectionView
The collection view that temporarily preserves previous data provider state to facilitate running data change effects.
ListBase
 InheritedoffscreenExtraColumns : int = 0
The target number of extra columns of item renderers used in the layout of the control.
ListBase
 InheritedoffscreenExtraColumnsLeft : int = 0
The number of offscreen columns currently to the left of the leftmost visible column.
ListBase
 InheritedoffscreenExtraColumnsRight : int = 0
The number of offscreen columns currently to the right of the right visible column.
ListBase
 InheritedoffscreenExtraRows : int = 0
The target number of extra rows of item renderers to be used in the layout of the control.
ListBase
 InheritedoffscreenExtraRowsBottom : int = 0
The number of offscreen rows currently below the bottom visible item renderer.
ListBase
 InheritedoffscreenExtraRowsOrColumnsChanged : Boolean = false
A flag indicating that the number of offscreen rows or columns may have changed.
ListBase
 InheritedoffscreenExtraRowsTop : int = 0
The number of offscreen rows currently above the topmost visible row.
ListBase
 InheritedrendererChanged : Boolean = false
A flag that indicates that the renderer changed.
ListBase
 InheritedreservedItemRenderers : Object
A hash map of currently unused item renderers that may be used again in the near future.
ListBase
 InheritedresourceManager : IResourceManager
[read-only] A reference to the object which manages all of the application's localized resources.
UIComponent
 InheritedrowInfo : Array
[read-only] An array of ListRowInfo objects that cache row heights and other tracking information for the rows in listItems.
ListBase
 InheritedrowMap : Object
A hash map of item renderers to their respective ListRowInfo object.
ListBase
 InheritedrunDataEffectNextUpdate : Boolean = false
A flag that indicates if a data effect should be initiated the next time the display is updated.
ListBase
 InheritedrunningDataEffect : Boolean = false
A flag indicating if a data change effect is currently running.
ListBase
 InheritedscrollAreaChanged : Boolean
A flag that the scrolling area changed due to the appearance or disappearance of scrollbars.
ScrollControlBase
 InheritedselectedData : Object
A hash table of ListBaseSelectionData objects that track which items are currently selected.
ListBase
 InheritedselectionIndicators : Object
A hash table of selection indicators.
ListBase
 InheritedselectionLayer : Sprite
The layer in listContent where all selection and highlight indicators are drawn.
ListBase
 InheritedselectionTweens : Object
A hash table of selection tweens.
ListBase
 InheritedshowCaret : Boolean
A flag that indicates whether to show caret.
ListBase
 InheritedunconstrainedRenderers : Dictionary
A hash map of item renderers that are not subject to the layout algorithms of the list.
ListBase
 InheritedunscaledHeight : Number
[read-only] A convenience method for determining the unscaled height of the component.
UIComponent
 InheritedunscaledWidth : Number
[read-only] A convenience method for determining the unscaled width of the component All of a component's drawing and child layout should be done within a bounding rectangle of this width, which is also passed as an argument to updateDisplayList().
UIComponent
 InheritedverticalScrollBar : ScrollBar
The vertical scroll bar.
ScrollControlBase
 InheritedvisibleData : Object
[read-only] A hash table of data provider item renderers currently in view.
ListBase
 InheritedwordWrapChanged : Boolean = false
A flag that indicates whether the value of the wordWrap property has changed since the last time the display list was updated.
ListBase
Public Methods
 MethodDefined By
  
Constructor.
Tree
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Adds an item renderer if a data change effect is running.
ListBase
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
 Inherited
Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point.
DisplayObjectContainer
 Inherited
Returns the index where the dropped items should be added to the drop target.
ListBase
 Inherited
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
UIComponent
 Inherited
Deletes a style property from this component instance.
UIComponent
 Inherited
Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
DisplayObjectContainer
 Inherited
Converts a Point object from content coordinates to global coordinates.
UIComponent
 Inherited
Converts a Point object from content to local coordinates.
UIComponent
 Inherited
Returns a set of properties that identify the child within this container.
UIComponent
 Inherited
Returns a set of properties that identify the child within this container.
UIComponent
 Inherited
createItemEditor(colIndex:int, rowIndex:int):void
Creates the item editor for the item renderer at the editedItemPosition using the editor specified by the itemEditor property.
List
 Inherited
[override] Get the appropriate renderer, using the default renderer if none is specified.
List
 Inherited
Creates an id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Deletes the id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Closes an item editor that is currently open on an item.
List
 Inherited
Returns a UITextFormat object corresponding to the text styles for this UIComponent.
UIComponent
 Inherited
[override] Dispatches an event into the event flow.
UIComponent
 Inherited
Shows or hides the focus indicator around this component.
UIComponent
 Inherited
drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object.
UIComponent
 Inherited
Called by the effect instance when it stops playing on the component.
UIComponent
 Inherited
Called by the effect instance when it starts playing on the component.
UIComponent
 Inherited
Ends all currently playing effects on the component.
UIComponent
 Inherited
executeBindings(recurse:Boolean = false):void
Executes all the bindings for which the UIComponent object is the destination.
UIComponent
  
Opens or closes all the tree items below the specified item.
Tree
  
expandItem(item:Object, open:Boolean, animate:Boolean = false, dispatchEvent:Boolean = false, cause:Event = null):void
Opens or closes a branch item.
Tree
 Inherited
Finds an item in the list based on a String, and moves the selection to it.
ListBase
 Inherited
Called after printing is complete.
UIComponent
 Inherited
Provides the automation object at the specified index.
UIComponent
 Inherited
Provides the automation object list .
UIComponent
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.
DisplayObject
 Inherited
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size.
UIComponent
 Inherited
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size.
UIComponent
 Inherited
Returns the child display object instance that exists at the specified index.
DisplayObjectContainer
 Inherited
Returns the child display object that exists with the specified name.
DisplayObjectContainer
 Inherited
Returns the index position of a child DisplayObject instance.
DisplayObjectContainer
 Inherited
Finds the type selectors for this UIComponent instance.
UIComponent
 Inherited
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as getting the constraint style for this component.
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured height
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured width
UIComponent
 Inherited
Gets the object that currently has focus.
UIComponent
 Inherited
Return the appropriate factory, using the default factory if none specified.
ListBase
 Inherited
getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height.
UIComponent
 Inherited
getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width.
UIComponent
 Inherited
getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen.
UIComponent
 Inherited
getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen.
UIComponent
 Inherited
Returns the transform matrix that is used to calculate the component's layout relative to its siblings.
UIComponent
 Inherited
Returns the layout transform Matrix3D for this element.
UIComponent
 Inherited
getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height.
UIComponent
 Inherited
getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width.
UIComponent
 Inherited
getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height.
UIComponent
 Inherited
getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width.
UIComponent
 Inherited
Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.
DisplayObjectContainer
  
Returns the known parent of a child item.
Tree
 Inherited
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height.
UIComponent
 Inherited
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width.
UIComponent
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the targetCoordinateSpace parameter, excluding any strokes on shapes.
DisplayObject
 Inherited
getRendererSemanticValue(target:Object, semanticProperty:String):Object
Returns true or false to indicates whether the effect should play on the target.
ListBase
 Inherited
getRepeaterItem(whichRepeater:int = -1):Object
Returns the item in the dataProvider that was used by the specified Repeater to produce this Repeater, or null if this Repeater isn't repeated.
UIComponent
 Inherited
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this component's style lookup chain.
UIComponent
 Inherited
Converts a Point object from global to content coordinates.
UIComponent
 Inherited
Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.
DisplayObject
 Inherited
Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.
DisplayObject
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Determines whether the specified state has been defined on this UIComponent.
UIComponent
 Inherited
Hides the drop indicator under the mouse pointer that indicates that a drag and drop operation is allowed.
ListBase
 Inherited
Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object.
DisplayObject
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.
DisplayObject
 Inherited
Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient.
UIComponent
 Inherited
Get an item renderer for the index of an item in the data provider, if one exists.
ListBase
 Inherited
indicesToIndex(rowIndex:int, colIndex:int):int
Computes the offset into the data provider of the item at colIndex, rowIndex.
ListBase
 Inherited
Initializes the internal structure of this component.
UIComponent
 Inherited
Initializes various properties which keep track of repeated instances of this component.
UIComponent
 Inherited
Marks a component so that its updateDisplayList() method gets called during a later screen update.
UIComponent
 Inherited
Called by a component's items to indicate that their depth property has changed.
UIComponent
 Inherited
Refresh all rows on the next update.
ListBase
 Inherited
Marks a component so that its commitProperties() method gets called during a later screen update.
UIComponent
 Inherited
Marks a component so that its measure() method gets called during a later screen update.
UIComponent
 Inherited
Determines if the item renderer for a data provider item is editable.
List
 Inherited
Determines if the item renderer for a data provider item is highlighted (is rolled over via the mouse or under the caret due to keyboard navigation).
ListBase
  
Returns true if the specified item branch is open (is showing its children).
Tree
 Inherited
Determines if the item renderer for a data provider item is selectable.
ListBase
 Inherited
Determines if the item renderer for a data provider item is selected.
ListBase
 Inherited
Determines if the item renderer for a data provider item is the item under the caret due to keyboard navigation.
ListBase
 Inherited
Determines if an item is being displayed by a renderer.
ListBase
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Determines whether a renderer contains (or owns) a display object.
ListBase
 Inherited
Returns the index of the item in the data provider of the item being rendered by this item renderer.
ListBase
 Inherited
Returns the dataTip string the renderer would display for the given data object based on the dataTipField and dataTipFunction properties.
ListBase
 Inherited
Returns the class for an icon, if any, for a data item, based on the iconField and iconFunction properties.
ListBase
 Inherited
Returns the item renderer for a given item in the data provider, if there is one.
ListBase
 Inherited
Returns the string the renderer would display for the given data object based on the labelField and labelFunction properties.
ListBase
 Inherited
Converts a three-dimensional point of the three-dimensional display object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
DisplayObject
 Inherited
Converts a Point object from local to content coordinates.
UIComponent
 Inherited
Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.
DisplayObject
 Inherited
Returns true if cssState matches currentCSSState.
UIComponent
 Inherited
Determines whether this instance is the same as, or is a subclass of, the given type.
UIComponent
 Inherited
measureHeightOfItems(index:int = -1, count:int = 0):Number
Measures a set of items from the data provider using the current item renderer and returns the sum of the heights of those items.
ListBase
 Inherited
Measures the specified HTML text, which can contain HTML tags such as <font> and <b>, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent.
UIComponent
 Inherited
Measures the specified text, assuming that it is displayed in a single-line UITextField (or UIFTETextField) using a UITextFormat determined by the styles of this UIComponent.
UIComponent
 Inherited
measureWidthOfItems(index:int = -1, count:int = 0):Number
Measures a set of items from the data provider using the current item renderer and returns the maximum width found.
ListBase
 Inherited
Moves the component to a specified position within its parent.
UIComponent
 Inherited
Propagates style changes to the children.
UIComponent
 Inherited
Returns true if the chain of owner properties points from child to this UIComponent.
UIComponent
 Inherited
Called by Flex when a UIComponent object is added to or removed from a parent.
UIComponent
 Inherited
Prepares an IFlexDisplayObject for printing.
UIComponent
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Builds or rebuilds the CSS style cache for this component and, if the recursive parameter is true, for all descendants of this component as well.
UIComponent
 Inherited
For each effect event, registers the EffectManager as one of the event listeners.
UIComponent
 Inherited
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.
DisplayObjectContainer
 Inherited
Removes an item renderer if a data change effect is running.
ListBase
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Replays the specified event.
UIComponent
 Inherited
Resolves a child by using the id provided.
UIComponent
 Inherited
[static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing().
UIComponent
 Inherited
Ensures that the data provider item at the given index is visible.
ListBase
 Inherited
Sizes the object.
UIComponent
 Inherited
Changes the position of an existing child in the display object container.
DisplayObjectContainer
 Inherited
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as setting the constraint style for this component.
UIComponent
 Inherited
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
UIComponent
 Inherited
Sets the focus to this component.
UIComponent
  
setItemIcon(item:Object, iconID:Class, iconID2:Class):void
Sets the associated icon for the item.
Tree
 Inherited
setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen.
UIComponent
 Inherited
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element.
UIComponent
 Inherited
setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings.
UIComponent
 Inherited
setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.
UIComponent
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
UIComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes.
UIComponent
 Inherited
Displays a drop indicator under the mouse pointer to indicate that a drag and drop operation is allowed and where the items will be dropped.
ListBase
 Inherited
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite.
Sprite
 Inherited
Ends the startDrag() method.
Sprite
 Inherited
Detects changes to style properties.
UIComponent
 Inherited
Flex calls the stylesInitialized() method when the styles for a component are first initialized.
UIComponent
 Inherited
[static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.
UIComponent
 Inherited
Swaps the z-order (front-to-back order) of the two specified child objects.
DisplayObjectContainer
 Inherited
swapChildrenAt(index1:int, index2:int):void
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.
DisplayObjectContainer
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
[override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.
FlexSprite
 Inherited
transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the transform while keeping a particular point, specified in the component's own coordinate space, fixed in the parent's coordinate space.
UIComponent
 Inherited
transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
A utility method to transform a point specified in the local coordinates of this object to its location in the object's parent's coordinates.
UIComponent
 Inherited
Called by an UnconstrainItemAction effect as part of a data change effect if the item renderers corresponding to certain data items need to move outside the normal positions of item renderers in the control.
ListBase
 Inherited
Validates the position and size of children and draws other visuals.
UIComponent
 Inherited
Validate and update the properties and layout of this object and redraw it, if necessary.
UIComponent
 Inherited
Used by layout logic to validate the properties of a component by calling the commitProperties() method.
UIComponent
 Inherited
validateSize(recursive:Boolean = false):void
Validates the measured size of the component If the LayoutManager.invalidateSize() method is called with this ILayoutManagerClient, then the validateSize() method is called when it's time to do measurements.
UIComponent
 Inherited
Handles both the valid and invalid events from a validator assigned to this component.
UIComponent
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient.
UIComponent
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
 Inherited
addDragData(dragSource:Object):void
Adds the selected items to the DragSource object as part of a drag-and-drop operation.
ListBase
 Inherited
Adds a renderer to the recycled renderer list, making it invisible and cleaning up references to it.
ListBase
 Inherited
Add a blank row to the beginning of the arrays that store references to the rows.
ListBase
 Inherited
Adjust the focus rectangle.
UIComponent
 Inherited
adjustListContent(unscaledWidth:Number = -1, unscaledHeight:Number = -1):void
Called from the updateDisplayList() method to adjust the size and position of listContent.
ListBase
 Inherited
Commits the computed matrix built from the combination of the layout matrix and the transform offsets to the flash displayObject's transform.
UIComponent
 Inherited
Sets up the effect for applying the selection indicator.
ListBase
 Inherited
This is an internal method used by the Flex framework to support the Dissolve effect.
UIComponent
 Inherited
Calculates the y position of the drop indicator when performing a drag-and-drop operation.
ListBase
 Inherited
Determines if the call to the measure() method can be skipped.
UIComponent
 Inherited
Performs any final processing after child objects are created.
UIComponent
 Inherited
Clears the caret indicator into the given Sprite.
ListBase
 Inherited
Clears the highlight indicator in the given Sprite.
ListBase
 Inherited
Removes all selection and highlight and caret indicators.
ListBase
 Inherited
clearSelected(transition:Boolean = false):void
Clears the set of selected items and removes all graphics depicting the selected state of those items.
ListBase
 Inherited
Empty the visibleData hash table.
ListBase
 Inherited
Handles CollectionEvents dispatched from the data provider as the data changes.
ListBase
 Inherited
[override] Calculates the column width and row height and number of rows and columns based on whether properties like columnCount columnWidth, rowHeight and rowCount were explicitly set.
ListBase
 Inherited
Configures the ScrollBars based on the number of rows and columns and viewable rows and columns.
ListBase
 Inherited
Makes a deep copy of the object by calling the ObjectUtil.copy() method, and replaces the copy's uid property (if present) with a new value by calling the UIDUtil.createUID() method.
ListBase
 Inherited
copySelectedItems(useDataField:Boolean = true):Array
Copies the selected items in the order that they were selected.
ListBase
 Inherited
Creates the border for this component.
ScrollControlBase
 Inherited
[override] Creates objects that are children of this ListBase; in this case, the listContent object that will hold all the item renderers.
ListBase
 Inherited
Creates a new object using a context based on the embedded font being used.
UIComponent
 Inherited
Creates the object using a given moduleFactory.
UIComponent
 Inherited
destroyRow(i:int, numCols:int):void
Recycle a row that is no longer needed, and remove its indicators.
ListBase
 Inherited
dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void
Helper method for dispatching a PropertyChangeEvent when a property is updated.
UIComponent
  
[override] Handles DragEvent.DRAG_COMPLETE events.
Tree
  
[override] Handles DragEvent.DRAG_DROP events.
Tree
 Inherited
Handles DragEvent.DRAG_ENTER events.
ListBase
 Inherited
Handles DragEvent.DRAG_EXIT events.
ListBase
 Inherited
Handles DragEvent.DRAG_OVER events.
ListBase
 Inherited
Interval function that scrolls the list up or down if the mouse goes above or below the list.
ListBase
 Inherited
The default handler for the dragStart event.
ListBase
 Inherited
drawCaretIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Draws the caret indicator into the given Sprite at the position, width and height specified using the color specified.
ListBase
 Inherited
drawHighlightIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Draws the highlight indicator into the given Sprite at the position, width and height specified using the color specified.
ListBase
 Inherited
drawItem(item:IListItemRenderer, selected:Boolean = false, highlighted:Boolean = false, caret:Boolean = false, transition:Boolean = false):void
Draws the renderer with indicators that it is highlighted, selected, or the caret.
ListBase
 Inherited
drawRowBackground(s:Sprite, rowIndex:int, y:Number, height:Number, color:uint, dataIndex:int):void
Draws a row background at the position and height specified.
List
 Inherited
Draws any alternating row colors, borders and backgrounds for the rows.
ListBase
 Inherited
drawSelectionIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Draws the selection indicator into the given Sprite at the position, width and height specified using the color specified.
ListBase
 Inherited
Stops the editing of an item in the data provider.
List
 Inherited
findKey(eventCode:int):Boolean
Tries to find the next item in the data provider that starts with the character in the eventCode parameter.
ListBase
 Inherited
Cleans up after a data change effect has finished running by restoring the original collection and iterator and removing any cached values used by the effect.
ListBase
 Inherited
Sets selected items based on the caretIndex and anchorIndex properties.
ListBase
 Inherited
The event handler called when a UIComponent object gets focus.
UIComponent
 Inherited
The event handler called when a UIComponent object loses focus.
UIComponent
 Inherited
Retrieves an already-created item renderer not currently in use.
ListBase
 Inherited
The column for the data provider item at the given index.
ListBase
 Inherited
The row for the data provider item at the given index.
ListBase
 Inherited
Initializes the implementation and storage of some of the less frequently used advanced layout features of a component.
UIComponent
 Inherited
Finalizes the initialization of this component.
UIComponent
 Inherited
Initializes this component's accessibility code.
UIComponent
 Inherited
initiateDataChangeEffect(unscaledWidth:Number, unscaledHeight:Number):void
Initiates a data change effect when there have been changes in the data provider.
ListBase
  
Initializes a TreeListData object that is used by the tree item renderer.
Tree
 Inherited
Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true).
UIComponent
 Inherited
Typically overridden by components containing UITextField objects, where the UITextField object gets focus.
UIComponent
 Inherited
Returns true if an item renderer is no longer being positioned by the list's layout algorithm while a data change effect is running as a result of a call to the unconstrainRenderer() method.
ListBase
 Inherited
Returns a Point containing the columnIndex and rowIndex of an item renderer.
ListBase
 Inherited
Determines the UID for a data provider item.
ListBase
 Inherited
The event handler called for a keyDown event.
UIComponent
 Inherited
The event handler called for a keyUp event.
UIComponent
 Inherited
layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void
Responds to size changes by setting the positions and sizes of this control's borders.
ScrollControlBase
 Inherited
Positions the item editor instance at the suggested position with the suggested dimensions.
List
  
[override] Creates a new TreeListData instance and populates the fields based on the input data provider item.
Tree
 Inherited
makeRowsAndColumns(left:Number, top:Number, right:Number, bottom:Number, firstColumn:int, firstRow:int, byCount:Boolean = false, rowsNeeded:uint = 0):Point
Make enough rows and columns to fill the area described by left, top, right, bottom.
ListBase
 Inherited
[override] Calculates the measured width and height of the component based on the rowCount, columnCount, rowHeight and columnWidth properties.
ListBase
 Inherited
Handles MouseEvent.MOUSE_CLICK events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
Handles MouseEvent.MOUSE_DOUBLE_CLICK events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
Handles MouseEvent.MOUSE_DOWN events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
Determines which item renderer is under the mouse.
ListBase
 Inherited
Handles MouseEvent.MOUSE_MOVE events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
Handles MouseEvent.MOUSE_OUT events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
Handles MouseEvent.MOUSE_OVER events from any mouse targets contained in the list, including the renderers.
ListBase
 Inherited
Handles MouseEvent.MOUSE_DOWN events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
[override] Handles mouseWheel events by changing scroll positions.
ListBase
 Inherited
Move the selection and highlight indicators horizontally.
ListBase
 Inherited
moveIndicatorsVertically(uid:String, moveBlockDistance:Number):void
Move the selection and highlight indicators vertically.
ListBase
 Inherited
moveRowVertically(i:int, numCols:int, moveBlockDistance:Number):void
Move a row vertically, and update the rowInfo record.
ListBase
 Inherited
Moves the selection in a horizontal direction in response to the user selecting items using the left arrow or right arrow keys and modifiers such as the Shift and Ctrl keys.
ListBase
 Inherited
Moves the selection in a vertical direction in response to the user selecting items using the up arrow or down arrow Keys and modifiers such as the Shift and Ctrl keys.
ListBase
 Inherited
Prepares the data effect for the collection event.
ListBase
 Inherited
Called by the updateDisplayList() method to remove existing item renderers and clean up various caching structures when the renderer changes.
ListBase
 Inherited
Update the keys in the visibleData hash table.
ListBase
 Inherited
Remove a row from the arrays that store references to the row.
ListBase
 Inherited
Cleans up selection highlights and other associated graphics for a given item in the data provider.
ListBase
 Inherited
This method is called when a UIComponent is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way.
UIComponent
 Inherited
Remove the requested number of rows from the beginning of the arrays that store references to the rows.
ListBase
 Inherited
roomForScrollBar(bar:ScrollBar, unscaledWidth:Number, unscaledHeight:Number):Boolean
Determines if there is enough space in this component to display a given scrollbar.
ScrollControlBase
 Inherited
Default event handler for the scroll event.
ScrollControlBase
 Inherited
scrollHorizontally(pos:int, deltaPos:int, scrollUp:Boolean):void
Adjusts the renderers in response to a change in scroll position.
ListBase
 Inherited
scrollPositionToIndex(horizontalScrollPosition:int, verticalScrollPosition:int):int
Returns the data provider index for the item at the first visible row and column for the given scroll positions.
ListBase
 Inherited
scrollVertically(pos:int, deltaPos:int, scrollUp:Boolean):void
Adjusts the renderers in response to a change in scroll position.
ListBase
 Inherited
The default failure handler when a seek fails due to a page fault.
ListBase
 Inherited
The default result handler when a seek fails due to a page fault.
ListBase
 Inherited
Seek to a position, and handle an ItemPendingError if necessary.
ListBase
 Inherited
selectItem(item:IListItemRenderer, shiftKey:Boolean, ctrlKey:Boolean, transition:Boolean = true):Boolean
Updates the set of selected items given that the item renderer provided was clicked by the mouse and the keyboard modifiers are in the given state.
ListBase
 Inherited
Sets the rowCount property without causing invalidation or setting the explicitRowCount property, which permanently locks in the number of rows.
ListBase
 Inherited
Sets the rowHeight property without causing invalidation or setting of explicitRowHeight which permanently locks in the height of the rows.
ListBase
 Inherited
setScrollBarProperties(totalColumns:int, visibleColumns:int, totalRows:int, visibleRows:int):void
Causes the ScrollControlBase to show or hide scrollbars based on the parameters passed in.
ScrollControlBase
 Inherited
setStretchXY(stretchX:Number, stretchY:Number):void
Specifies a transform stretch factor in the horizontal and vertical direction.
UIComponent
 Inherited
shiftRow(oldIndex:int, newIndex:int, numCols:int, shiftItems:Boolean):void
Shift a row in the arrays that reference rows.
ListBase
 Inherited
stateChanged(oldState:String, newState:String, recursive:Boolean):void
This method is called when a state changes to check whether state-specific styles apply to this component.
UIComponent
 Inherited
sumRowHeights(startRowIdx:int, endRowIdx:int):Number
Determine the height of the requested set of rows.
ListBase
 Inherited
Remove all remaining rows from the end of the arrays that store references to the rows.
ListBase
 Inherited
Find an item renderer based on its UID if it is visible.
ListBase
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
[override] Adds or removes item renderers if the number of displayable items changed.
ListBase
 Inherited
Refreshes all rows.
ListBase
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 InheritedDispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method.UIComponent
 InheritedDispatched when a display object is added to the display list.DisplayObject
 InheritedDispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
 InheritedDispatched when the selectedIndex or selectedItem property changes as a result of user interaction.ListBase
 InheritedDispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 InheritedDispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.InteractiveObject
 InheritedDispatched when the user activates the platform specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.InteractiveObject
 InheritedDispatched when the component has finished its construction, property processing, measuring, layout, and drawing.UIComponent
 InheritedDispatched after the view state has changed.UIComponent
 InheritedDispatched after the currentState property changes, but before the view state changes.UIComponent
 InheritedDispatched when the user activates the platform specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.InteractiveObject
 InheritedDispatched when the data property changes.ListBase
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
 InheritedDispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true.InteractiveObject
 InheritedDispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop.UIComponent
 InheritedDispatched by the drop target when the user releases the mouse over it.UIComponent
 InheritedDispatched by a component when the user moves the mouse over the component during a drag operation.UIComponent
 InheritedDispatched by the component when the user drags outside the component, but does not drop the data onto the target.UIComponent
 InheritedDispatched by a component when the user moves the mouse while over the component during a drag operation.UIComponent
 InheritedDispatched by the drag initiator when starting a drag operation.UIComponent
 InheritedDispatched after an effect ends.UIComponent
 InheritedDispatched just before an effect starts.UIComponent
 InheritedDispatched after an effect is stopped, which happens only by a call to stop() on the effect.UIComponent
 Inherited[broadcast event] Dispatched when the playhead is entering a new frame.DisplayObject
 InheritedDispatched after the component has entered a view state.UIComponent
 Inherited[broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 InheritedDispatched just before the component exits a view state.UIComponent
 InheritedDispatched after a display object gains focus.InteractiveObject
 InheritedDispatched after a display object loses focus.InteractiveObject
 Inherited[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 InheritedDispatched when an object's state changes from visible to invisible.UIComponent
 InheritedDispatched when the component has finished its construction and has all initialization properties set.UIComponent
 InheritedDispatched when a component is monitored by a Validator and the validation failed.UIComponent
 InheritedDispatched when the user clicks on an item in the control.ListBase
  Dispatched when a branch is closed or collapsed.Tree
 InheritedDispatched when the user double-clicks on an item in the control.ListBase
 InheritedDispatched when the editedItemPosition property is set and the item can be edited.List
 InheritedDispatched when the user releases the mouse button while over an item, tabs to the List or within the List, or in any other way attempts to edit an item.List
 InheritedDispatched when an item editing session is ending for any reason.List
 InheritedDispatched when an item renderer gets focus, which can occur if the user clicks on an item in the List control or navigates to the item using a keyboard.List
 InheritedDispatched when an item renderer loses the focus, which can occur if the user clicks another item in the List control or outside the list, or uses the keyboard to navigate to another item in the List control or outside the List control.List
  Dispatched when a branch is opened or expanded.Tree
  Dispatched when a branch open or close is initiated.Tree
 InheritedDispatched when the user rolls the mouse pointer out of an item in the control.ListBase
 InheritedDispatched when the user rolls the mouse pointer over an item in the control.ListBase
 InheritedDispatched when the user presses a key.InteractiveObject
 InheritedDispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 InheritedDispatched when the user releases a key.InteractiveObject
 InheritedDispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched from a component opened using the PopUpManager when the user clicks outside it.UIComponent
 InheritedDispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 InheritedDispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 InheritedDispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.UIComponent
 InheritedDispatched when the object has moved.UIComponent
 InheritedDispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 InheritedDispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop().InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject continually while a drag gesture remains within its boundary.InteractiveObject
 InheritedDispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched when the user activates the platform specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.InteractiveObject
 InheritedDispatched at the beginning of the component initialization sequence.UIComponent
 InheritedDispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method.UIComponent
 InheritedDispatched when a display object is about to be removed from the display list.DisplayObject
 InheritedDispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited[broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
 InheritedDispatched when the component is resized.UIComponent
 InheritedDispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the content is scrolled.ScrollControlBase
 InheritedDispatched when the user activates the platform specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu.InteractiveObject
 InheritedDispatched when an object's state changes from invisible to visible.UIComponent
 InheritedDispatched when the value of the object's tabChildren flag changes.InteractiveObject
 InheritedDispatched when the object's tabEnabled flag changes.InteractiveObject
 InheritedDispatched when the value of the object's tabIndex property changes.InteractiveObject
 InheritedDispatched when a user enters one or more characters of text.InteractiveObject
 InheritedDispatched by the component when it is time to create a ToolTip.UIComponent
 InheritedDispatched by the component when its ToolTip has been hidden and is to be discarded soon.UIComponent
 InheritedDispatched by the component when its ToolTip is about to be hidden.UIComponent
 InheritedDispatched by the component when its ToolTip is about to be shown.UIComponent
 InheritedDispatched by the component when its ToolTip has been shown.UIComponent
 InheritedDispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.UIComponent
 InheritedDispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).UIComponent
 InheritedDispatched when a component is monitored by a Validator and the validation succeeded.UIComponent
 InheritedDispatched when values are changed programmatically or by user interaction.UIComponent
Styles

Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.

Common Styles
 Style Description Defined By
  
alternatingItemColors
Type: Array Format: Color CSS Inheritance: yes
Colors for rows in an alternating pattern. Value can be an Array of two of more colors. Used only if the backgroundColor property is not specified. The default value is undefined.
Tree
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the top edge of the content area to the control's baseline position.
UIComponent
 InheritedType: Class CSS Inheritance: no
The border skin class of the component.
ScrollControlBase
 InheritedType: String CSS Inheritance: no
Bounding box style.
ScrollControlBase
 InheritedType: String CSS Inheritance: no
The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area.
UIComponent
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of text in the component, including the component label.
ScrollControlBase
  
defaultLeafIcon
Type: Class Format: EmbeddedFile CSS Inheritance: no
Specifies the default icon for a leaf item. In MXML, you can use the following syntax to set this property: defaultLeafIcon="@Embed(source='c.jpg');" The default value is the "TreeNodeIcon" symbol in the Assets.swf file.
Tree
  
depthColors
Type: Array Format: Color CSS Inheritance: yes
Array of colors used in the Tree control, in descending order. The default value is undefined.
Tree
 InheritedType: String CSS Inheritance: yes
The directionality of the text displayed by the component.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of text in the component if it is disabled.
ScrollControlBase
  
disclosureClosedIcon
Type: Class Format: EmbeddedFile CSS Inheritance: no
Specifies the icon that is displayed next to a parent item that is closed so that its children are not displayed (the subtree is collapsed). The default value is the "TreeDisclosureClosed" symbol in the Assets.swf file.
Tree
  
disclosureOpenIcon
Type: Class Format: EmbeddedFile CSS Inheritance: no
Specifies the icon that is displayed next to a parent item that is open so that its children are displayed. The default value is the "TreeDisclosureOpen" symbol in the Assets.swf file.
Tree
 InheritedType: Class CSS Inheritance: no
The skin to use to indicate where a dragged item can be dropped.
ListBase
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of the component highlight when validation fails.
UIComponent
 InheritedType: Number CSS Inheritance: no
Specifies the alpha transparency value of the focus skin.
ScrollControlBase
 InheritedType: String CSS Inheritance: no
Blend mode used by the focus rectangle.
UIComponent
 InheritedType: String CSS Inheritance: no
Specifies which corners of the focus rectangle should be rounded.
ScrollControlBase
 InheritedType: Class CSS Inheritance: no
Skin used to draw the focus rectangle.
UIComponent
 InheritedType: Number Format: Length CSS Inheritance: no
Thickness, in pixels, of the focus rectangle outline.
UIComponent
  
folderClosedIcon
Type: Class Format: EmbeddedFile CSS Inheritance: no
Specifies the folder closed icon for a branch item of the tree. In MXML, you can use the following syntax to set this property: folderClosedIcon="@Embed(source='b.jpg');" The default value is the "TreeFolderClosed" symbol in the Assets.swf file.
Tree
  
folderOpenIcon
Type: Class Format: EmbeddedFile CSS Inheritance: no
Specifies the folder open icon for a branch item of the tree. In MXML, you can use the following syntax to set this property: folderOpenIcon="@Embed(source='a.jpg');" The default value is the "TreeFolderOpen" symbol in the Assets.swf file.
Tree
 InheritedType: String CSS Inheritance: yes
Sets the antiAliasType property of internal TextFields.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Name of the font to use.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Sets the gridFitType property of internal TextFields that represent text in Flex controls.
ScrollControlBase
 InheritedType: Number CSS Inheritance: yes
Sets the sharpness property of internal TextFields that represent text in Flex controls.
ScrollControlBase
 InheritedType: Number Format: Length CSS Inheritance: yes
Height of the text, in pixels.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Determines whether the text is italic font.
ScrollControlBase
 InheritedType: Number CSS Inheritance: yes
Sets the thickness property of internal TextFields that represent text in Flex controls.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Determines whether the text is boldface.
ScrollControlBase
 InheritedType: String CSS Inheritance: no
The horizontal distance in pixels from the center of the component's content area to the center of the component.
UIComponent
 InheritedType: String CSS Inheritance: no
Style name for horizontal scrollbar.
ScrollControlBase
  
indentation
Type: Number CSS Inheritance: no
Indentation for each tree level, in pixels. The default value is 17.
Tree
 InheritedType: Boolean CSS Inheritance: yes
A Boolean value that indicates whether kerning is enabled (true) or disabled (false).
ScrollControlBase
 InheritedType: Number Format: Length CSS Inheritance: yes
Additional vertical space between lines of text.
ScrollControlBase
 InheritedType: String CSS Inheritance: no
The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area.
UIComponent
 InheritedType: Number CSS Inheritance: yes
The number of additional pixels to appear between each character.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
The locale of the text displayed by this component.
ScrollControlBase
  
openDuration
Type: Number Format: Time CSS Inheritance: no
Length of an open or close transition, in milliseconds. The default value for the Halo theme is 250. The default value for the Spark theme is 0.
Tree
  
openEasingFunction
Type: Function CSS Inheritance: no
Easing function to control component tweening.

The default value is undefined.

Tree
 InheritedType: Number Format: Length CSS Inheritance: no
The number of pixels between the bottom of the row and the bottom of the renderer in the row.
ListBase
  
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 in the Halo theme is 10 and in the Spark theme is 6.

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.

Tree
  
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 in the Halo theme is 10 and in the Spark theme is 6.

The default value for the ComboBox control is 5.

The default value for the Form container is 16.

Tree
 InheritedType: Number Format: Length CSS Inheritance: no
The number of pixels between the top of the row and the top of the renderer in the row.
ListBase
 InheritedType: String CSS Inheritance: no
The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area.
UIComponent
  
rollOverColor
Type: uint Format: Color CSS Inheritance: yes
Color of the background when the user rolls over the link. The default value for the Halo theme is 0xB2E1FF. The default value for the Spark theme is 0xCEDBEF.
Tree
  
selectionColor
Type: uint Format: Color CSS Inheritance: yes
Color of the background when the user selects the link. The default value for the Halo theme is 0x7FCEFF. The default value for the Spark theme is 0xA8C6EE.
Tree
  
selectionDisabledColor
Type: uint Format: Color CSS Inheritance: yes
Specifies the disabled color of a list item. The default value is 0xDDDDDD.
Tree
 InheritedType: Number Format: Time CSS Inheritance: no
The duration of the selection effect.
ListBase
  
selectionEasingFunction
Type: Function CSS Inheritance: no
Reference to an easingFunction function used for controlling programmatic tweening.

The default value is undefined.

Tree
 InheritedType: String CSS Inheritance: yes
Alignment of text within a container.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Determines whether the text is underlined.
ScrollControlBase
 InheritedType: Class CSS Inheritance: no
The class implementing IUITextField that is used by this component to render text.
ScrollControlBase
 InheritedType: Number Format: Length CSS Inheritance: yes
Offset of first line of text from the left side of the container, in pixels.
ScrollControlBase
  
textRollOverColor
Type: uint Format: Color CSS Inheritance: yes
Color of the text when the user rolls over a row. The default value for the Halo theme is 0x2B333C. The default value for the Spark theme is 0x000000.
Tree
  
textSelectedColor
Type: uint Format: Color CSS Inheritance: yes
Color of the text when the user selects a row. The default value for the Halo theme is 0x2B333C. The default value for the Spark theme is 0x000000.
Tree
 InheritedType: String CSS Inheritance: no
The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area.
UIComponent
 InheritedType: Boolean CSS Inheritance: no
A flag that controls whether items are highlighted as the mouse rolls over them.
ListBase
 InheritedType: String CSS Inheritance: no
The vertical alignment of a renderer in a row.
ListBase
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the center of the component's content area to the center of the component.
UIComponent
 InheritedType: String CSS Inheritance: no
Style name for vertical scrollbar.
ScrollControlBase
Spark Theme Styles
 Style Description Defined By
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Accent color used by component skins.
ScrollControlBase
 InheritedType: Number CSS Inheritance: no Theme: spark
Alpha of the border.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: no Theme: halo, spark
Color of the border.
ScrollControlBase
 InheritedType: Boolean CSS Inheritance: no Theme: spark
Visibility of the border.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
The main color for a component.
ScrollControlBase
 InheritedType: Number CSS Inheritance: yes Theme: spark
The alpha of the content background for this component.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of the content area of the component.
ScrollControlBase
 InheritedType: Boolean CSS Inheritance: no Theme: spark
Boolean property that specifies whether the component has a visible drop shadow.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of focus ring when the component is in focus
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of any symbol of a component.
ScrollControlBase
Halo Theme Styles
 Style Description Defined By
 InheritedType: Number CSS Inheritance: no Theme: halo
Alpha level of the color defined by the backgroundColor property, of the image or SWF file defined by the backgroundImage style.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: no Theme: halo
Background color of a component.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
Background color of the component when it is disabled.
ScrollControlBase
 InheritedType: Object Format: File CSS Inheritance: no Theme: halo
Background image of a component.
ScrollControlBase
 InheritedType: String CSS Inheritance: no Theme: halo
Scales the image specified by backgroundImage to different percentage sizes.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: no Theme: halo, spark
Color of the border.
ScrollControlBase
 InheritedType: String CSS Inheritance: no Theme: halo
Bounding box sides.
ScrollControlBase
 InheritedType: Number Format: Length CSS Inheritance: no Theme: halo
Bounding box thickness.
ScrollControlBase
 InheritedType: Number Format: Length CSS Inheritance: no Theme: halo
Radius of component corners.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
Color of the drop shadow.
ScrollControlBase
 InheritedType: Boolean CSS Inheritance: no Theme: halo
Boolean property that specifies whether the component has a visible drop shadow.
ScrollControlBase
 InheritedType: String CSS Inheritance: no Theme: halo
Direction of the drop shadow.
ScrollControlBase
 InheritedType: Number Format: Length CSS Inheritance: no Theme: halo
Distance of the drop shadow.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
Theme color of a component.
UIComponent
Effects
 Effect Description Defined By
 Inherited Triggering Event: added
Played when the component is added as a child to a Container.
UIComponent
 Inherited Triggering Event: creationComplete
Played when the component is created.
UIComponent
 Inherited Triggering Event: focusIn
Played when the component gains keyboard focus.
UIComponent
 Inherited Triggering Event: focusOut
Played when the component loses keyboard focus.
UIComponent
 Inherited Triggering Event: hide
Played when the component becomes invisible.
UIComponent
 Inherited Triggering Event: itemsChange
The data effect to play when a change occur to the control's data provider. By default, the List control does not use a data effect. For the List control, use an instance of the the DefaultListEffect class to configure the data effect.
List
 Inherited Triggering Event: mouseDown
Played when the user presses the mouse button while over the component.
UIComponent
 Inherited Triggering Event: mouseUp
Played when the user releases the mouse button while over the component.
UIComponent
 Inherited Triggering Event: move
Played when the component is moved.
UIComponent
 Inherited Triggering Event: removed
Played when the component is removed from a Container.
UIComponent
 Inherited Triggering Event: resize
Played when the component is resized.
UIComponent
 Inherited Triggering Event: rollOut
Played when the user rolls the mouse so it is no longer over the component.
UIComponent
 Inherited Triggering Event: rollOver
Played when the user rolls the mouse over the component.
UIComponent
 Inherited Triggering Event: show
Played when the component becomes visible.
UIComponent
Public Constants
 ConstantDefined By
 InheritedDEFAULT_MAX_HEIGHT : Number = 10000
[static] The default value for the maxHeight property.
UIComponent
 InheritedDEFAULT_MAX_WIDTH : Number = 10000
[static] The default value for the maxWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_HEIGHT : Number = 22
[static] The default value for the measuredHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_HEIGHT : Number = 22
[static] The default value for the measuredMinHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_WIDTH : Number = 40
[static] The default value for the measuredMinWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_WIDTH : Number = 160
[static] The default value for the measuredWidth property.
UIComponent
Property Detail

dataDescriptor

property
dataDescriptor:mx.controls.treeClasses:ITreeDataDescriptor

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns the current ITreeDataDescriptor.

The default value is DefaultDataDescriptor.



Implementation
    public function get dataDescriptor():mx.controls.treeClasses:ITreeDataDescriptor
    public function set dataDescriptor(value:mx.controls.treeClasses:ITreeDataDescriptor):void

dataProvider

property 
dataProvider:Object[override]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

An object that contains the data to be displayed. When you assign a value to this property, the Tree class handles the source data object as follows:

  • A String containing valid XML text is converted to an XMLListCollection.
  • An XMLNode is converted to an XMLListCollection.
  • An XMLList is converted to an XMLListCollection.
  • Any object that implements the ICollectionView interface is cast to an ICollectionView.
  • An Array is converted to an ArrayCollection.
  • Any other type object is wrapped in an Array with the object as its sole entry.

The default value is null.

This property can be used as the source for data binding. When this property is modified, it dispatches the collectionChange event.



Implementation
    override public function get dataProvider():Object
    override public function set dataProvider(value:Object):void

dragMoveEnabled

property 
dragMoveEnabled:Boolean[override]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates that items can be moved instead of just copied from the Tree control as part of a drag-and-drop operation.

The default value is true.



Implementation
    override public function get dragMoveEnabled():Boolean
    override public function set dragMoveEnabled(value:Boolean):void

firstVisibleItem

property 
firstVisibleItem:Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The item that is currently displayed in the top row of the tree. Based on how the branches have been opened and closed and scrolled, the top row might hold, for example, the ninth item in the list of currently viewable items which in turn represents some great-grandchild of the root. Setting this property is analogous to setting the verticalScrollPosition of the List control. If the item isn't currently viewable, for example, because it is under a nonexpanded item, setting this property has no effect.

NOTE: In Flex 1.0 this property was typed as XMLNode although it really was either an XMLNode or TreeNode. In 2.0, it is now the generic type Object and will return an object of the same type as the data contained in the dataProvider.

The default value is the first item in the Tree control.

This property can be used as the source for data binding. When this property is modified, it dispatches the firstVisibleItemChanged event.



Implementation
    public function get firstVisibleItem():Object
    public function set firstVisibleItem(value:Object):void

hasRoot

property 
hasRoot:Boolean  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates that the current dataProvider has a root item; for example, a single top node in a hierarchical structure. XML and Object are examples of types that have a root. Lists and arrays do not.



Implementation
    public function get hasRoot():Boolean

See also

itemIcons

property 
public var itemIcons:Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

An object that specifies the icons for the items. Each entry in the object has a field name that is the item UID and a value that is an an object with the following format:

      {iconID: Class, iconID2: Class}
      
The iconID field value is the class of the icon for a closed or leaf item and the iconID2 is the class of the icon for an open item.

This property is intended to allow initialization of item icons. Changes to this array after initialization are not detected automatically. Use the setItemIcon() method to change icons dynamically.

The default value is undefined.

See also

maxHorizontalScrollPosition

property 
maxHorizontalScrollPosition:Number[override]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The maximum value for the maxHorizontalScrollPosition property for the Tree control. Unlike the maxHorizontalScrollPosition property in the List control, this property is modified by the Tree control as items open and close and as items in the tree otherwise become visible or are hidden (for example, by scrolling).

If you set this property to the widest known item in the dataProvider, the Tree control modifies it so that even if that widest item is four levels down in the tree, the user can scroll to see it. As a result, although you read back the same value for the maxHorizontalScrollPosition property that you set, it isn't necessarily the actual value used by the Tree control.

The default value is 0.



Implementation
    override public function get maxHorizontalScrollPosition():Number
    override public function set maxHorizontalScrollPosition(value:Number):void

openItems

property 
openItems:Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The items that have been opened or set opened.

The default value is null.



Implementation
    public function get openItems():Object
    public function set openItems(value:Object):void

showRoot

property 
showRoot:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Sets the visibility of the root item. If the dataProvider data has a root node, and this is set to false, the Tree control does not display the root item. Only the decendants of the root item are displayed. This flag has no effect on non-rooted dataProviders, such as List and Array.

The default value is true.



Implementation
    public function get showRoot():Boolean
    public function set showRoot(value:Boolean):void

See also

Constructor Detail

Tree

()Constructor
public function Tree()

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor.

Method Detail

dragCompleteHandler

()method
override protected function dragCompleteHandler(event:DragEvent):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Handles DragEvent.DRAG_COMPLETE events. This method removes the item from the data provider.

Parameters

event:DragEvent — The DragEvent object.

dragDropHandler

()method 
override protected function dragDropHandler(event:DragEvent):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Handles DragEvent.DRAG_DROP events. This method hides the drop feedback by calling the hideDropFeedback() method.

If the action is a COPY, then this method makes a deep copy of the object by calling the ObjectUtil.copy() method, and replaces the copy's uid property (if present) with a new value by calling the UIDUtil.createUID() method.

Parameters

event:DragEvent — The DragEvent object.

See also

expandChildrenOf

()method 
public function expandChildrenOf(item:Object, open:Boolean):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Opens or closes all the tree items below the specified item. If you set dataProvider and then immediately call expandChildrenOf() you may not see the correct behavior. You should either wait for the component to validate or call the validateNow() method.

Parameters

item:Object — The starting item.
 
open:Boolean — Toggles an open or close operation. Specify true to open the items, and false to close them.

expandItem

()method 
public function expandItem(item:Object, open:Boolean, animate:Boolean = false, dispatchEvent:Boolean = false, cause:Event = null):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Opens or closes a branch item. When a branch item opens, it restores the open and closed states of its child branches if they were already opened. If you set dataProvider and then immediately call expandItem() you may not see the correct behavior. You should either wait for the component to validate or call validateNow().

Parameters

item:Object — Item to affect.
 
open:Boolean — Specify true to open, false to close.
 
animate:Boolean (default = false) — Specify true to animate the transition. (Note: If a branch has over 20 children, it does not animate the first time it opens, for performance reasons.)
 
dispatchEvent:Boolean (default = false) — Controls whether the tree fires an open event after the open animation is complete.
 
cause:Event (default = null) — The event, if any, that initiated the item open action.

getParentItem

()method 
public function getParentItem(item:Object):*

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns the known parent of a child item. This method returns a value only if the item was or is currently visible. Top level items have a parent with the value null.

Parameters

item:Object — item for which to get the parent.

Returns
* — The parent of the item.

initListData

()method 
protected function initListData(item:Object, treeListData:mx.controls.treeClasses:TreeListData):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Initializes a TreeListData object that is used by the tree item renderer.

Parameters

item:Object — The item to be rendered.
 
treeListData:mx.controls.treeClasses:TreeListData — The TreeListDataItem to use in rendering the item.

isItemOpen

()method 
public function isItemOpen(item:Object):Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns true if the specified item branch is open (is showing its children).

Parameters

item:Object — Item to inspect.

Returns
Boolean — True if open, false if not.

makeListData

()method 
override protected function makeListData(data:Object, uid:String, rowNum:int):BaseListData

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Creates a new TreeListData instance and populates the fields based on the input data provider item.

Parameters

data:Object — The data provider item used to populate the ListData.
 
uid:String — The UID for the item.
 
rowNum:int — The index of the item in the data provider.

Returns
BaseListData — A newly constructed ListData object.

setItemIcon

()method 
public function setItemIcon(item:Object, iconID:Class, iconID2:Class):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Sets the associated icon for the item. Calling this method overrides the iconField and iconFunction properties for this item if it is a leaf item. Branch items don't use the iconField and iconFunction properties. They use the folderOpenIcon and folderClosedIcon properties.

Parameters

item:Object — Item to affect.
 
iconID:Class — Linkage ID for the closed (or leaf) icon.
 
iconID2:Class — Linkage ID for the open icon.

Event Detail

itemClose

Event
Event Object Type: mx.events.TreeEvent
property TreeEvent.type = mx.events.TreeEvent.ITEM_CLOSE

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Dispatched when a branch is closed or collapsed.

The TreeEvent.ITEM_CLOSE event type constant indicates that a tree branch closed or collapsed.

The properties of the event object for this event type have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.

PropertyValue
itemRendererThe ListItemRenderer for the node that closed
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
triggerEventIf the node closed in response to a user action, identifies it as a keyboard action or a mouse action.
itemthe Tree item (node) that closed
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeTreeEvent.ITEM_CLOSE

itemOpen

Event  
Event Object Type: mx.events.TreeEvent
property TreeEvent.type = mx.events.TreeEvent.ITEM_OPEN

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Dispatched when a branch is opened or expanded.

The TreeEvent.ITEM_OPEN event type constant indicates that a tree branch opened or expanded.

The properties of the event object for this event type have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.

PropertyValue
itemRendererThe ListItemRenderer for the item (node) that opened
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
triggerEventIf the item (node) opened in response to a user action, identifies it as a keyboard action or a mouse action.
itemthe Tree node that opened.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeTreeEvent.ITEM_OPEN

itemOpening

Event  
Event Object Type: mx.events.TreeEvent
property TreeEvent.type = mx.events.TreeEvent.ITEM_OPENING

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Dispatched when a branch open or close is initiated.

The TreeEvent.ITEM_OPENING event type constant is dispatched immediately before a tree opens or closes.

The properties of the event object for this event type have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.

PropertyValue
animateWhether to animate the opening or closing operation.
bubblesfalse
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dispatchEventWhether to dispatch an ITEM_OPEN or ITEM_CLOSE event after the open or close animation is complete. true
itemRendererThe ListItemRenderer for the item (node) that opened
itemthe Tree node that opened.
openingtrue if the item is opening, false if it is closing.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
triggerEventIf the item opened in response to a user action, identifies it as a keyboard action or a mouse action.
typeTreeEvent.ITEM_OPENING
TreeExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the Halo Tree control. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
        xmlns:s="library://ns.adobe.com/flex/spark"
        xmlns:mx="library://ns.adobe.com/flex/mx">

    <fx:Script>
        <![CDATA[
            [Bindable]
            public var selectedNode:XML;

            // Event handler for the Tree control change event.
            public function treeChanged(evt:Event):void {
                selectedNode = Tree(evt.target).selectedItem as XML;
            }
        ]]>
    </fx:Script>

    <fx:Declarations>
        <fx:XMLList id="treeData">
            <node label="Mail Box">
                <node label="Inbox">
                    <node label="Marketing"/>
                    <node label="Product Management"/>
                    <node label="Personal"/>
                </node>
                <node label="Outbox">
                    <node label="Professional"/>
                    <node label="Personal"/>
                </node>
                <node label="Spam"/>
                <node label="Sent"/>
            </node>
        </fx:XMLList>
    </fx:Declarations>

    <s:Panel title="Halo Tree Control Example"
            width="75%" height="75%"
            horizontalCenter="0" verticalCenter="0">
        <s:VGroup left="10" right="10" top="10" bottom="10">
            <s:Label width="100%" color="blue" 
                    text="Select a node in the Tree control."/>

            <mx:HDividedBox width="100%" height="100%">
                <mx:Tree id="myTree" width="50%" height="100%" labelField="@label"
                        showRoot="false" dataProvider="{treeData}" change="treeChanged(event);"/>
                <s:TextArea height="100%" width="50%"
                        text="Selected Item: {selectedNode.@label}"/>
            </mx:HDividedBox>
        </s:VGroup>
    </s:Panel>

</s:Application>