| Package | mx.controls |
| Class | public class Tree |
| Inheritance | Tree  List ListBase ScrollControlBase UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IIMESupport |
| Subclasses | FileSystemTree |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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:
| Characteristic | Description |
|---|---|
| Default size | Wide 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 size | 0 pixels. |
| Maximum size | 5000 by 5000. |
Show MXML Syntax
Hide MXML SyntaxThe <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
See also
mx.controls.treeClasses.ITreeDataDescriptor
mx.controls.treeClasses.ITreeDataDescriptor2
mx.controls.treeClasses.DefaultDataDescriptor
Creating a Spark item renderer for an MX Tree control
Example: Using an item renderer with an MX Tree control
Example: Using a custom item editor with an MX Tree control
mx.controls.treeClasses.ITreeDataDescriptor2
mx.controls.treeClasses.DefaultDataDescriptor
Creating a Spark item renderer for an MX Tree control
Example: Using an item renderer with an MX Tree control
Example: Using a custom item editor with an MX Tree control
Public Properties
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | |
| allowDragSelection : Boolean = false
A flag that indicates whether drag-selection is enabled. | ListBase | |
| allowMultipleSelection : Boolean
A flag that indicates whether you can allow more than one item to be
selected at the same time. | ListBase | |
| alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality. | UIComponent | |
| automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UIComponent | |
| automationName : String
Name that can be used as an identifier for this object. | UIComponent | |
| automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UIComponent | |
| automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | UIComponent | |
| automationTabularData : Object [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : 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 | |
| automationVisible : Boolean [read-only]
True if this component is visible for automation, false
otherwise. | UIComponent | |
| baseline : Object
The vertical distance in pixels from the anchor target to
the control's baseline position. | UIComponent | |
| baselinePosition : Number [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | UIComponent | |
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | |
| blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | |
| borderMetrics : EdgeMetrics [read-only]
Returns an EdgeMetrics object that has four properties:
left, top, right,
and bottom. | ScrollControlBase | |
| bottom : Object
The vertical distance in pixels from the bottom edge of the component to the
anchor target's bottom edge. | UIComponent | |
| buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the
display object. | DisplayObject | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | |
| className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | |
| columnCount : int
The number of columns to be displayed in a TileList control or items
in a HorizontalList control. | ListBase | |
| columnWidth : Number
The width of the control's columns. | ListBase | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| contentMouseX : Number [read-only]
Returns the x position of the mouse, in the content coordinate system. | UIComponent | |
| contentMouseY : Number [read-only]
Returns the y position of the mouse, in the content coordinate system. | UIComponent | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | |
| currentState : String
The current view state of the component. | UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers. | UIComponent | |
| data : 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 | ||
| dataTipField : String
Name of the field in the data provider items to display as the
data tip. | ListBase | |
| dataTipFunction : Function
User-supplied function to run on each item to determine its dataTip. | ListBase | |
| depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | UIComponent | |
| document : Object
A reference to the document object associated with this UIComponent. | UIComponent | |
| doubleClickEnabled : Boolean [override]
Specifies whether the UIComponent object receives doubleClick events. | UIComponent | |
| dragEnabled : 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 | ||
| dropEnabled : Boolean
A flag that indicates whether dragged items can be dropped onto the
control. | ListBase | |
| dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | |
| editable : Boolean
A flag that indicates whether or not the user can edit
items in the data provider. | List | |
| editedItemPosition : Object
The column and row index of the item renderer for the
data provider item being edited, if any. | List | |
| editedItemRenderer : IListItemRenderer [read-only]
A reference to the item renderer
in the DataGrid control whose item is currently being edited. | List | |
| editorDataField : String = "text"
The name of the property of the item editor that contains the new
data for the list item. | List | |
| editorHeightOffset : Number = 0
The height of the item editor, in pixels, relative to the size of the
item renderer. | List | |
| editorUsesEnterKey : Boolean = false
A flag that indicates whether the item editor uses Enter key. | List | |
| editorWidthOffset : Number = 0
The width of the item editor, in pixels, relative to the size of the
item renderer. | List | |
| editorXOffset : 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 | |
| editorYOffset : 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 | |
| enabled : Boolean
Whether the component can accept user interaction. | UIComponent | |
| enableIME : Boolean [read-only]
A flag that indicates whether the IME should
be enabled when the component receives focus. | List | |
| errorString : String
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | |
| explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | |
| filters : 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 | ||
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | |
| focusPane : Sprite
The focus pane associated with this object. | UIComponent | |
| focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | |
| graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | |
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | |
| hasLayoutMatrix3D : 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 | ||
| height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| horizontalCenter : Object
The horizontal distance in pixels from the center of the component to the
center of the anchor target's content area. | UIComponent | |
| horizontalScrollPolicy : 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 | |
| horizontalScrollPosition : Number
The offset into the content from the left edge. | ScrollControlBase | |
| iconField : String
The name of the field in the data provider object that determines what to
display as the icon. | ListBase | |
| iconFunction : Function
A user-supplied function to run on each item to determine its icon. | ListBase | |
| id : String
ID of the component. | UIComponent | |
| imeMode : String
Specifies the IME (input method editor) mode. | List | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles. | UIComponent | |
| initialized : 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 | |
| instanceIndex : int [read-only]
The index of a repeated component. | UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document. | UIComponent | |
| is3D : Boolean [read-only]
Contains true when the element is in 3D. | UIComponent | |
| isDocument : Boolean [read-only]
Contains true if this UIComponent instance is a document object. | UIComponent | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| itemEditor : IFactory
The class factory for the item editor to use for the control, if the
editable property is set to true. | List | |
| itemEditorInstance : 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 | ||
| itemRenderer : IFactory
The custom item renderer for the control. | ListBase | |
| labelField : String
The name of the field in the data provider items to display as the label. | ListBase | |
| labelFunction : Function
A user-supplied function to run on each item to determine its label. | ListBase | |
| layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | |
| left : Object
The horizontal distance in pixels from the left edge of the component to the
anchor target's left edge. | UIComponent | |
| listData : 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 | |
| liveScrolling : 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 | |
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | |
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | |
| maxHeight : 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 | ||
| maxVerticalScrollPosition : Number
The maximum value for the verticalScrollPosition property. | ScrollControlBase | |
| maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels. | UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels. | UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels. | UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels. | UIComponent | |
| menuSelectionMode : Boolean = false
A flag that indicates whether menu-style selection
should be used. | ListBase | |
| minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| moduleFactory : 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 | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse messages. | InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse position, in pixels. | DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| nestLevel : int
Depth of this object in the containment hierarchy. | UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | UIComponent | |
| nullItemRenderer : IFactory
The custom item renderer for the control. | ListBase | |
| numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | |
| numChildren : int [read-only]
Returns the number of children of this object. | DisplayObjectContainer | |
| offscreenExtraRowsOrColumns : int
The target number of extra rows or columns of item renderers to be used
in the layout of the control. | ListBase | |
| opaqueBackground : 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 | ||
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | |
| parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UIComponent | |
| parentApplication : Object [read-only]
A reference to the Application object that contains this UIComponent
instance. | UIComponent | |
| parentDocument : Object [read-only]
A reference to the parent document object for this UIComponent. | UIComponent | |
| percentHeight : Number
Number that specifies the height of a component as a percentage
of its parent's size. | UIComponent | |
| percentWidth : Number
Number that specifies the width of a component as a percentage
of its parent's size. | UIComponent | |
| postLayoutTransformOffsets : 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 | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| rendererIsEditor : Boolean = false
Specifies whether the item renderer is also an item
editor. | List | |
| repeater : IRepeater [read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent. | UIComponent | |
| repeaterIndex : int [read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent. | UIComponent | |
| repeaterIndices : 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 | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent. | UIComponent | |
| right : Object
The horizontal distance in pixels from the right edge of the component to the
anchor target's right edge. | UIComponent | |
| root : 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 | |
| rotation : Number [override]
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | UIComponent | |
| rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationZ : Number [override]
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent | |
| rowCount : int
Number of rows to be displayed. | ListBase | |
| rowHeight : Number
The height of the rows in pixels. | ListBase | |
| scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | |
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | |
| scaleZ : Number [override]
Number that specifies the scaling factor along the z axis. | UIComponent | |
| screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | |
| scrollTipFunction : Function
A function that computes the string to be displayed as the ScrollTip. | ScrollControlBase | |
| selectable : Boolean
A flag that indicates whether the list shows selected items
as selected. | ListBase | |
| selectedIndex : int
The index in the data provider of the selected item. | ListBase | |
| selectedIndices : Array
An array of indices in the data provider of the selected items. | ListBase | |
| selectedItem : Object
A reference to the selected item in the data provider. | ListBase | |
| selectedItems : Array
An array of references to the selected items in the data provider. | ListBase | |
| selectedItemsCompareFunction : Function
A function used to compare items in the selectedItems property
against items in the data provider. | ListBase | |
| showDataTips : Boolean
A flag that indicates whether dataTips are displayed for text in the rows. | ListBase | |
| showInAutomationHierarchy : 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 | ||
| showScrollTips : Boolean = false
A flag that indicates whether a tooltip should appear
near the scroll thumb when it is being dragged. | ScrollControlBase | |
| soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | |
| stage : Stage [read-only]
The Stage of the display object. | DisplayObject | |
| states : Array
The view states that are defined for this component. | UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | |
| styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | |
| styleName : Object
The class style used by this component. | UIComponent | |
| styleParent : IAdvancedStyleClient [read-only]
A component's parent is used to evaluate descendant selectors. | UIComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | |
| tabFocusEnabled : 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 | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | |
| textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| toolTip : String
Text to display in the ToolTip. | UIComponent | |
| top : Object
The vertical distance in pixels from the top edge of the component to the
anchor target's top edge. | UIComponent | |
| transform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | DisplayObject | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | |
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | |
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UIComponent | |
| uid : String
A unique identifier for the object. | UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required). | UIComponent | |
| useHandCursor : 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 | |
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| value : Object [read-only]
The selected item, or the data or label field of the selected item. | ListBase | |
| variableRowHeight : Boolean
A flag that indicates whether the individual rows can have different
height. | ListBase | |
| verticalCenter : Object
The vertical distance in pixels from the center of the component to the
center of the anchor target's content area. | UIComponent | |
| verticalScrollPolicy : 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 | |
| verticalScrollPosition : Number
The offset into the content from the top edge. | ScrollControlBase | |
| viewMetrics : EdgeMetrics [read-only]
An EdgeMetrics object taking into account the scroll bars,
if visible. | ScrollControlBase | |
| visible : Boolean [override]
Whether or not the display object is visible. | UIComponent | |
| width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| wordWrap : Boolean
A flag that indicates whether text in the row should be word wrapped. | ListBase | |
| x : Number [override]
Number that specifies the component's horizontal position,
in pixels, within its parent container. | UIComponent | |
| y : Number [override]
Number that specifies the component's vertical position,
in pixels, within its parent container. | UIComponent | |
| z : Number [override]
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | UIComponent | |
Protected Properties
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Tree()
Constructor. | Tree | ||
|
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | DisplayObjectContainer | |
|
Adds an item renderer if a data change effect is running. | ListBase | |
| 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 | |
|
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 | |
|
Returns the index where the dropped items should be added
to the drop target. | ListBase | |
|
Queues a function to be called later. | UIComponent | |
|
Deletes a style property from this component instance. | UIComponent | |
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | |
|
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
|
Converts a Point object from content to local coordinates. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Creates the item editor for the item renderer at the
editedItemPosition using the editor
specified by the itemEditor property. | List | |
| [override]
Get the appropriate renderer, using the default renderer if none is specified. | List | |
|
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Closes an item editor that is currently open on an item. | List | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| [override]
Dispatches an event into the event flow. | UIComponent | |
|
Shows or hides the focus indicator around this component. | UIComponent | |
| 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 | |
|
Called by the effect instance when it stops playing on the component. | UIComponent | |
|
Called by the effect instance when it starts playing on the component. | UIComponent | |
|
Ends all currently playing effects on the component. | UIComponent | |
|
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 | ||
|
Finds an item in the list based on a String,
and moves the selection to it. | ListBase | |
|
Called after printing is complete. | UIComponent | |
|
Provides the automation object at the specified index. | UIComponent | |
|
Provides the automation object list . | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the child display object instance that exists at the specified index. | DisplayObjectContainer | |
|
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
|
Returns the index position of a child DisplayObject instance. | DisplayObjectContainer | |
|
Finds the type selectors for this UIComponent instance. | UIComponent | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
Gets the object that currently has focus. | UIComponent | |
|
Return the appropriate factory, using the default factory if none specified. | ListBase | |
|
Returns the element's layout height. | UIComponent | |
|
Returns the element's layout width. | UIComponent | |
|
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
|
Returns the layout transform Matrix3D for this element. | UIComponent | |
|
Returns the element's maximum height. | UIComponent | |
|
Returns the element's maximum width. | UIComponent | |
|
Returns the element's minimum height. | UIComponent | |
|
Returns the element's minimum width. | UIComponent | |
|
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 | ||
|
Returns the element's preferred height. | UIComponent | |
|
Returns the element's preferred width. | UIComponent | |
|
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 | |
|
Returns true or false
to indicates whether the effect should play on the target. | ListBase | |
|
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 | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
|
Converts a Point object from global to content coordinates. | UIComponent | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
|
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
|
Hides the drop indicator under the mouse pointer that indicates that a
drag and drop operation is allowed. | ListBase | |
|
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 | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
Get an item renderer for the index of an item in the data provider,
if one exists. | ListBase | |
|
Computes the offset into the data provider of the item
at colIndex, rowIndex. | ListBase | |
|
Initializes the internal structure of this component. | UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
|
Refresh all rows on the next update. | ListBase | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
|
Determines if the item renderer for a data provider item
is editable. | List | |
|
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 | ||
|
Determines if the item renderer for a data provider item
is selectable. | ListBase | |
|
Determines if the item renderer for a data provider item
is selected. | ListBase | |
|
Determines if the item renderer for a data provider item
is the item under the caret due to keyboard navigation. | ListBase | |
|
Determines if an item is being displayed by a renderer. | ListBase | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Determines whether a renderer contains (or owns) a display object. | ListBase | |
|
Returns the index of the item in the data provider of the item
being rendered by this item renderer. | ListBase | |
|
Returns the dataTip string the renderer would display for the given
data object based on the dataTipField and dataTipFunction properties. | ListBase | |
|
Returns the class for an icon, if any, for a data item,
based on the iconField and iconFunction properties. | ListBase | |
|
Returns the item renderer for a given item in the data provider,
if there is one. | ListBase | |
|
Returns the string the renderer would display for the given data object
based on the labelField and labelFunction properties. | ListBase | |
|
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 | |
|
Converts a Point object from local to content coordinates. | UIComponent | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Returns true if cssState matches currentCSSState. | UIComponent | |
|
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
|
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 | |
|
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 | |
|
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 | |
|
Measures a set of items from the data provider using
the current item renderer and returns the
maximum width found. | ListBase | |
|
Moves the component to a specified position within its parent. | UIComponent | |
|
Propagates style changes to the children. | UIComponent | |
|
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
|
Prepares an IFlexDisplayObject for printing. | UIComponent | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
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 | |
|
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
|
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | |
|
Removes an item renderer if a data change effect is running. | ListBase | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Replays the specified event. | UIComponent | |
|
Resolves a child by using the id provided. | UIComponent | |
| [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
|
Ensures that the data provider item at the given index is visible. | ListBase | |
|
Sizes the object. | UIComponent | |
|
Changes the position of an existing child in the display object container. | DisplayObjectContainer | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
|
Set the current state. | UIComponent | |
|
Sets the focus to this component. | UIComponent | |
Sets the associated icon for the item. | Tree | ||
|
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
|
Sets the layout size of the element. | UIComponent | |
|
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets a style property on this component instance. | UIComponent | |
|
Called when the visible property changes. | UIComponent | |
|
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 | |
|
Lets the user drag the specified sprite. | Sprite | |
|
Ends the startDrag() method. | Sprite | |
|
Detects changes to style properties. | UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| 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 | |
|
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 | |
|
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 | |
|
Validates the position and size of children and draws other
visuals. | UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
|
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 | |
|
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
Returns the primitive value of the specified object. | Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
| Method | Defined By | ||
|---|---|---|---|
|
Adds the selected items to the DragSource object as part of a
drag-and-drop operation. | ListBase | |
|
Adds a renderer to the recycled renderer list,
making it invisible and cleaning up references to it. | ListBase | |
|
Add a blank row to the beginning of the arrays that store references to the rows. | ListBase | |
|
Adjust the focus rectangle. | UIComponent | |
|
Called from the updateDisplayList() method to adjust the size and position of
listContent. | ListBase | |
|
Commits the computed matrix built from the combination of the layout
matrix and the transform offsets to the flash displayObject's transform. | UIComponent | |
|
Sets up the effect for applying the selection indicator. | ListBase | |
|
This is an internal method used by the Flex framework
to support the Dissolve effect. | UIComponent | |
|
Calculates the y position of the drop indicator
when performing a drag-and-drop operation. | ListBase | |
|
Determines if the call to the measure() method can be skipped. | UIComponent | |
|
Performs any final processing after child objects are created. | UIComponent | |
|
Clears the caret indicator into the given Sprite. | ListBase | |
|
Clears the highlight indicator in the given Sprite. | ListBase | |
|
Removes all selection and highlight and caret indicators. | ListBase | |
|
Clears the set of selected items and removes all graphics
depicting the selected state of those items. | ListBase | |
|
Empty the visibleData hash table. | ListBase | |
|
Handles CollectionEvents dispatched from the data provider
as the data changes. | ListBase | |
| [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 | |
|
Configures the ScrollBars based on the number of rows and columns and
viewable rows and columns. | ListBase | |
|
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 | |
|
Copies the selected items in the order that they were selected. | ListBase | |
|
Creates the border for this component. | ScrollControlBase | |
| [override]
Creates objects that are children of this ListBase; in this case,
the listContent object that will hold all the item
renderers. | ListBase | |
|
Creates a new object using a context
based on the embedded font being used. | UIComponent | |
|
Creates the object using a given moduleFactory. | UIComponent | |
|
Recycle a row that is no longer needed, and remove its indicators. | ListBase | |
|
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 | ||
|
Handles DragEvent.DRAG_ENTER events. | ListBase | |
|
Handles DragEvent.DRAG_EXIT events. | ListBase | |
|
Handles DragEvent.DRAG_OVER events. | ListBase | |
|
Interval function that scrolls the list up or down
if the mouse goes above or below the list. | ListBase | |
|
The default handler for the dragStart event. | ListBase | |
| 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 | |
| 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 | |
| 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 | |
|
Draws a row background
at the position and height specified. | List | |
|
Draws any alternating row colors, borders and backgrounds for the rows. | ListBase | |
| 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 | |
|
Stops the editing of an item in the data provider. | List | |
|
Tries to find the next item in the data provider that
starts with the character in the eventCode parameter. | ListBase | |
|
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 | |
|
Sets selected items based on the caretIndex and
anchorIndex properties. | ListBase | |
|
The event handler called when a UIComponent object gets focus. | UIComponent | |
|
The event handler called when a UIComponent object loses focus. | UIComponent | |
|
Retrieves an already-created item renderer not currently in use. | ListBase | |
|
The column for the data provider item at the given index. | ListBase | |
|
The row for the data provider item at the given index. | ListBase | |
|
Initializes the implementation and storage of some of the less frequently
used advanced layout features of a component. | UIComponent | |
|
Finalizes the initialization of this component. | UIComponent | |
|
Initializes this component's accessibility code. | UIComponent | |
|
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 | ||
|
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | UIComponent | |
|
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus. | UIComponent | |
|
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 | |
|
Returns a Point containing the columnIndex and rowIndex of an
item renderer. | ListBase | |
|
Determines the UID for a data provider item. | ListBase | |
|
The event handler called for a keyDown event. | UIComponent | |
|
The event handler called for a keyUp event. | UIComponent | |
|
Responds to size changes by setting the positions and sizes
of this control's borders. | ScrollControlBase | |
|
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 | ||
| 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 | |
| [override]
Calculates the measured width and height of the component based
on the rowCount,
columnCount, rowHeight and
columnWidth properties. | ListBase | |
|
Handles MouseEvent.MOUSE_CLICK events from any mouse
targets contained in the list including the renderers. | ListBase | |
|
Handles MouseEvent.MOUSE_DOUBLE_CLICK events from any
mouse targets contained in the list including the renderers. | ListBase | |
|
Handles MouseEvent.MOUSE_DOWN events from any mouse
targets contained in the list including the renderers. | ListBase | |
|
Determines which item renderer is under the mouse. | ListBase | |
|
Handles MouseEvent.MOUSE_MOVE events from any mouse
targets contained in the list including the renderers. | ListBase | |
|
Handles MouseEvent.MOUSE_OUT events from any mouse targets
contained in the list including the renderers. | ListBase | |
|
Handles MouseEvent.MOUSE_OVER events from any mouse
targets contained in the list, including the renderers. | ListBase | |
|
Handles MouseEvent.MOUSE_DOWN events from any mouse
targets contained in the list including the renderers. | ListBase | |
| [override]
Handles mouseWheel events by changing scroll positions. | ListBase | |
|
Move the selection and highlight indicators horizontally. | ListBase | |
|
Move the selection and highlight indicators vertically. | ListBase | |
|
Move a row vertically, and update the rowInfo record. | ListBase | |
|
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 | |
|
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 | |
|
Prepares the data effect for the collection event. | ListBase | |
|
Called by the updateDisplayList() method to remove existing item renderers
and clean up various caching structures when the renderer changes. | ListBase | |
|
Update the keys in the visibleData hash table. | ListBase | |
|
Remove a row from the arrays that store references to the row. | ListBase | |
|
Cleans up selection highlights and other associated graphics
for a given item in the data provider. | ListBase | |
|
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 | |
|
Remove the requested number of rows from the beginning of the
arrays that store references to the rows. | ListBase | |
|
Determines if there is enough space in this component to display
a given scrollbar. | ScrollControlBase | |
|
Default event handler for the scroll event. | ScrollControlBase | |
|
Adjusts the renderers in response to a change
in scroll position. | ListBase | |
|
Returns the data provider index for the item at the first visible
row and column for the given scroll positions. | ListBase | |
|
Adjusts the renderers in response to a change
in scroll position. | ListBase | |
|
The default failure handler when a seek fails due to a page fault. | ListBase | |
|
The default result handler when a seek fails due to a page fault. | ListBase | |
|
Seek to a position, and handle an ItemPendingError if necessary. | ListBase | |
| 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 | |
|
Sets the rowCount property without causing
invalidation or setting the explicitRowCount
property, which permanently locks in the number of rows. | ListBase | |
|
Sets the rowHeight property without causing invalidation or
setting of explicitRowHeight which
permanently locks in the height of the rows. | ListBase | |
|
Causes the ScrollControlBase to show or hide scrollbars based
on the parameters passed in. | ScrollControlBase | |
|
Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent | |
|
Shift a row in the arrays that reference rows. | ListBase | |
|
This method is called when a state changes to check whether
state-specific styles apply to this component. | UIComponent | |
|
Determine the height of the requested set of rows. | ListBase | |
|
Remove all remaining rows from the end of the
arrays that store references to the rows. | ListBase | |
|
Find an item renderer based on its UID if it is visible. | ListBase | |
| [override]
Adds or removes item renderers if the number of displayable items
changed. | ListBase | |
|
Refreshes all rows. | ListBase | |
Events
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. | UIComponent | ||
| Dispatched when a display object is added to the display list. | DisplayObject | ||
| Dispatched 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 | ||
| Dispatched when the selectedIndex or selectedItem property changes as a result of user interaction. | ListBase | ||
| Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu. | InteractiveObject | ||
| Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application. | InteractiveObject | ||
| Dispatched when the user activates the platform specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu. | InteractiveObject | ||
| Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | ||
| Dispatched after the view state has changed. | UIComponent | ||
| Dispatched after the currentState property changes, but before the view state changes. | UIComponent | ||
| Dispatched when the user activates the platform specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu. | InteractiveObject | ||
| Dispatched when the data property changes. | ListBase | ||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched 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 | ||
| Dispatched 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 | ||
| Dispatched by the drop target when the user releases the mouse over it. | UIComponent | ||
| Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | ||
| Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | ||
| Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | ||
| Dispatched by the drag initiator when starting a drag operation. | UIComponent | ||
| Dispatched after an effect ends. | UIComponent | ||
| Dispatched just before an effect starts. | UIComponent | ||
| Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent | ||
| [broadcast event] Dispatched when the playhead is entering a new frame. | DisplayObject | ||
| Dispatched after the component has entered a view state. | UIComponent | ||
| [broadcast event] Dispatched when the playhead is exiting the current frame. | DisplayObject | ||
| Dispatched just before the component exits a view state. | UIComponent | ||
| Dispatched after a display object gains focus. | InteractiveObject | ||
| Dispatched after a display object loses focus. | InteractiveObject | ||
| [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run. | DisplayObject | ||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched when the user clicks on an item in the control. | ListBase | ||
| Dispatched when a branch is closed or collapsed. | Tree | |||
| Dispatched when the user double-clicks on an item in the control. | ListBase | ||
| Dispatched when the editedItemPosition property is set and the item can be edited. | List | ||
| Dispatched 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 | ||
| Dispatched when an item editing session is ending for any reason. | List | ||
| Dispatched 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 | ||
| Dispatched 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 | |||
| Dispatched when the user rolls the mouse pointer out of an item in the control. | ListBase | ||
| Dispatched when the user rolls the mouse pointer over an item in the control. | ListBase | ||
| Dispatched when the user presses a key. | InteractiveObject | ||
| Dispatched when the user attempts to change focus by using keyboard navigation. | InteractiveObject | ||
| Dispatched when the user releases a key. | InteractiveObject | ||
| Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the middle pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| Dispatched when the user attempts to change focus by using a pointer device. | InteractiveObject | ||
| Dispatched when a user moves the pointing device while it is over an InteractiveObject. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a mouse wheel is spun over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | ||
| Dispatched when the object has moved. | UIComponent | ||
| Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture. | InteractiveObject | ||
| Dispatched 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 | ||
| Dispatched by an InteractiveObject when a drag gesture enters its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture leaves its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary. | InteractiveObject | ||
| Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched when the user activates the platform specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu. | InteractiveObject | ||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
| Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent | ||
| Dispatched when a display object is about to be removed from the display list. | DisplayObject | ||
| Dispatched 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 | ||
| [broadcast event] Dispatched when the display list is about to be updated and rendered. | DisplayObject | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the content is scrolled. | ScrollControlBase | ||
| Dispatched 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 | ||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched when the value of the object's tabChildren flag changes. | InteractiveObject | ||
| Dispatched when the object's tabEnabled flag changes. | InteractiveObject | ||
| Dispatched when the value of the object's tabIndex property changes. | InteractiveObject | ||
| Dispatched when a user enters one or more characters of text. | InteractiveObject | ||
| Dispatched by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and is to be discarded soon. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be shown. | UIComponent | ||
| Dispatched by the component when its ToolTip has been shown. | UIComponent | ||
| Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent | ||
| Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | ||
| Dispatched 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 | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
| Type: Class CSS Inheritance: no The border skin class of the component. | ScrollControlBase | ||
| Type: String CSS Inheritance: no Bounding box style. | ScrollControlBase | ||
| Type: 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 | ||
| Type: 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 | ||
| Type: String CSS Inheritance: yes The directionality of the text displayed by the component. | ScrollControlBase | ||
| Type: 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 | ||
| Type: Class CSS Inheritance: no The skin to use to indicate where a dragged item can be dropped. | ListBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
| Type: Number CSS Inheritance: no Specifies the alpha transparency value of the focus skin. | ScrollControlBase | ||
| Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent | ||
| Type: String CSS Inheritance: no Specifies which corners of the focus rectangle should be rounded. | ScrollControlBase | ||
| Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | ||
| Type: 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 | ||
| Type: String CSS Inheritance: yes Sets the antiAliasType property of internal TextFields. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Name of the font to use. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Sets the gridFitType property of internal TextFields that represent text in Flex controls. | ScrollControlBase | ||
| Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls. | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Determines whether the text is italic font. | ScrollControlBase | ||
| Type: Number CSS Inheritance: yes Sets the thickness property of internal TextFields that represent text in Flex controls. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Determines whether the text is boldface. | ScrollControlBase | ||
| Type: 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 | ||
| Type: 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 | ||
| Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled ( true) or disabled (false). | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: yes Additional vertical space between lines of text. | ScrollControlBase | ||
| Type: 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 | ||
| Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. | ScrollControlBase | ||
| Type: 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 | Tree | ||
| Type: 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 | ||
| Type: 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 | ||
| Type: 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 | ||
| Type: 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 | Tree | ||
| Type: String CSS Inheritance: yes Alignment of text within a container. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Determines whether the text is underlined. | ScrollControlBase | ||
| Type: Class CSS Inheritance: no The class implementing IUITextField that is used by this component to render text. | ScrollControlBase | ||
| Type: 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 | ||
| Type: 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 | ||
| Type: Boolean CSS Inheritance: no A flag that controls whether items are highlighted as the mouse rolls over them. | ListBase | ||
| Type: String CSS Inheritance: no The vertical alignment of a renderer in a row. | ListBase | ||
| Type: 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 | ||
| Type: String CSS Inheritance: no Style name for vertical scrollbar. | ScrollControlBase | ||
Spark Theme Styles
Halo Theme Styles
Public Constants
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):voiddataProvider | 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):voiddragMoveEnabled | 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):voidfirstVisibleItem | 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):voidhasRoot | 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():BooleanSee 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):voidopenItems | 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):voidshowRoot | 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):voidSee 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)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)open event
after the open animation is complete.
| |
cause:Event (default = null) |
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.
|
* — 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.
|
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.
|
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:
property TreeEvent.type =
mx.events.TreeEventproperty 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.
| Property | Value |
|---|---|
itemRenderer | The ListItemRenderer for the node that closed |
bubbles | false |
cancelable | false |
currentTarget | The 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. |
triggerEvent | If the node closed in response to a user action, identifies it as a keyboard action or a mouse action. |
item | the Tree item (node) that closed |
target | The 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. |
type | TreeEvent.ITEM_CLOSE |
itemOpen | Event |
Event Object Type:
property TreeEvent.type =
mx.events.TreeEventproperty 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.
| Property | Value |
|---|---|
itemRenderer | The ListItemRenderer for the item (node) that opened |
bubbles | false |
cancelable | false |
currentTarget | The 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. |
triggerEvent | If the item (node) opened in response to a user action, identifies it as a keyboard action or a mouse action. |
item | the Tree node that opened. |
target | The 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. |
type | TreeEvent.ITEM_OPEN |
itemOpening | Event |
Event Object Type:
property TreeEvent.type =
mx.events.TreeEventproperty 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.
| Property | Value |
|---|---|
animate | Whether to animate the opening or closing operation. |
bubbles | false |
cancelable | true |
currentTarget | The 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. |
dispatchEvent | Whether to dispatch an
ITEM_OPEN or ITEM_CLOSE event
after the open or close animation is complete. true |
itemRenderer | The ListItemRenderer for the item (node) that opened |
item | the Tree node that opened. |
opening | true if the item is opening, false if it is closing. |
target | The 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. |
triggerEvent | If the item opened in response to a user action, identifies it as a keyboard action or a mouse action. |
type | TreeEvent.ITEM_OPENING |
Examples ( How to use this example )
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>
Fri Mar 19 2010, 02:45 AM -07:00