Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.controls 
AdvancedDataGrid 
Packagemx.controls
Classpublic class AdvancedDataGrid
InheritanceAdvancedDataGrid Inheritance AdvancedDataGridBaseEx Inheritance AdvancedDataGridBase Inheritance AdvancedListBase Inheritance ScrollControlBase Inheritance UIComponent Inheritance FlexSprite Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Subclasses OLAPDataGrid, PrintAdvancedDataGrid

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

The AdvancedDataGrid control expands on the functionality of the standard DataGrid control to add data visualization features to your Adobe Flex application. These features provide greater control of data display, data aggregation, and data formatting. The AdvancedDataGrid control is like a List control except that it can show more than one column of data, making it suited for showing objects with multiple properties.

The AdvancedDataGrid control provides the following features:

  • Columns of different widths or identical fixed widths.
  • Columns that the user can resize at run time.
  • Columns that the user can reorder at run time.
  • Optional customizable column headers.
  • Ability to use a custom item renderer for any column to display data other than text.
  • Support for sorting the data by clicking on a column.

The AdvancedDataGrid control is intended for viewing data, and not as a layout tool like an HTML table. The mx.containers package provides those layout tools.

MXML SyntaxexpandedHide MXML Syntax

The <mx:AdvancedDataGrid> tag inherits all of the tag attributes of its superclass, except for labelField, iconField, and iconFunction, and adds the following tag attributes:

  <mx:AdvancedDataGrid
    Properties
    displayDisclosureIcon="true|false"
    displayItemsExpanded="false|true"
    groupedColumns="[]"
    groupIconFunction="null"
    groupItemRenderer="AdvancedDataGridGroupItemRenderer"
    groupLabelFunction="null"
    groupRowHeight="-1"
    itemIcons="undefined"
    lockedColumnCount="0"
    lockedRowCount="0"
    rendererProviders="[]"
    selectedCells="null"
    treeColumn="null"
     
    Styles
    alternatingItemColors="undefined"
    defaultLeafIcon="TreeNodeIcon"
    depthColors="undefined"
    disclosureClosedIcon="TreeDisclosureClosed"
    disclosureOpenIcon="TreeDisclosureOpen"
    folderClosedIcon="TreeFolderClosed"
    folderOpenIcon="TreeFolderOpen"
    headerHorizontalSeparatorSkin="undefined"
    indentation="17"
    openDuration="250"
    openEasingFunction="undefined"
    paddingLeft="2"
    paddingRight="0"
    selectionDisabledColor="#DDDDDD"
    selectionEasingFunction="undefined"
    sortFontFamily="Verdana"
    sortFontSize="10"
    sortFontStyle="normal"
    sortFontWeight="normal"
    textRollOverColor="#2B333C"
    textSelectedColor="#2B333C"
     
    Events
    headerDragOutside="No default"
    headerDropOutside="No default"
    itemClose="No default"
    itemOpen="No default"
    itemOpening="No default" 
  />
   
  The following AdvancedDataGrid code sample specifies the column order:
  <mx:AdvancedDataGrid>
    <mx:dataProvider>
        <mx:Object Artist="Pavement" Price="11.99"
          Album="Slanted and Enchanted"/>
        <mx:Object Artist="Pavement"
          Album="Brighten the Corners" Price="11.99"/>
    </mx:dataProvider>
    <mx:columns>
        <mx:AdvancedDataGridColumn dataField="Album"/>
        <mx:AdvancedDataGridColumn dataField="Price"/>
    </mx:columns>
  </mx:AdvancedDataGrid>
  

Default MXML PropertydataProvider

View the examples

See also



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

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

Common Styles
 Style Description Defined By
  
alternatingItemColors
Type: Array Format: Color CSS Inheritance: yes
Colors for rows in an alternating pattern. Value can be an Array of two of more colors. For the AdvancedDataGrid controls, all items in a row have the same background color, and each row's background color is determined from the Array of colors. Used only if the backgroundColor property is not specified. The default value is undefined.
AdvancedDataGrid
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the top edge of the content area to the control's baseline position.
UIComponent
 InheritedType: Class CSS Inheritance: no
The border skin class of the component.
ScrollControlBase
 InheritedType: String CSS Inheritance: no
Bounding box style.
ScrollControlBase
 InheritedType: String CSS Inheritance: no
The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area.
UIComponent
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of text in the component, including the component label.
ScrollControlBase
 InheritedType: Class CSS Inheritance: no
The class to use as the skin that indicates that a column can be dropped in the current location.
AdvancedDataGridBaseEx
 InheritedType: Class CSS Inheritance: no
The class to use as the skin for a column that is being resized.
AdvancedDataGridBaseEx
 InheritedType: Object CSS Inheritance: no
The effect used when changes occur in the control's data provider.
AdvancedListBase
 InheritedType: Class CSS Inheritance: no
Name of the class of the itemEditor to be used if one is not specified for a column.
AdvancedDataGridBaseEx
 InheritedType: Class CSS Inheritance: no
Name of the class of the itemRenderer to be used if one is not specified for a column.
AdvancedDataGridBaseEx
  
defaultLeafIcon
Type: Class Format: EmbeddedFile CSS Inheritance: no
The default icon for a leaf node of the navigation tree. The default value is TreeNodeIcon in the assets.swf file.
AdvancedDataGrid
  
depthColors
Type: Array Format: Color CSS Inheritance: yes
Array of colors used for the rows of each level of the navigation tree of the AdvancedDataGrid control, in descending order. The default value is undefined.
AdvancedDataGrid
 InheritedType: String CSS Inheritance: yes
The directionality of the text displayed by the component.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of text in the component if it is disabled.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes
The color for the icon in a disabled skin.
AdvancedDataGridBaseEx
  
disclosureClosedIcon
Type: Class Format: EmbeddedFile CSS Inheritance: no
The icon that is displayed next to a closed branch node of the navigation tree. The default value is TreeDisclosureClosed in the assets.swf file.
AdvancedDataGrid
  
disclosureOpenIcon
Type: Class Format: EmbeddedFile CSS Inheritance: no
The icon that is displayed next to an open branch node of the navigation tree. The default value is TreeDisclosureOpen in the assets.swf file.
AdvancedDataGrid
 InheritedType: Class CSS Inheritance: no
The skin to use to indicate where a dragged item can be dropped.
AdvancedListBase
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of the component highlight when validation fails.
UIComponent
 InheritedType: Number CSS Inheritance: no
Specifies the alpha transparency value of the focus skin.
AdvancedListBase
 InheritedType: String CSS Inheritance: no
Blend mode used by the focus rectangle.
UIComponent
 InheritedType: String CSS Inheritance: no
Specifies which corners of the focus rectangle should be rounded.
AdvancedListBase
 InheritedType: Class CSS Inheritance: no
Skin used to draw the focus rectangle.
UIComponent
 InheritedType: Number Format: Length CSS Inheritance: no
Thickness, in pixels, of the focus rectangle outline.
UIComponent
  
folderClosedIcon
Type: Class Format: EmbeddedFile CSS Inheritance: no
Specifies the folder closed icon for a branch node of the navigation tree. The default value is TreeFolderClosed in the assets.swf file.
AdvancedDataGrid
  
folderOpenIcon
Type: Class Format: EmbeddedFile CSS Inheritance: no
Specifies the folder open icon for a branch node of the navigation tree. The default value is TreeFolderOpen in the assets.swf file.
AdvancedDataGrid
 InheritedType: String CSS Inheritance: yes
Sets the antiAliasType property of internal TextFields.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Name of the font to use.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Sets the gridFitType property of internal TextFields that represent text in Flex controls.
ScrollControlBase
 InheritedType: Number CSS Inheritance: yes
Sets the sharpness property of internal TextFields that represent text in Flex controls.
ScrollControlBase
 InheritedType: Number Format: Length CSS Inheritance: yes
Height of the text, in pixels.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Determines whether the text is italic font.
ScrollControlBase
 InheritedType: Number CSS Inheritance: yes
Sets the thickness property of internal TextFields that represent text in Flex controls.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Determines whether the text is boldface.
ScrollControlBase
 InheritedType: Class CSS Inheritance: no
The class to use as the skin that defines the appearance of the background of the column headers in a AdvancedDataGrid control.
AdvancedDataGridBaseEx
 InheritedType: Array Format: Color CSS Inheritance: yes
An array of two colors used to draw the header background gradient.
AdvancedDataGridBaseEx
 InheritedType: String CSS Inheritance: no
The name of a CSS style declaration for controlling aspects of the appearance of column when the user is dragging it to another location.
AdvancedDataGridBaseEx
  
headerHorizontalSeparatorSkin
Type: Class CSS Inheritance: no
The class to use as the skin that defines the appearance of the separators between column headers of different depth in a AdvancedDataGrid control. The default value is undefined.
AdvancedDataGrid
 InheritedType: Class CSS Inheritance: no
The class to use as the skin that defines the appearance of the separator between column headers in a AdvancedDataGrid control.
AdvancedDataGridBaseEx
  
headerSortSeparatorSkin
Type: Class CSS Inheritance: no
The skin that defines the appearance of the separators between the text and icon parts of a header in a AdvancedDataGrid control. The default value is undefined.
AdvancedDataGrid
 InheritedType: String CSS Inheritance: no
The name of a CSS style declaration for controlling other aspects of the appearance of the column headers.
AdvancedDataGridBaseEx
 InheritedType: String CSS Inheritance: no
The horizontal distance in pixels from the center of the component's content area to the center of the component.
UIComponent
 InheritedType: uint Format: Color CSS Inheritance: yes
The color of the horizontal grid lines.
AdvancedDataGridBaseEx
 InheritedType: Boolean CSS Inheritance: no
A flag that indicates whether to show horizontal grid lines between the rows.
AdvancedDataGridBaseEx
 InheritedType: Class CSS Inheritance: no
The class to use as the skin that defines the appearance of the separator between the locked and unlocked rows in a AdvancedDataGrid control.
AdvancedDataGridBaseEx
 InheritedType: String CSS Inheritance: no
Style name for horizontal scrollbar.
ScrollControlBase
 InheritedType: Class CSS Inheritance: no
The class to use as the skin that defines the appearance of the separator between rows in a AdvancedDataGrid control.
AdvancedDataGridBaseEx
 InheritedType: uint Format: Color CSS Inheritance: yes
The color for the icon in a skin.
AdvancedDataGridBaseEx
  
indentation
Type: Number CSS Inheritance: no
The indentation for each node of the navigation tree, in pixels. The default value is 17.
AdvancedDataGrid
 InheritedType: Boolean CSS Inheritance: yes
A Boolean value that indicates whether kerning is enabled (true) or disabled (false).
ScrollControlBase
 InheritedType: Number Format: Length CSS Inheritance: yes
Additional vertical space between lines of text.
ScrollControlBase
 InheritedType: String CSS Inheritance: no
The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area.
UIComponent
 InheritedType: Number CSS Inheritance: yes
The number of additional pixels to appear between each character.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
The locale of the text displayed by this component.
ScrollControlBase
  
openDuration
Type: Number Format: Time CSS Inheritance: no
Length of an open or close transition for the navigation tree, in milliseconds. The default value is 250.
AdvancedDataGrid
  
openEasingFunction
Type: Function CSS Inheritance: no
Easing function to control component tweening.

The default value is undefined.

AdvancedDataGrid
 InheritedType: Number Format: Length CSS Inheritance: no
The number of pixels between the bottom of the row and the bottom of the renderer in the row.
AdvancedListBase
  
paddingLeft
Type: Number Format: Length CSS Inheritance: no
Number of pixels between the control's left border and the left edge of its content area. The default value is 2.
AdvancedDataGrid
  
paddingRight
Type: Number Format: Length CSS Inheritance: no
Number of pixels between the control's right border and the right edge of its content area. The default value is 0.
AdvancedDataGrid
 InheritedType: Number Format: Length CSS Inheritance: no
The number of pixels between the top of the row and the top of the renderer in the row.
AdvancedListBase
 InheritedType: String CSS Inheritance: no
The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area.
UIComponent
 InheritedType: uint Format: Color CSS Inheritance: yes
The color of the row background when the user rolls over the row.
AdvancedDataGridBaseEx
 InheritedType: uint Format: Color CSS Inheritance: yes
The color of the background for the row when the user selects an item renderer in the row.
AdvancedDataGridBaseEx
  
selectionDisabledColor
Type: uint Format: Color CSS Inheritance: yes
The disabled color of a list item. The default value is 0xDDDDDD.
AdvancedDataGrid
 InheritedType: Number Format: Time CSS Inheritance: no
The duration of the selection effect.
AdvancedListBase
  
selectionEasingFunction
Type: Function CSS Inheritance: no
Reference to an easingFunction function used for controlling programmatic tweening.

The default value is undefined.

AdvancedDataGrid
  
sortFontFamily
Type: String CSS Inheritance: yes
The font family used by the AdvancedDataGridSortItemRenderer class to render the sort icon in the column header. The default value is Verdana.
AdvancedDataGrid
  
sortFontSize
Type: Number Format: Length CSS Inheritance: yes
The font size used by the AdvancedDataGridSortItemRenderer class to render the sort icon in the column header. The default value is 10.
AdvancedDataGrid
  
sortFontStyle
Type: String CSS Inheritance: yes
The font style used by the AdvancedDataGridSortItemRenderer class to render the sort icon in the column header. The default value is normal.
AdvancedDataGrid
  
sortFontWeight
Type: String CSS Inheritance: yes
The font weight used by the AdvancedDataGridSortItemRenderer class to render the sort icon in the column header. The default value is normal.
AdvancedDataGrid
 InheritedType: Class CSS Inheritance: no
The class to use as the skin for the cursor that indicates that a column can be resized.
AdvancedDataGridBaseEx
 InheritedType: String CSS Inheritance: yes
Alignment of text within a container.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Determines whether the text is underlined.
ScrollControlBase
 InheritedType: Class CSS Inheritance: no
The class implementing IUITextField that is used by this component to render text.
ScrollControlBase
 InheritedType: Number Format: Length CSS Inheritance: yes
Offset of first line of text from the left side of the container, in pixels.
ScrollControlBase
  
textRollOverColor
Type: uint Format: Color CSS Inheritance: yes
Color of the text when the user rolls over a row. The default value is 0x2B333C.
AdvancedDataGrid
  
textSelectedColor
Type: uint Format: Color CSS Inheritance: yes
Color of the text when the user selects a row. The default value is 0x2B333C.
AdvancedDataGrid
 InheritedType: String CSS Inheritance: no
The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area.
UIComponent
 InheritedType: Boolean CSS Inheritance: no
A flag that controls whether items are highlighted as the mouse rolls over them.
AdvancedListBase
 InheritedType: String CSS Inheritance: no
The vertical alignment of a renderer in a row.
AdvancedListBase
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the center of the component's content area to the center of the component.
UIComponent
 InheritedType: uint Format: Color CSS Inheritance: yes
The color of the vertical grid lines.
AdvancedDataGridBaseEx
 InheritedType: Boolean CSS Inheritance: no
A flag that indicates whether to show vertical grid lines between the columns.
AdvancedDataGridBaseEx
 InheritedType: Class CSS Inheritance: no
The class to use as the skin that defines the appearance of the separator between the locked and unlocked columns in a AdvancedDataGrid control.
AdvancedDataGridBaseEx
 InheritedType: String CSS Inheritance: no
Style name for vertical scrollbar.
ScrollControlBase
 InheritedType: Class CSS Inheritance: no
The class to use as the skin that defines the appearance of the separators between columns in a AdvancedDataGrid control.
AdvancedDataGridBaseEx
Spark Theme Styles
 Style Description Defined By
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Accent color used by component skins.
ScrollControlBase
 InheritedType: Number CSS Inheritance: no Theme: spark
Alpha of the border.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: no Theme: halo, spark
Color of the border.
ScrollControlBase
 InheritedType: Boolean CSS Inheritance: no Theme: spark
Visibility of the border.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
The main color for a component.
ScrollControlBase
 InheritedType: Number CSS Inheritance: yes Theme: spark
The alpha of the content background for this component.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of the content area of the component.
ScrollControlBase
 InheritedType: Boolean CSS Inheritance: no Theme: spark
Boolean property that specifies whether the component has a visible drop shadow.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of focus ring when the component is in focus
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of any symbol of a component.
ScrollControlBase
Halo Theme Styles
 Style Description Defined By
 InheritedType: Number CSS Inheritance: no Theme: halo
Alpha level of the color defined by the backgroundColor property, of the image or SWF file defined by the backgroundImage style.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: no Theme: halo
Background color of a component.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
Background color of the component when it is disabled.
ScrollControlBase
 InheritedType: Object Format: File CSS Inheritance: no Theme: halo
Background image of a component.
ScrollControlBase
 InheritedType: String CSS Inheritance: no Theme: halo
Scales the image specified by backgroundImage to different percentage sizes.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: no Theme: halo, spark
Color of the border.
ScrollControlBase
 InheritedType: String CSS Inheritance: no Theme: halo
Bounding box sides.
ScrollControlBase
 InheritedType: Number Format: Length CSS Inheritance: no Theme: halo
Bounding box thickness.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
Color of the drop shadow.
ScrollControlBase
 InheritedType: Boolean CSS Inheritance: no Theme: halo
Boolean property that specifies whether the component has a visible drop shadow.
ScrollControlBase
 InheritedType: String CSS Inheritance: no Theme: halo
Direction of the drop shadow.
ScrollControlBase
 InheritedType: Number Format: Length CSS Inheritance: no Theme: halo
Distance of the drop shadow.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
Theme color of a component.
UIComponent
Effects
 Effect Description Defined By
 Inherited Triggering Event: added
Played when the component is added as a child to a Container.
UIComponent
 Inherited Triggering Event: creationComplete
Played when the component is created.
UIComponent
 Inherited Triggering Event: focusIn
Played when the component gains keyboard focus.
UIComponent
 Inherited Triggering Event: focusOut
Played when the component loses keyboard focus.
UIComponent
 Inherited Triggering Event: hide
Played when the component becomes invisible.
UIComponent
 Inherited Triggering Event: mouseDown
Played when the user presses the mouse button while over the component.
UIComponent
 Inherited Triggering Event: mouseUp
Played when the user releases the mouse button while over the component.
UIComponent
 Inherited Triggering Event: move
Played when the component is moved.
UIComponent
 Inherited Triggering Event: removed
Played when the component is removed from a Container.
UIComponent
 Inherited Triggering Event: resize
Played when the component is resized.
UIComponent
 Inherited Triggering Event: rollOut
Played when the user rolls the mouse so it is no longer over the component.
UIComponent
 Inherited Triggering Event: rollOver
Played when the user rolls the mouse over the component.
UIComponent
 Inherited Triggering Event: show
Played when the component becomes visible.
UIComponent
Public Constants
 ConstantDefined By
 InheritedDEFAULT_MAX_HEIGHT : Number = 10000
[static] The default value for the maxHeight property.
UIComponent
 InheritedDEFAULT_MAX_WIDTH : Number = 10000
[static] The default value for the maxWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_HEIGHT : Number = 22
[static] The default value for the measuredHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_HEIGHT : Number = 22
[static] The default value for the measuredMinHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_WIDTH : Number = 40
[static] The default value for the measuredMinWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_WIDTH : Number = 160
[static] The default value for the measuredWidth property.
UIComponent
  HEADER_ICON_PART : String = "headerIconPart"
[static] Indicates that the mouse is over the header part of the header.
AdvancedDataGrid
  HEADER_TEXT_PART : String = "headerTextPart"
[static] Indicates mouse is over the text part of the header.
AdvancedDataGrid
 InheritedMULTIPLE_CELLS : String = "multipleCells"
[static] Constant definition for the selectionMode property to allow the selection of multiple cells.
AdvancedDataGridBase
 InheritedMULTIPLE_ROWS : String = "multipleRows"
[static] Constant definition for the selectionMode property to allow the selection of multiple rows.
AdvancedDataGridBase
 InheritedNONE : String = "none"
[static] Constant definition for the selectionMode property.
AdvancedDataGridBase
 InheritedSINGLE_CELL : String = "singleCell"
[static] Constant definition for the selectionMode property to allow the selection of a single cell.
AdvancedDataGridBase
 InheritedSINGLE_ROW : String = "singleRow"
[static] Constant definition for the selectionMode property to allow the selection of a single row.
AdvancedDataGridBase
Property Detail

anchorColumnIndex

property
protected var anchorColumnIndex:int = -1

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

The column index of the current anchor. Use this property in conjunction with the ListBase.anchorIndex property to determine the column and row indices of the cell where the anchor is located.

See also

caretColumnIndex

property 
protected var caretColumnIndex:int = -1

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

The column name of the item under the caret. Used in conjunction with the caretIndex property to determine the column/row indices of the cell where the caret is located.

cellSelectionTweens

property 
protected var cellSelectionTweens:Object

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

A hash table of selection tweens. This allows the component to quickly find and clean up any tweens in progress if the set of selected items is cleared. The table is indexed by the item's UID and column number.

displayDisclosureIcon

property 
displayDisclosureIcon:Boolean

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

Controls the creation and visibility of disclosure icons in the navigation tree. If false, disclosure icons are not displayed.

The default value is true.



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

displayItemsExpanded

property 
displayItemsExpanded:Boolean

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

If true, expand the navigation tree to show all items. If a new branch is added, it will be shown expanded.

The default value is false.



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

firstVisibleItem

property 
firstVisibleItem:Object

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

The data provider element that corresponds to the item that is currently displayed in the top row of the AdvancedDataGrid control. For example, based on how the branches have been opened, closed, and scrolled, the top row might be the ninth item in the list of currently viewable items, which represents some great-grandchild of the root node. Setting this property is analogous to setting the verticalScrollPosition of the List control.

If the item is not currently viewable (for example, because it is under a nonexpanded item), setting this property has no effect.

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

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



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

groupedColumns

property 
groupedColumns:Array

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

An Array that defines the hierarchy of AdvancedDataGridColumn instances when performing column grouping. If you specify both the columns and groupedColumns properties, the control uses the groupedColumns property and ignores the columns property.



Implementation
    public function get groupedColumns():Array
    public function set groupedColumns(value:Array):void

groupIconFunction

property 
groupIconFunction:Function

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

A user-supplied callback function to run on each group item to determine its branch icon in the navigation tree. You can specify icons by using the itemIcons or setItemIcon properties if you have predetermined icons for data items. Use this callback function to determine the icon dynamically after examining the data.

The groupIconFunction takes the item in the data provider and its depth and returns a Class defining the icon, or null property to use the default icon. The callback function must have the following signature:

        groupIconFunction(item:Object,depth:int):Class

The default value is null.

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



Implementation
    public function get groupIconFunction():Function
    public function set groupIconFunction(value:Function):void

groupItemRenderer

property 
groupItemRenderer:IFactory

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

Specifies the item renderer used to display the branch nodes in the navigation tree that correspond to groups. By default, it is an instance of the AdvancedDataGridGroupItemRenderer class.



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

groupLabelFunction

property 
groupLabelFunction:Function

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

A callback function to run on each item to determine its label in the navigation tree. By default, the control looks for a property named label on each data provider item and displays it. However, some data sets do not have a label property, or have another property that can be used for displaying. An example is a data set that has lastName and firstName fields but you want to display full names.

You can supply a groupLabelFunction that finds the appropriate fields and returns a displayable string. The groupLabelFunction is also good for handling formatting and localization.

The method signature for the AdvancedDataGrid and AdvancedDataGridColumn classes is:

      myGroupLabelFunction(item:Object, column:AdvancedDataGridColumn):String

Where item contains the AdvancedDataGrid item object, and column specifies the AdvancedDataGrid column. The function returns a String containing the label.

The default value is null.

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



Implementation
    public function get groupLabelFunction():Function
    public function set groupLabelFunction(value:Function):void

groupRowHeight

property 
groupRowHeight:Number

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

The height of the grouped row, in pixels.



Implementation
    public function get groupRowHeight():Number
    public function set groupRowHeight(value:Number):void

hierarchicalCollectionView

property 
hierarchicalCollectionView:IHierarchicalCollectionView

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

The IHierarchicalCollectionView instance used by the control.

The default value is an internal instance of the HierarchicalCollectionView class.



Implementation
    public function get hierarchicalCollectionView():IHierarchicalCollectionView
    public function set hierarchicalCollectionView(value:IHierarchicalCollectionView):void

See also

highlightColumnIndex

property 
protected var highlightColumnIndex:int = -1

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

The column index of the item that is currently rolled over or under the cursor.

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

lockedColumnCount

property 
lockedColumnCount:int[override]

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

The index of the first column in the control that scrolls. Columns to the left of this one remain fixed in view.

When using column groups, a column group is considered to be a single column. For example, if you set this property to 2, and the left-most two column groups contain two and three children, respectively, then you have effectively locked the first five columns of the control.



Implementation
    override public function get lockedColumnCount():int
    override public function set lockedColumnCount(value:int):void

lockedRowCount

property 
lockedRowCount:int[override]

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

The index of the first row in the control that scrolls. Rows above this one remain fixed in view.

The default value is 0.



Implementation
    override public function get lockedRowCount():int
    override public function set lockedRowCount(value:int):void

rendererProviders

property 
rendererProviders:Array

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

Array of AdvancedDataGridRendererProvider instances. You can use several renderer providers to specify custom item renderers used for particular data, at a particular depth of the navigation tree, or with column spanning or row spanning.



Implementation
    public function get rendererProviders():Array
    public function set rendererProviders(value:Array):void

selectedCells

property 
selectedCells:Array

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

Contains an Array of cell locations as row and column indices. Changing the value of the selectionMode property sets this property to null.

Note that these row and column indices are absolute values, irrespective of the display. This is explained by a typical selectedCells property setting as follows:

      selectedCells = [ { rowIndex : r1, columnIndex : c1 },
                        { rowIndex : r2, columnIndex : c2 },
                        ... ]

Then, dataProvider[r1], columns[c1], dataProvider[r2], columns[c2], etc. will always be valid.

If you want to programmatically change the set of selected cells, you must get this Array, make modifications to the cells and order of cells in the Array, and then assign the new array to the selectedCells property. This is because the AdvancedDataGrid control returns a new copy of the Array of selectedCells and therefore does not notice the changes.

The value of the selectionMode property determines the data in the rowIndex and columnIndex properties, as the following table describes:

selectionModeValue of rowIndex and columnIndex properties
noneNo selection allowed in the control, and selectedCells is null.
singleRow Click any cell in the row to select the row. After the selection, selectedCells contains a single Object:

[{rowIndex:selectedRowIndex, columnIndex: -1}]

multipleRowsClick any cell in the row to select the row. While holding down the Control key, click any cell in another row to select the row for discontiguous selection. While holding down the Shift key, click any cell in another row to select multiple, contiguous rows. After the selection, selectedCells contains one Object for each selected row:

[ {rowIndex: selectedRowIndex1, columnIndex: -1}, {rowIndex: selectedRowIndex2, columnIndex: -1}, ... {rowIndex: selectedRowIndexN, columnIndex: -1} ]

singleCellClick any cell to select the cell. After the selection, selectedCells contains a single Object:

[{rowIndex: selectedRowIndex, columnIndex:selectedColIndex}]

multipleCellsClick any cell to select the cell. While holding down the Control key, click any cell to select the cell multiple discontiguous selection. While holding down the Shift key, click any cell to select multiple, contiguous cells. After the selection, selectedCells contains one Object for each selected cell:

[ {rowIndex: selectedRowIndex1, columnIndex: selectedColIndex1}, {rowIndex: selectedRowIndex2, columnIndex: selectedColIndex2}, ... {rowIndex: selectedRowIndexN, columnIndex: selectedColIndexN} ]



Implementation
    public function get selectedCells():Array
    public function set selectedCells(value:Array):void

selectedColumnIndex

property 
protected var selectedColumnIndex:int = -1

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

The column of the selected cell. Used in conjunction with selectedIndex property to determine the column and row indices of the selected cell.

treeColumn

property 
treeColumn:AdvancedDataGridColumn

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

The column in which the tree is displayed. Set this property to the value of the id property of an AdvancedDataGridColumn instance, as the following example shows:

        <mx:AdvancedDataGrid 
           width="100%" height="100%"
           treeColumn="{rep}"> 
           <mx:dataProvider>
              <mx:HierarchicalData source="{dpHierarchy}" 
                  childrenField="categories"/>
           </mx:dataProvider>
           <mx:columns>
              <mx:AdvancedDataGridColumn dataField="Region"/>
              <mx:AdvancedDataGridColumn id="rep" 
                  dataField="Territory_Rep"
                  headerText="Territory Rep"/>
              <mx:AdvancedDataGridColumn dataField="Actual"/>
              <mx:AdvancedDataGridColumn dataField="Estimate"/>
           </mx:columns>
        </mx:AdvancedDataGrid>

The default value is null.



Implementation
    public function get treeColumn():AdvancedDataGridColumn
    public function set treeColumn(value:AdvancedDataGridColumn):void

treeColumnIndex

property 
treeColumnIndex:int  [read-only]

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

The tree column number.

The default value is 0.



Implementation
    protected function get treeColumnIndex():int

tween

property 
protected var tween:Object

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

The tween object that animates rows Users can add event listeners to this Object to get notified when the tween starts, updates and ends.

visibleCellRenderers

property 
protected var visibleCellRenderers:Object

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

A hash table of data provider item renderers currently in view. The table is indexed by the data provider item's UID and column number and is used to quickly get the renderer used to display a particular item.

Constructor Detail

AdvancedDataGrid

()Constructor
public function AdvancedDataGrid()

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

Constructor.

Method Detail

addCellSelectionData

()method
protected function addCellSelectionData(uid:String, columnIndex:int, selectionData:AdvancedDataGridBaseSelectionData):void

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

Adds cell selection information to the control, as if you used the mouse to select the cell.

Parameters

uid:String — The UID of the selected cell.
 
columnIndex:int — The column index of the selected cell.
 
selectionData:AdvancedDataGridBaseSelectionData — An AdvancedDataGridBaseSelectionData instance defining the information about the selected cell.

See also

applyCellSelectionEffect

()method 
protected function applyCellSelectionEffect(indicator:Sprite, uid:String, columnIndex:int, itemRenderer:IListItemRenderer):void

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

Sets up the effect for applying the selection indicator. The default is a basic alpha tween.

Parameters

indicator:Sprite — A Sprite that contains the graphics depicting selection.
 
uid:String — The UID of the item being selected which can be used to index into a table and track more than one selection effect.
 
columnIndex:int — The column index of the selected cell.
 
itemRenderer:IListItemRenderer — The item renderer that is being shown as selected.

applyUserStylesForItemRenderer

()method 
protected function applyUserStylesForItemRenderer(givenItemRenderer:IListItemRenderer):void

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

Applies styles from the AdvancedDatagrid control to an item renderer. The item renderer should implement the IStyleClient and IDataRenderer interfaces, and be a subclass of the DisplayObject class.

Parameters

givenItemRenderer:IListItemRenderer — The item renderer.

atLeastOneProperty

()method 
protected function atLeastOneProperty(o:Object):Boolean

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

Returns true if the Object has at least one property, which means that the dictionary has at least one key.

Parameters

o:Object — The Object to inspect.

Returns
Booleantrue if the Object has at least one property.

clearCellSelectionData

()method 
protected function clearCellSelectionData():void

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

Clears information on cell selection.

clearIndicators

()method 
override protected function clearIndicators():void

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

Removes all selection and highlight and caret indicators.

clearSelectedCells

()method 
protected function clearSelectedCells(transition:Boolean = false):void

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

Clears the selectedCells property.

Parameters

transition:Boolean (default = false) — Specify true to animate the transition.

collapseAll

()method 
public function collapseAll():void

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

Collapses all the nodes of the navigation tree.

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

Handler for the DragEvent.DRAG_COMPLETE event. By default, only the DragManager.MOVE drag action is supported. To support the DragManager.COPY drag action, you must write an event handler for the DragEvent.DRAG_DROP event that implements the copy of the AdvancedDataGrid data based on its structure.

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

Handler for the DragEvent.DRAG_DROP event. This method hides the drop feedback by calling the hideDropFeedback() method. By default, only the DragManager.MOVE drag action is supported. To support the DragManager.COPY drag action, you must write an event handler for the DragEvent.DRAG_DROP event that implements the copy of the AdvancedDataGrid data based on its structure.

Parameters

event:DragEvent — The DragEvent object.

drawVerticalLine

()method 
override protected function drawVerticalLine(s:Sprite, colIndex:int, color:uint, x:Number):void

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

Draws a vertical line between columns. This implementation draws a line directly into the given Sprite. The Sprite has been cleared before lines are drawn into it.

Parameters

s:Sprite — A Sprite that contains a DisplayObject that contains the graphics for that row.
 
colIndex:int — The column's index in the set of displayed columns. The left most visible column has a column index of 0.
 
color:uint — The color for the indicator.
 
x:Number — The x position for the background

expandAll

()method 
public function expandAll():void

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

Expands all the nodes of the navigation tree in the control.

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 nodes of the navigation tree below the specified item.

If you set the dataProvider property and then immediately call the expandChildrenOf() method, you may not see the correct behavior. You should either wait for the component to validate, or call the validateNow() method before calling expandChildrenOf().

Parameters

item:Object — An Object defining the branch node. This Object contains the data provider element for the branch node.
 
open:Boolean — 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 node of the navigation tree. When a branch item opens, it restores the open and closed states of its child branches if they were already opened.

If you set the dataProvider property and then immediately call the expandItem() method, you may not see the correct behavior. You should either wait for the component to validate or call validateNow().

Parameters

item:Object — An Object defining the branch node. This Object contains the data provider element for the branch node.
 
open:Boolean — Specify true to open the branch node, and false to close it.
 
animate:Boolean (default = false) — Specify true to animate the transition. (Note: If a branch has over 20 children, to improve performance it does not animate the first time it opens.)
 
dispatchEvent:Boolean (default = false) — Specifies whether the control dispatches an open event after the open animation is complete (true), or not (false).
 
cause:Event (default = null) — The event, if any, that initiated the item action.

finishKeySelection

()method 
override protected function finishKeySelection():void

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

Sets selected items based on the caretIndex and anchorIndex properties. Called by the keyboard selection handlers and by the updateDisplayList() method in case the keyboard selection handler got a page fault while scrolling to get more items.

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 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 — An Object defining the child item. This Object contains the data provider element for the child.

Returns
* — The parent of the item.

initListData

()method 
protected function initListData(item:Object, adgListData:AdvancedDataGridListData):void

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

Initializes an AdvancedDataGridListData object that is used by the AdvancedDataGrid item renderer.

Parameters

item:Object — The item to be rendered. This Object contains the data provider element for the item.
 
adgListData:AdvancedDataGridListData — The AdvancedDataGridListDataItem 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 branch node is open.

Parameters

item:Object — Branch node to inspect. This Object contains the data provider element for the branch node.

Returns
Booleantrue if open, and false if not.

moveIndicators

()method 
override protected function moveIndicators(uid:String, offset:int, absolute:Boolean):void

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

Moves the cell and row selection indicators up or down by the given offset as the control scrolls its display. This assumes all the selection indicators in this row are at the same y position.

Parameters

uid:String — The UID of the row.
 
offset:int — scroll offset.
 
absolute:Booleantrue if offset contains the new scroll position, and false if it contains a value relative to the current scroll position.

removeCellSelectionData

()method 
protected function removeCellSelectionData(uid:String, columnIndex:int):void

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

Removes cell selection information from the control.

Parameters

uid:String — The UID of the selected cell.
 
columnIndex:int — The column index of the selected cell.

selectCellItem

()method 
protected function selectCellItem(item:IListItemRenderer, shiftKey:Boolean, ctrlKey:Boolean, transition:Boolean = true):Boolean

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

Updates the list of selected cells, assuming that the specified item renderer was clicked by the mouse, and the keyboard modifiers are in the specified state.

This method also updates the display of the item renderers based on their updated selected state.

Parameters

item:IListItemRenderer — The item renderer for the cell.
 
shiftKey:Booleantrue to specify that the Shift key is pressed, and false if not.
 
ctrlKey:Booleantrue to specify that the Control key is pressed, and false if not.
 
transition:Boolean (default = true) — Specify true to animate the transition.

Returns
Boolean — Returns true if the operation succeeded.

selectItem

()method 
override protected function selectItem(item:IListItemRenderer, shiftKey:Boolean, ctrlKey:Boolean, transition:Boolean = true):Boolean

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

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. This method also updates the display of the item renderers based on their updated selected state.

Parameters

item:IListItemRenderer — The item renderer that was clicked.
 
shiftKey:Booleantrue if the Shift key was held down when the mouse was clicked.
 
ctrlKey:Booleantrue if the Control key was held down when the mouse was clicked.
 
transition:Boolean (default = true)true if the graphics for the selected state should be faded in using an effect.

Returns
Booleantrue if the set of selected items changed. Clicking an already selected item doesn't always change the set of selected items.

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 in the navigation tree 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 — An Object defining the item in the navigation tree. This Object contains the data provider element for the item.
 
iconID:Class — The closed (or leaf) icon.
 
iconID2:Class — The open icon.

treeNavigationHandler

()method 
protected function treeNavigationHandler(event:KeyboardEvent):Boolean

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

Handler for keyboard navigation for the navigation tree.

Parameters

event:KeyboardEvent — The keyboard event.

Returns
Booleantrue if the keyboard navigation is handled correctly.
Event Detail

headerDragOutside

Event
Event Object Type: mx.events.AdvancedDataGridEvent
property AdvancedDataGridEvent.type = mx.events.AdvancedDataGridEvent.HEADER_DRAG_OUTSIDE

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

Dispatched when the user drags a column outside of its column group. TheAdvancedDataGrid control does not provide a default event handler for this event.

The AdvancedDataGridEvent.HEADER_DRAG_OUTSIDE constant defines the value of the type property of the event object for a headerDragOutside event, which indicates that the user pressed and released the mouse on a column header.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
columnIndex The zero-based index of the item's column in the AdvancedDataGrid object's columns array.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dataFieldThe name of the field or property in the data associated with the column.
itemRendererThe header renderer that is being released.
localXNaN
reasonnull
rowIndexnull
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeAdvancedDataGridEvent.HEADER_RELEASE

headerDropOutside

Event  
Event Object Type: mx.events.AdvancedDataGridEvent
property AdvancedDataGridEvent.type = mx.events.AdvancedDataGridEvent.HEADER_DROP_OUTSIDE

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

Dispatched when the user drops a column outside of its column group. TheAdvancedDataGrid control doesn't provide a default handler for this event.

The AdvancedDataGridEvent.HEADER_DROP_OUTSIDE constant defines the value of the type property of the event object for a headerDropOutside event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
columnIndex The zero-based index of the item's column in the AdvancedDataGrid object's columns array.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dataFieldThe name of the field or property in the data associated with the column.
itemThe AdvancedDataGrid item (node) that closed.
itemRendererThe header renderer that is being released.
localXNaN
multiColumnSort false
reasonnull
removeColumnFromSortfalse
rowIndexnull
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
triggerEventIf the node closed in response to a user action, identifies it as a keyboard action or a mouse action.
typeAdvancedDataGridEvent.HEADER_RELEASE

itemClose

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

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

Dispatched when a branch of the navigation tree is closed or collapsed.

The AdvancedDataGridEvent.ITEM_CLOSE event type constant indicates that a AdvancedDataGrid branch closed or collapsed.

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

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dataFieldThe name of the field or property in the data associated with the column.
itemThe AdvancedDataGrid item (node) that closed.
itemRendererThe ListItemRenderer for the node that closed.
localXNaN
multiColumnSort false
removeColumnFromSortfalse
rowIndex-1
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
triggerEventIf the node closed in response to a user action, identifies it as a keyboard action or a mouse action.
typeAdvancedDataGridEvent.ITEM_CLOSE

itemOpen

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

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

Dispatched when a branch of the navigation tree is opened or expanded.

The AdvancedDataGridEvent.ITEM_OPEN event type constant indicates that an AdvancedDataGrid branch opened or expanded.

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

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

itemOpening

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

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

Dispatched when a tree branch open or close operation is initiated.

The AdvancedDataGridEvent.ITEM_OPENING event type constant is dispatched immediately before a AdvancedDataGrid opens or closes.

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

PropertyValue
animateWhether to animate the opening or closing operation.
bubblesfalse
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dispatchEventWhether to dispatch an ITEM_OPEN or ITEM_CLOSE event after the open or close animation is complete. true
itemThe AdvancedDataGrid node that opened.
itemRendererThe ListItemRenderer for the item (node) that opened.
localXNaN
multiColumnSort false
removeColumnFromSortfalse
rowIndex-1
openingtrue if the item is opening, false if it is closing.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
triggerEventIf the item opened in response to a user action, identifies it as a keyboard action or a mouse action.
typeAdvancedDataGridEvent.ITEM_OPENING
Constant Detail

HEADER_ICON_PART

Constant
public static const HEADER_ICON_PART:String = "headerIconPart"

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

Indicates that the mouse is over the header part of the header. Used as a return value by the AdvancedDataGridHeaderRenderer.mouseEventToHeaderPart method.

HEADER_TEXT_PART

Constant 
public static const HEADER_TEXT_PART:String = "headerTextPart"

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

Indicates mouse is over the text part of the header. Used as a return value by mouseEventToHeaderPart.

AdvancedDataGridExample.mxml
<?xml version="1.0"?>
<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[
            import mx.collections.ArrayCollection;
                  
            [Bindable]
            private var dpFlat:ArrayCollection = new ArrayCollection([
              {Region:"Southwest", Territory:"Arizona", 
                  Territory_Rep:"Barbara Jennings", Actual:38865, Estimate:40000}, 
              {Region:"Southwest", Territory:"Arizona", 
                  Territory_Rep:"Dana Binn", Actual:29885, Estimate:30000},  
              {Region:"Southwest", Territory:"Central California", 
                  Territory_Rep:"Joe Smith", Actual:29134, Estimate:30000},  
              {Region:"Southwest", Territory:"Nevada", 
                  Territory_Rep:"Bethany Pittman", Actual:52888, Estimate:45000},  
              {Region:"Southwest", Territory:"Northern California", 
                  Territory_Rep:"Lauren Ipsum", Actual:38805, Estimate:40000}, 
              {Region:"Southwest", Territory:"Northern California", 
                  Territory_Rep:"T.R. Smith", Actual:55498, Estimate:40000},  
              {Region:"Southwest", Territory:"Southern California", 
                  Territory_Rep:"Alice Treu", Actual:44985, Estimate:45000}, 
              {Region:"Southwest", Territory:"Southern California", 
                  Territory_Rep:"Jane Grove", Actual:44913, Estimate:45000}
            ]);
        ]]>
    </fx:Script>

    <mx:Panel title="AdvancedDataGrid Control Example"
        height="75%" width="75%" layout="horizontal"
        paddingTop="10" paddingBottom="10" paddingLeft="10" paddingRight="10">

        <mx:AdvancedDataGrid id="myADG" 
            width="100%" height="100%" 
            initialize="gc.refresh();">        
            <mx:dataProvider>
                <mx:GroupingCollection2 id="gc" source="{dpFlat}">
                    <mx:grouping>
                        <mx:Grouping>
                            <mx:GroupingField name="Region"/>
                            <mx:GroupingField name="Territory"/>
                        </mx:Grouping>
                    </mx:grouping>
                </mx:GroupingCollection2>
            </mx:dataProvider>        
            
            <mx:columns>
                <mx:AdvancedDataGridColumn dataField="Region"/>
                <mx:AdvancedDataGridColumn dataField="Territory"/>
                <mx:AdvancedDataGridColumn dataField="Territory_Rep"
                    headerText="Territory Rep"/>
                <mx:AdvancedDataGridColumn dataField="Actual"/>
                <mx:AdvancedDataGridColumn dataField="Estimate"/>
            </mx:columns>
       </mx:AdvancedDataGrid>
    </mx:Panel>
    
</s:Application>