| Package | mx.controls |
| Class | public class AdvancedDataGrid |
| Inheritance | AdvancedDataGrid  AdvancedDataGridBaseEx AdvancedDataGridBase AdvancedListBase ScrollControlBase UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Subclasses | OLAPDataGrid, PrintAdvancedDataGrid |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Show MXML Syntax
Hide 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
More examples
Creating a Spark item renderer
for an MX AdvancedDataGrid control
Example: Creating column groups
Sorting by multiple columns
Styling rows and columns
Selecting multiple cells and rows
Hierarchical and grouped data display
Displaying hierarchical data
Displaying grouped data
Creating column groups
Using item renderers with the AdvancedDataGrid control
Example: Creating column groups
Sorting by multiple columns
Styling rows and columns
Selecting multiple cells and rows
Hierarchical and grouped data display
Displaying hierarchical data
Displaying grouped data
Creating column groups
Using item renderers with the AdvancedDataGrid control
Learn more
Using a Spark item renderer with
an MX control
About the AdvancedDataGrid control
Migrating from the DataGrid control
Keyboard navigation
About the AdvancedDataGrid control
Migrating from the DataGrid control
Keyboard navigation
Related API Elements
mx.controls.advancedDataGridClasses.AdvancedDataGridItemRenderer
mx.controls.advancedDataGridClasses.AdvancedDataGridColumn
mx.controls.advancedDataGridClasses.AdvancedDataGridDragProxy
mx.events.AdvancedDataGridEvent
mx.controls.DataGrid
mx.controls.advancedDataGridClasses.AdvancedDataGridColumn
mx.controls.advancedDataGridClasses.AdvancedDataGridDragProxy
mx.events.AdvancedDataGridEvent
mx.controls.DataGrid
Public Properties
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | |
| allowDragSelection : Boolean = false
A flag that indicates whether drag-selection is enabled. | AdvancedListBase | |
| allowMultipleSelection : Boolean
A flag that indicates whether you can allow more than one item to be
selected at the same time. | AdvancedListBase | |
| alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality. | UIComponent | |
| automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UIComponent | |
| automationName : String
Name that can be used as an identifier for this object. | UIComponent | |
| automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UIComponent | |
| automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | UIComponent | |
| automationTabularData : Object [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : Array [read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application. | UIComponent | |
| automationVisible : Boolean [read-only]
True if this component is visible for automation, false
otherwise. | UIComponent | |
| baseline : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| baselinePosition : Number [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | UIComponent | |
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | |
| blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | |
| borderMetrics : EdgeMetrics [read-only]
Returns an EdgeMetrics object that has four properties:
left, top, right,
and bottom. | ScrollControlBase | |
| bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | |
| cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | DisplayObject | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | |
| className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | |
| columns : Array
An array of AdvancedDataGridColumn objects, one for each column that
can be displayed. | AdvancedDataGridBaseEx | |
| columnWidth : Number
The width of the control's columns. | AdvancedListBase | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| contentMouseX : Number [read-only]
Returns the x position of the mouse, in the content coordinate system. | UIComponent | |
| contentMouseY : Number [read-only]
Returns the y position of the mouse, in the content coordinate system. | UIComponent | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | |
| currentState : String
The current view state of the component. | UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers. | UIComponent | |
| data : Object
The item in the data provider this component should render when
this component is used as an item renderer or item editor. | AdvancedListBase | |
| dataProvider : Object
Set of data to be viewed. | AdvancedListBase | |
| dataTipField : String
Name of the field in the data provider items to display as the
data tip. | AdvancedListBase | |
| dataTipFunction : Function
User-supplied function to run on each item to determine its dataTip. | AdvancedListBase | |
| depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | UIComponent | |
| 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 | ||
| document : Object
A reference to the document object associated with this UIComponent. | UIComponent | |
| doubleClickEnabled : Boolean [override]
Specifies whether the UIComponent object receives doubleClick events. | UIComponent | |
| dragEnabled : Boolean
A flag that indicates whether you can drag items out of
this control and drop them on other controls. | AdvancedListBase | |
| draggableColumns : Boolean
Indicates whether you are allowed to reorder columns. | AdvancedDataGridBaseEx | |
| dragMoveEnabled : 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 | |
| dropEnabled : Boolean
A flag that indicates whether dragged items can be dropped onto the
control. | AdvancedListBase | |
| dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | |
| editable : String
Indicates whether or not the user can edit items in the data provider. | AdvancedDataGridBaseEx | |
| editedItemPosition : Object
The column and row index of the item renderer for the
data provider item being edited, if any. | AdvancedDataGridBaseEx | |
| editedItemRenderer : IListItemRenderer [read-only]
A reference to the item renderer
in the AdvancedDataGrid control whose item is currently being edited. | AdvancedDataGridBaseEx | |
| enabled : Boolean
Whether the component can accept user interaction. | UIComponent | |
| enableIME : Boolean [read-only]
A flag that indicates whether the IME should
be enabled when the component receives focus. | AdvancedDataGridBaseEx | |
| errorString : String
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | |
| explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | |
| firstVisibleItem : Object
The data provider element that corresponds to the
item that is currently displayed in the top row of the AdvancedDataGrid control. | AdvancedDataGrid | ||
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | |
| focusPane : Sprite
The focus pane associated with this object. | UIComponent | |
| focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | |
| fontContext : IFlexModuleFactory
The module factory that provides the font context for this component. | AdvancedDataGridBase | |
| graphics : 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 | ||
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | |
| hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | UIComponent | |
| headerHeight : Number
The height of the header cell of the column, in pixels. | AdvancedDataGridBase | |
| headerRenderer : IFactory
The header renderer used to display the header rows of the column. | AdvancedDataGridBase | |
| headerWordWrap : Boolean
If true, specifies that text in the header is
wrapped if it does not fit on one line. | AdvancedDataGridBase | |
| height : 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 | ||
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| horizontalScrollPolicy : String
A property that indicates whether the horizontal scroll
bar is always on, always off,
or automatically changes based on the parameters passed to the
setScrollBarProperties() method. | ScrollControlBase | |
| horizontalScrollPosition : Number [override]
The offset into the content from the left edge. | AdvancedDataGridBaseEx | |
| iconField : String
The name of the field in the data provider object that determines what to
display as the icon. | AdvancedListBase | |
| iconFunction : Function
A user-supplied function to run on each item to determine its icon. | AdvancedListBase | |
| id : String
ID of the component. | UIComponent | |
| imeMode : String
Specifies the IME (input method editor) mode. | AdvancedDataGridBaseEx | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles. | UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required). | UIComponent | |
| instanceIndex : int [read-only]
The index of a repeated component. | UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document. | UIComponent | |
| is3D : Boolean [read-only]
Contains true when the element is in 3D. | UIComponent | |
| isDocument : Boolean [read-only]
Contains true if this UIComponent instance is a document object. | UIComponent | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| itemEditorInstance : 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 | ||
| itemRenderer : IFactory
The custom item renderer for the control. | AdvancedListBase | |
| labelFunction : Function
A user-supplied function to run on each item to determine its label. | AdvancedListBase | |
| layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | |
| left : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| listData : BaseListData
When a component is used as a drop-in item renderer or drop-in
item editor, Flex initializes the listData property
of the component with the additional data from the list control. | AdvancedListBase | |
| liveScrolling : Boolean = true
A flag that indicates whether scrolling is live as the
scrollbar thumb is moved
or the view is not updated until the thumb is released. | ScrollControlBase | |
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | |
| 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 | ||
| lookAheadDuration : Number = 400
The type look-ahead duration, in milliseconds, for multi-character look ahead. | AdvancedDataGridBaseEx | |
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | |
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels. | UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels. | UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels. | UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels. | UIComponent | |
| menuSelectionMode : Boolean = false
A flag that indicates whether menu-style selection
should be used. | AdvancedListBase | |
| minColumnWidth : Number
The minimum width of the columns, in pixels. | AdvancedDataGridBaseEx | |
| minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| moduleFactory : IFlexModuleFactory
A module factory is used as context for using embedded fonts and for
finding the style manager that controls the styles for this
component. | UIComponent | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | |
| nestLevel : int
Depth of this object in the containment hierarchy. | UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | UIComponent | |
| numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | |
| numChildren : int [read-only]
Returns the number of children of this object. | DisplayObjectContainer | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | |
| parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UIComponent | |
| parentApplication : Object [read-only]
A reference to the Application object that contains this UIComponent
instance. | UIComponent | |
| parentDocument : Object [read-only]
A reference to the parent document object for this UIComponent. | UIComponent | |
| percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | UIComponent | |
| percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | UIComponent | |
| postLayoutTransformOffsets : mx.geom:TransformOffsets
Defines a set of adjustments that can be applied to the object's
transform in a way that is invisible to its parent's layout. | UIComponent | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| rendererProviders : Array
Array of AdvancedDataGridRendererProvider instances. | AdvancedDataGrid | ||
| repeater : IRepeater [read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent. | UIComponent | |
| repeaterIndex : int [read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent. | UIComponent | |
| repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent. | UIComponent | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent. | UIComponent | |
| resizableColumns : Boolean = true
A flag that indicates whether the user can change the size of the
columns. | AdvancedDataGridBaseEx | |
| right : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | |
| rotation : Number [override]
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | UIComponent | |
| rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationZ : Number [override]
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent | |
| rowCount : int
Number of rows to be displayed. | AdvancedListBase | |
| rowHeight : Number
The height of the rows in pixels. | AdvancedListBase | |
| scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | |
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | |
| scaleZ : Number [override]
Number that specifies the scaling factor along the z axis. | UIComponent | |
| screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | |
| scrollTipFunction : Function
A function that computes the string to be displayed as the ScrollTip. | ScrollControlBase | |
| selectable : Boolean
A flag that indicates whether the list shows selected items
as selected. | AdvancedListBase | |
| selectedCells : Array
Contains an Array of cell locations as row and column indices. | AdvancedDataGrid | ||
| selectedIndex : int
The index in the data provider of the selected item. | AdvancedListBase | |
| selectedIndices : Array
An array of indices in the data provider of the selected items. | AdvancedListBase | |
| selectedItem : Object
A reference to the selected item in the data provider. | AdvancedListBase | |
| selectedItems : Array
An Array of references to the selected items in the data provider. | AdvancedListBase | |
| selectionMode : String
The selection mode of the control. | AdvancedDataGridBase | |
| showHeaders : Boolean
A flag that indicates whether the control should show
column headers. | AdvancedDataGridBase | |
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| showScrollTips : Boolean = false
A flag that indicates whether a tooltip should appear
near the scroll thumb when it is being dragged. | ScrollControlBase | |
| softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed. | InteractiveObject | |
| sortableColumns : Boolean = true
A flag that indicates whether the user can sort the data provider items
by clicking on a column header cell. | AdvancedDataGridBaseEx | |
| sortExpertMode : 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 | |
| sortItemRenderer : IFactory
The sort item renderer to be used to display the sort icon in the
column header. | AdvancedDataGridBase | |
| soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | |
| stage : Stage [read-only]
The Stage of the display object. | DisplayObject | |
| states : Array
The view states that are defined for this component. | UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | |
| styleFunction : Function
A callback function called while rendering each cell. | AdvancedDataGridBase | |
| styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | |
| styleName : Object
The class style used by this component. | UIComponent | |
| styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors. | UIComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | |
| tabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus
via the TAB key
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor. | UIComponent | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | |
| textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| toolTip : String
Text to display in the ToolTip. | UIComponent | |
| top : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| transform : flash.geom:Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | |
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | |
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| treeColumn : AdvancedDataGridColumn
The column in which the tree is displayed. | AdvancedDataGrid | ||
| tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UIComponent | |
| uid : String
A unique identifier for the object. | UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required). | UIComponent | |
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls
over a sprite in which the buttonMode property is set to true. | Sprite | |
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| value : Object [read-only]
The selected item, or the data or label field of the selected item. | AdvancedListBase | |
| variableRowHeight : Boolean
A flag that indicates whether the individual rows can have different
height. | AdvancedListBase | |
| verticalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| verticalScrollPolicy : String
A property that indicates whether the vertical scroll bar is always on, always off,
or automatically changes based on the parameters passed to the
setScrollBarProperties() method. | ScrollControlBase | |
| verticalScrollPosition : Number
The offset into the content from the top edge. | ScrollControlBase | |
| viewMetrics : EdgeMetrics [read-only]
An EdgeMetrics object taking into account the scroll bars,
if visible. | ScrollControlBase | |
| visible : Boolean [override]
Whether or not the display object is visible. | UIComponent | |
| width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| wordWrap : Boolean
A flag that indicates whether text in the row should be word wrapped. | AdvancedListBase | |
| x : Number [override]
Number that specifies the component's horizontal position,
in pixels, within its parent container. | UIComponent | |
| y : Number [override]
Number that specifies the component's vertical position,
in pixels, within its parent container. | UIComponent | |
| z : Number [override]
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | UIComponent | |
Protected Properties
| Property | Defined By | ||
|---|---|---|---|
| actualCollection : ICollectionView
A copy of the value normally stored in the collection
property used while running data changes effects. | AdvancedListBase | |
| actualIterator : IViewCursor
A copy of the value normally stored in the iterator
property used while running data changes effects. | AdvancedListBase | |
| anchorBookmark : CursorBookmark
A bookmark to the item that is the anchor. | AdvancedListBase | |
| anchorColumnIndex : int = -1
The column index of the current anchor. | AdvancedDataGrid | ||
| anchorIndex : int = -1
The offset of the item in the data provider that is the selection
anchor point. | AdvancedListBase | |
| border : IFlexDisplayObject
The border object. | ScrollControlBase | |
| cachedDataChangeEffect : Effect = null
The effect that plays when changes occur in the data
provider for the control. | AdvancedListBase | |
| caretBookmark : CursorBookmark
A bookmark to the item under the caret. | AdvancedListBase | |
| caretColumnIndex : int = -1
The column name of the item under the caret. | AdvancedDataGrid | ||
| caretIndex : int = -1
The offset of the item in the data provider that is at the selection
caret point. | AdvancedListBase | |
| caretIndicator : Sprite
The DisplayObject that contains the graphics that indicate
which renderer is the caret. | AdvancedListBase | |
| caretItemRenderer : IListItemRenderer
The renderer for the item under the caret. | AdvancedListBase | |
| caretUID : String
The UID of the item under the caret. | AdvancedListBase | |
| cellSelectionTweens : Object
A hash table of selection tweens. | AdvancedDataGrid | ||
| collection : ICollectionView
An ICollectionView that represents the data provider. | AdvancedListBase | |
| columnMap : Object
A map of item renderers to columns. | AdvancedDataGridBase | |
| currentColNum : int
Contains the index of the column for which a renderer is currently being created. | AdvancedDataGridBase | |
| currentCSSState : String [read-only]
The state to be used when matching CSS pseudo-selectors. | UIComponent | |
| currentItemTop : Number
Contains the top position of the renderer that is currently being created. | AdvancedDataGridBase | |
| currentRowHeight : Number
The height, in pixels, of the current row. | AdvancedDataGridBase | |
| currentRowNum : int
Contains the index of the row for which a renderer is currently being created. | AdvancedDataGridBase | |
| dataEffectCompleted : Boolean = false
A flag that indicates that the a data change effect has
just completed. | AdvancedListBase | |
| dataItemWrappersByRenderer : Dictionary
A dictionary mapping item renderers to the ItemWrappers
used to supply their data. | AdvancedListBase | |
| defaultColumnCount : int = 4
The default number of columns to display. | AdvancedListBase | |
| defaultRowCount : int = 4
The default number of rows to display. | AdvancedListBase | |
| dragImage : IUIComponent [read-only]
An instance of a class that displays the visuals
during a drag and drop operation. | AdvancedListBase | |
| dragImageOffsets : Point [read-only]
The offset of the drag image for drag and drop. | AdvancedListBase | |
| explicitColumnCount : int = -1
The column count requested by explicitly setting the
columnCount property. | AdvancedListBase | |
| explicitColumnWidth : Number
The column width requested by explicitly setting the
columnWidth. | AdvancedListBase | |
| explicitRowCount : int = -1
The row count requested by explicitly setting
rowCount. | AdvancedListBase | |
| explicitRowHeight : Number
The row height requested by explicitly setting
rowHeight. | AdvancedListBase | |
| freeItemRenderers : Array
A stack of unused item renderers. | AdvancedListBase | |
| hasComplexLayoutMatrix : Boolean [read-only]
Returns true if the UIComponent has any non-translation (x,y) transform properties. | UIComponent | |
| headerInfoInitialized : Boolean = false
Contains true if the headerInfos property
has been initialized with AdvancedDataGridHeaderInfo instances. | AdvancedDataGridBaseEx | |
| headerInfos : Array
An Array of AdvancedDataGridHeaderInfo instances for all columns
in the control. | AdvancedDataGridBase | |
| headerRowInfo : 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 | ||
| highlightIndicator : Sprite
The DisplayObject that contains the graphics that indicates
which renderer is highlighted. | AdvancedListBase | |
| highlightItemRenderer : IListItemRenderer
The renderer that is currently rolled over or under the caret. | AdvancedListBase | |
| highlightUID : String
The UID of the item that is current rolled over or under the caret. | AdvancedListBase | |
| horizontalScrollBar : ScrollBar
The horizontal scroll bar. | ScrollControlBase | |
| isKeyPressed : Boolean = false
Contains true if a key press is in progress. | AdvancedDataGridBaseEx | |
| itemRendererToFactoryMap : Dictionary
Maps item renderers to the Factory instacne from which they have been created. | AdvancedDataGridBase | |
| itemsNeedMeasurement : Boolean = true
A flag that indicates whether the columnWidth
and rowHeight properties need to be calculated. | AdvancedListBase | |
| itemsSizeChanged : Boolean = false
A flag that indicates that the size of the renderers may have changed. | AdvancedListBase | |
| iterator : IViewCursor
The main IViewCursor instance used to fetch items from the
data provider and pass the items to the renderers. | AdvancedListBase | |
| iteratorValid : 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 | |
| keySelectionPending : Boolean = false
A flag that indicates if keyboard selection was interrupted by
a page fault. | AdvancedListBase | |
| lastDropIndex : int
The most recently calculated index where the drag item
should be added to the drop target. | AdvancedListBase | |
| lastSeekPending : ListBaseSeekPending
The most recent seek that caused a page fault. | AdvancedListBase | |
| listContent : AdvancedListBaseContentHolder
An internal display object that parents all of the item renderers,
selection and highlighting indicators and other supporting graphics. | AdvancedListBase | |
| listItems : Array
An Array of Arrays that contains
the item renderer instances that render each data provider item. | AdvancedListBase | |
| maskShape : Shape
The mask. | ScrollControlBase | |
| modifiedCollectionView : ModifiedCollectionView
The collection view that temporarily preserves previous
data provider state to facilitate running data change effects. | AdvancedListBase | |
| orderedHeadersList : Array
An ordered list of AdvancedDataGridHeaderInfo instances that
correspond to the visible column headers. | AdvancedDataGridBaseEx | |
| rendererChanged : Boolean = false
A flag that indicates that the renderer changed. | AdvancedListBase | |
| reservedItemRenderers : Object
A hash map of currently unused item renderers that may be
used again in the near future. | AdvancedListBase | |
| resourceManager : IResourceManager [read-only]
A reference to the object which manages
all of the application's localized resources. | UIComponent | |
| rowInfo : Array
An array of ListRowInfo objects that cache row heights and
other tracking information for the rows in the listItems property. | AdvancedListBase | |
| rowMap : Object
A hash map of item renderers to their respective ListRowInfo object. | AdvancedListBase | |
| runDataEffectNextUpdate : Boolean = false
A flag that indicates if a data effect should be initiated
the next time the display is updated. | AdvancedListBase | |
| runningDataEffect : Boolean = false
A flag indicating if a data change effect is currently running
| AdvancedListBase | |
| scrollAreaChanged : 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 | ||
| selectedData : Object
A hash table of ListBaseSelectionData objects that track which
items are currently selected. | AdvancedListBase | |
| selectionIndicators : Object
A hash table of selection indicators. | AdvancedListBase | |
| selectionLayer : Sprite
The layer in listContent where all selection
and highlight indicators are drawn. | AdvancedListBase | |
| selectionTweens : Object
A hash table of selection tweens. | AdvancedListBase | |
| showCaret : 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 | ||
| unconstrainedRenderers : Object
A hash map of item renderers that are not subject
to the layout algorithms of the list
| AdvancedListBase | |
| unscaledHeight : Number [read-only]
A convenience method for determining the unscaled height
of the component. | UIComponent | |
| unscaledWidth : 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 | |
| verticalScrollBar : ScrollBar
The vertical scroll bar. | ScrollControlBase | |
| visibleCellRenderers : Object
A hash table of data provider item renderers currently in view. | AdvancedDataGrid | ||
| visibleData : Object
A hash table of data provider item renderers currently in view. | AdvancedListBase | |
| visibleHeaderInfos : Array
An Array of AdvancedDataGridHeaderRenderer instances that
define the header item renderers for the displayable columns. | AdvancedDataGridBase | |
| wordWrapChanged : 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
| Method | Defined By | ||
|---|---|---|---|
Constructor. | AdvancedDataGrid | ||
|
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | DisplayObjectContainer | |
|
Adds an item renderer if a data change effect is running. | AdvancedListBase | |
| 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 | |
|
Adds a non-visual style client to this component instance. | UIComponent | |
|
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | |
|
Returns the index where the dropped items should be added
to the drop target. | AdvancedListBase | |
|
Queues a function to be called later. | UIComponent | |
|
Deletes a style property from this component instance. | UIComponent | |
Collapses all the nodes of the navigation tree. | AdvancedDataGrid | ||
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | |
|
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
|
Converts a Point object from content to local coordinates. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Creates the item editor for the item renderer at the
editedItemPosition using the editor
specified by the itemEditor property. | AdvancedDataGridBaseEx | |
|
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
This method closes an item editor currently open on an item renderer. | AdvancedDataGridBaseEx | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| [override]
Dispatches an event into the event flow. | UIComponent | |
|
Shows or hides the focus indicator around this component. | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | |
|
Called by the effect instance when it stops playing on the component. | UIComponent | |
|
Called by the effect instance when it starts playing on the component. | UIComponent | |
|
Ends all currently playing effects on the component. | UIComponent | |
|
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
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 | ||
|
Finds an item in the list based on a string
and moves the selection to it. | AdvancedListBase | |
|
Called after printing is complete. | UIComponent | |
|
Provides the automation object at the specified index. | UIComponent | |
|
Provides the automation object list . | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the child display object instance that exists at the specified index. | DisplayObjectContainer | |
|
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
|
Returns the index position of a child DisplayObject instance. | DisplayObjectContainer | |
|
Finds the type selectors for this UIComponent instance. | UIComponent | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
Returns a SortInfo instance containing sorting information for the column. | AdvancedDataGridBaseEx | |
|
Gets the object that currently has focus. | UIComponent | |
|
Returns the element's layout height. | UIComponent | |
|
Returns the element's layout width. | UIComponent | |
|
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
|
Returns the layout transform Matrix3D for this element. | UIComponent | |
|
Returns the element's maximum height. | UIComponent | |
|
Returns the element's maximum width. | UIComponent | |
|
Returns the element's minimum height. | UIComponent | |
|
Returns the element's minimum width. | UIComponent | |
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | |
Returns the parent of a child item. | AdvancedDataGrid | ||
|
Returns the element's preferred height. | UIComponent | |
|
Returns the element's preferred width. | UIComponent | |
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | |
|
Returns 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 | |
|
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
|
Converts a Point object from global to content coordinates. | UIComponent | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
|
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | |
|
Returns true if currentCSSState is not null. | UIComponent | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
|
Hides the drop indicator under the mouse pointer that indicates that a
drag and drop operation is allowed. | AdvancedListBase | |
|
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
Get an item renderer for the index of an item in the data provider,
if one exists. | AdvancedListBase | |
|
Computes the offset into the data provider of the item
at colIndex, rowIndex. | AdvancedListBase | |
|
Initializes the internal structure of this component. | UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
|
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | |
|
Refresh all rows on next update. | AdvancedListBase | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
|
Determines if the item renderer for a data provider item
is 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 | ||
|
Determines if the item renderer for a data provider item
is selectable. | AdvancedListBase | |
|
Determines if the item renderer for a data provider item
is selected. | AdvancedListBase | |
|
Determines if the item renderer for a data provider item
is the item under the caret due to keyboard navigation. | AdvancedListBase | |
|
Determines if an item is being displayed by a renderer. | AdvancedListBase | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Determines whether a renderer contains (or owns) a display object. | AdvancedListBase | |
|
Returns the index of the item in the data provider of the item
being rendered by this item renderer. | AdvancedListBase | |
|
Returns the dataTip string the renderer would display for the given
data object based on the dataTipField and dataTipFunction properties. | AdvancedListBase | |
|
Returns the class for an icon, if any, for a data item,
based on the iconField and iconFunction properties. | AdvancedListBase | |
|
Returns the item renderer for a given item in the data provider,
if there is one. | AdvancedListBase | |
|
Returns the string the renderer would display for the given data object
based on the labelField and labelFunction properties. | AdvancedListBase | |
|
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | |
|
Converts a Point object from local to content coordinates. | UIComponent | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Returns true if cssState matches currentCSSState. | UIComponent | |
|
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
|
Measures a set of items from the data provider using the
current item renderer and returns the sum of the heights
of those items. | AdvancedListBase | |
|
Measures the specified HTML text, which can contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Measures the specified text, assuming that it is displayed
in a single-line UITextField (or UIFTETextField) using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Measures a set of items from the data provider using
the current item renderer and returns the
maximum width found. | AdvancedListBase | |
|
Moves the component to a specified position within its parent. | UIComponent | |
|
Moves focus to the specified column header. | AdvancedDataGridBaseEx | |
|
Propagates style changes to the children. | UIComponent | |
|
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
|
Prepares an IFlexDisplayObject for printing. | UIComponent | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
|
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
|
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | |
|
Removes one or more child DisplayObject instances from the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes an item renderer if a data change effect is running. | AdvancedListBase | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Removes a non-visual style client from this component instance. | UIComponent | |
|
Replays the specified event. | UIComponent | |
|
Raises a virtual keyboard. | InteractiveObject | |
|
Resolves a child by using the id provided. | UIComponent | |
| [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
|
Ensures that the data provider item at the given index is visible. | AdvancedListBase | |
|
Sizes the object. | UIComponent | |
|
Changes the position of an existing child in the display object container. | DisplayObjectContainer | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
|
Set the current state. | UIComponent | |
|
Sets the focus to this component. | UIComponent | |
Sets the associated icon in the navigation tree for the item. | AdvancedDataGrid | ||
|
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
|
Sets the layout size of the element. | UIComponent | |
|
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets a style property on this component instance. | UIComponent | |
|
Called when the visible property changes. | UIComponent | |
|
Displays a drop indicator under the mouse pointer to indicate that a
drag and drop operation is allowed and where the items will
be dropped. | AdvancedListBase | |
|
Lets the user drag the specified sprite. | Sprite | |
|
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | |
|
Ends the startDrag() method. | Sprite | |
|
Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite | |
|
Detects changes to style properties. | UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | |
|
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | |
|
Temporarily stops an item renderer from being positioned
by the control's layout algorithm. | AdvancedListBase | |
|
Validates the position and size of children and draws other
visuals. | UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
|
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
|
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
Returns the primitive value of the specified object. | Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
| Method | Defined By | ||
|---|---|---|---|
|
Converts an absolute column index to the corresponding index in the
displayed columns. | AdvancedDataGridBaseEx | |
|
Converts an absolute column index to the corresponding index in the
visible columns. | AdvancedDataGridBaseEx | |
|
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 | |
addCellSelectionData(uid:String, columnIndex:int, selectionData:AdvancedDataGridBaseSelectionData):void
Adds cell selection information to the control, as if you used the mouse to select the cell. | AdvancedDataGrid | ||
|
Adds the selected items to the DragSource object as part of a
drag-and-drop operation. | AdvancedListBase | |
|
Adds a data field to the list of sort fields. | AdvancedDataGridBaseEx | |
|
Adds a renderer to the recycled renderer list,
making it invisible and cleaning up references to it. | AdvancedListBase | |
|
Adjust the focus rectangle. | UIComponent | |
|
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 | ||
|
Commits the computed matrix built from the combination of the layout
matrix and the transform offsets to the flash displayObject's transform. | UIComponent | |
|
Sets up the effect for applying the selection indicator. | 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 | ||
|
This is an internal method used by the Flex framework
to support the Dissolve effect. | UIComponent | |
|
Calculates the y position of the drop indicator
when performing a drag-and-drop operation. | AdvancedListBase | |
|
Calculates the row height of columns in a row. | AdvancedDataGridBase | |
|
Determines if the call to the measure() method can be skipped. | UIComponent | |
|
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 | ||
|
Clears the set of selected items and removes all graphics
depicting the selected state of those items. | AdvancedListBase | |
Clears the selectedCells property. | AdvancedDataGrid | ||
|
Removes column header separators that you normally use
to resize columns. | AdvancedDataGridBaseEx | |
|
Handles CollectionEvents dispatched from the data provider
as the data changes. | AdvancedListBase | |
|
Returns the index of a column as it is currently displayed. | AdvancedDataGridBaseEx | |
| [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 | |
|
Configures the ScrollBars based on the number of rows and columns and
viewable rows and columns. | AdvancedListBase | |
|
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 | |
|
Makes a copy of the selected items in the order they were
selected. | AdvancedListBase | |
|
Creates the border for this component. | ScrollControlBase | |
| [override]
Create objects that are children of this ListBase, in this case
the listContent object that will hold all the item
renderers. | AdvancedListBase | |
|
Creates the column headers. | AdvancedDataGridBase | |
|
Creates the header separators between column headers,
and populates the separators Array with the separators created. | AdvancedDataGridBaseEx | |
|
Creates a new object using a context
based on the embedded font being used. | UIComponent | |
|
Creates the object using a given moduleFactory. | UIComponent | |
|
Creates the locked rows, if necessary. | AdvancedDataGridBase | |
|
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | |
|
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 | ||
|
Handles DragEvent.DRAG_ENTER events. | AdvancedListBase | |
|
Handles DragEvent.DRAG_EXIT events. | AdvancedListBase | |
|
Handles DragEvent.DRAG_OVER events. | AdvancedListBase | |
|
Interval function that scrolls the list up or down
if the mouse goes above or below the list. | AdvancedListBase | |
|
The default handler for the dragStart event. | AdvancedListBase | |
| 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 | |
|
Draws a column background for a column with the suggested color. | AdvancedDataGridBaseEx | |
|
Draws the background of the headers into the given
UIComponent. | AdvancedDataGridBaseEx | |
| 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 | |
|
Draws a line between rows. | AdvancedDataGridBaseEx | |
| 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 | |
|
Draws lines between columns, and column backgrounds. | AdvancedDataGridBaseEx | |
|
Draws a row background
at the position and height specified using the
color specified. | AdvancedDataGridBaseEx | |
|
Draws any alternating row colors, borders and backgrounds for the rows. | AdvancedListBase | |
| 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 | |
|
Creates and displays the column header separators that the user
normally uses to resize columns. | AdvancedDataGridBaseEx | |
[override]
Draws a vertical line between columns. | AdvancedDataGrid | ||
| 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 | |
|
Tries to find the next item in the data provider that
starts with the character in the eventCode parameter. | AdvancedListBase | |
|
Returns the column index corresponding to the field name of a sortable field. | AdvancedDataGridBaseEx | |
|
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 | ||
|
The event handler called when a UIComponent object gets focus. | UIComponent | |
|
The event handler called when a UIComponent object loses focus. | UIComponent | |
|
Returns the header item renderer. | AdvancedDataGridBase | |
|
Retrieves an already-created item renderer not currently in use. | AdvancedListBase | |
|
Returns the row height. | AdvancedDataGridBase | |
|
Returns the header separators between column headers,
and populates the separators Array with the separators returned. | AdvancedDataGridBaseEx | |
|
Returns the column number of a currently displayed column
as it is currently displayed. | AdvancedDataGridBaseEx | |
|
The column for the data provider item at the given index. | AdvancedListBase | |
|
The row for the data provider item at the given index. | AdvancedListBase | |
|
Initializes the implementation and storage of some of the less frequently
used advanced layout features of a component. | UIComponent | |
|
Finalizes the initialization of this component. | UIComponent | |
|
Initializes this component's accessibility code. | UIComponent | |
|
Initiates a data change effect when there have been changes
in the data provider. | AdvancedListBase | |
Initializes an AdvancedDataGridListData object that is used by the AdvancedDataGrid item renderer. | AdvancedDataGrid | ||
|
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | UIComponent | |
|
Returns true if selectedMode is
SINGLE_CELL or MULTIPLE_CELLS. | AdvancedDataGridBase | |
|
Returns true if the specified row in a column is visible. | AdvancedDataGridBaseEx | |
|
Checks if editing is allowed for a group or summary row. | AdvancedDataGridBaseEx | |
|
Checks if dragging is allowed for a particular column or not. | AdvancedDataGridBaseEx | |
|
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus. | UIComponent | |
|
Returns true if an item renderer is no longer being positioned
by the list's layout algorithm while a data change effect is
running as a result of a call to the unconstrainRenderer() method. | AdvancedListBase | |
|
Return true if selectedMode is
SINGLE_ROW or MULTIPLE_ROWS. | AdvancedDataGridBase | |
|
Returns a Point instance containing the column index and row index of an
item renderer. | AdvancedListBase | |
|
Determines the UID for a data provider item. | AdvancedListBase | |
|
The event handler called for a keyDown event. | UIComponent | |
|
The event handler called for a keyUp event. | UIComponent | |
|
Responds to size changes by setting the positions and sizes
of this control's borders. | ScrollControlBase | |
| 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 | |
| [override]
Calculates the measured width and height of the component based
on the rowCount,
columnCount, rowHeight and
columnWidth properties. | AdvancedListBase | |
|
Handles MouseEvent.MOUSE_CLICK events from any mouse
targets contained in the list including the renderers. | AdvancedListBase | |
|
Handles MouseEvent.MOUSE_DOUBLE_CLICK events from any
mouse targets contained in the list including the renderers. | AdvancedListBase | |
|
Handles MouseEvent.MOUSE_DOWN events from any mouse
targets contained in the list including the renderers. | AdvancedListBase | |
|
Determines which item renderer is under the mouse. | AdvancedListBase | |
|
Handles MouseEvent.MOUSE_MOVE events from any mouse
targets contained in the list including the renderers. | AdvancedListBase | |
|
Handles MouseEvent.MOUSE_OUT events from any mouse targets
contained in the list including the renderers. | AdvancedListBase | |
|
Handles MouseEvent.MOUSE_OVER events from any mouse
targets contained in the list, including the renderers. | AdvancedListBase | |
|
Handles MouseEvent.MOUSE_DOWN events from any mouse
targets contained in the list including the renderers. | AdvancedListBase | |
| [override]
Handles mouseWheel events by changing scroll positions. | AdvancedListBase | |
[override]
Moves the cell and row selection indicators up or down by the given offset
as the control scrolls its display. | AdvancedDataGrid | ||
|
Move the selection and highlight indicators horizontally. | AdvancedListBase | |
|
Move the selection and highlight indicators vertically. | AdvancedListBase | |
|
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 | |
|
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 | ||
|
Cleans up selection highlights and other associated graphics
for a given item in the data provider. | AdvancedListBase | |
|
Removes a data field from the list of sort fields. | AdvancedDataGridBaseEx | |
|
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 | |
|
Determines if there is enough space in this component to display
a given scrollbar. | ScrollControlBase | |
|
Default event handler for the scroll event. | ScrollControlBase | |
|
Adjusts the renderers in response to a change
in scroll position. | AdvancedListBase | |
|
Returns the data provider index for the item at the first visible
row and column for the given scroll positions. | AdvancedListBase | |
|
Changes the value of the horizontalScrollPosition property
to make the specified column visible. | AdvancedDataGridBaseEx | |
|
Adjusts the renderers in response to a change
in scroll position. | AdvancedListBase | |
|
The default failure handler when a seek fails due to a page fault. | AdvancedListBase | |
|
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 | ||
|
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 | ||
|
Sets the rowCount property without causing
invalidation or setting the explicitRowCount
property, which permanently locks in the number of rows. | AdvancedListBase | |
|
Sets the rowHeight property without causing invalidation or
setting of explicitRowHeight which
permanently locks in the height of the rows. | AdvancedListBase | |
|
Causes the ScrollControlBase to show or hide scrollbars based
on the parameters passed in. | ScrollControlBase | |
|
Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent | |
|
Sets the cell defined by uid to use the item renderer
specified by item. | AdvancedDataGridBase | |
|
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 | ||
|
Deselects the specified column header. | AdvancedDataGridBaseEx | |
| [override]
Adds or removes item renderers if the number of displayable items
changed. | AdvancedListBase | |
|
Refreshes all rows now. | AdvancedListBase | |
|
Converts the current visible column index of a column to
its corresponding absolute index. | AdvancedDataGridBaseEx | |
Events
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. | UIComponent | ||
| Dispatched when a display object is added to the display list. | DisplayObject | ||
| Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained. | DisplayObject | ||
| Dispatched when the selectedIndex or selectedItem property changes as a result of user interaction. | AdvancedListBase | ||
| Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu. | InteractiveObject | ||
| Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user changes the width of a column, indicating that the amount of data displayed in that column may have changed. | AdvancedDataGridBaseEx | ||
| Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application. | InteractiveObject | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu. | InteractiveObject | ||
| Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | ||
| Dispatched after the view state has changed. | UIComponent | ||
| Dispatched after the currentState property changes, but before the view state changes. | UIComponent | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu. | InteractiveObject | ||
| Dispatched when the data property changes. | AdvancedListBase | ||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true. | InteractiveObject | ||
| Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent | ||
| Dispatched by the drop target when the user releases the mouse over it. | UIComponent | ||
| Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | ||
| Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | ||
| Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | ||
| Dispatched by the drag initiator when starting a drag operation. | UIComponent | ||
| Dispatched after an effect ends. | UIComponent | ||
| Dispatched just before an effect starts. | UIComponent | ||
| Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent | ||
| [broadcast event] Dispatched when the playhead is entering a new frame. | DisplayObject | ||
| Dispatched after the component has entered a view state. | UIComponent | ||
| [broadcast event] Dispatched when the playhead is exiting the current frame. | DisplayObject | ||
| Dispatched just before the component exits a view state. | UIComponent | ||
| Dispatched after a display object gains focus. | InteractiveObject | ||
| Dispatched after a display object loses focus. | InteractiveObject | ||
| [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run. | DisplayObject | ||
| Dispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a finger from left to right over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| 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 | |||
| Dispatched 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 | ||
| Dispatched 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 index | AdvancedDataGridBaseEx | ||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| This event is dispatched to any client app that supports inline input with an IME | InteractiveObject | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched when the user clicks on an item in the control. | AdvancedListBase | ||
| Dispatched when a branch of the navigation tree is closed or collapsed. | AdvancedDataGrid | |||
| Dispatched when the user double-clicks on an item in the control. | AdvancedListBase | ||
| Dispatched when the editedItemPosition property has been set and the item can be edited. | AdvancedDataGridBaseEx | ||
| Dispatched 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 | ||
| Dispatched when an item editing session ends for any reason. | AdvancedDataGridBaseEx | ||
| Dispatched 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 | ||
| Dispatched 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 | |||
| Dispatched when the user rolls the mouse pointer out of an item in the control. | AdvancedListBase | ||
| Dispatched when the user rolls the mouse pointer over an item in the control. | AdvancedListBase | ||
| Dispatched when the user presses a key. | InteractiveObject | ||
| Dispatched when the user attempts to change focus by using keyboard navigation. | InteractiveObject | ||
| Dispatched when the user releases a key. | InteractiveObject | ||
| Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the middle pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| Dispatched when the user attempts to change focus by using a pointer device. | InteractiveObject | ||
| Dispatched when a user moves the pointing device while it is over an InteractiveObject. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a mouse wheel is spun over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | ||
| Dispatched when the object has moved. | UIComponent | ||
| Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture. | InteractiveObject | ||
| Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop(). | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture enters its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture leaves its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary. | InteractiveObject | ||
| Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu. | InteractiveObject | ||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
| Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold. | InteractiveObject | ||
| Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus away from this InteractiveObject and any of its children while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus over this InteractiveObject from outside the object's tree of descendents in the display list (while remaining within the proximity detection threshold of the screen). | InteractiveObject | ||
| Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent | ||
| Dispatched when a display object is about to be removed from the display list. | DisplayObject | ||
| Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained. | DisplayObject | ||
| [broadcast event] Dispatched when the display list is about to be updated and rendered. | DisplayObject | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the content is scrolled. | ScrollControlBase | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu. | InteractiveObject | ||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched immediately after the soft keyboard is raised. | InteractiveObject | ||
| Dispatched immediately before the soft keyboard is raised. | InteractiveObject | ||
| Dispatched immediately after the soft keyboard is lowered. | InteractiveObject | ||
| Dispatched when sorting is to be performed on the AdvancedDataGrid control. | AdvancedDataGridBaseEx | ||
| Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. | UIComponent | ||
| Dispatched when a component interrupts a transition to its current state in order to switch to a new state. | UIComponent | ||
| Dispatched when the value of the object's tabChildren flag changes. | InteractiveObject | ||
| Dispatched when the object's tabEnabled flag changes. | InteractiveObject | ||
| Dispatched when the value of the object's tabIndex property changes. | InteractiveObject | ||
| Dispatched when a user enters one or more characters of text. | InteractiveObject | ||
| Dispatched by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and is to be discarded soon. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be shown. | UIComponent | ||
| Dispatched by the component when its ToolTip has been shown. | UIComponent | ||
| Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent | ||
| Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture. | UIComponent | ||
| A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture. | UIComponent | ||
| A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture. | UIComponent | ||
| Dispatched when the user moves the point of contact with a touch-enabled device (such as drags a finger across a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | ||
| Dispatched when values are changed programmatically or by user interaction. | UIComponent | ||
Styles
Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.
Common Styles
| Style | Description | Defined By | ||
|---|---|---|---|---|
alternatingItemColors | Type: Array Format: Color CSS Inheritance: yes Colors for rows in an alternating pattern. Value can be an Array of two of more colors. 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 | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
| Type: Class CSS Inheritance: no The border skin class of the component. | ScrollControlBase | ||
| Type: String CSS Inheritance: no Bounding box style. | ScrollControlBase | ||
| Type: String CSS Inheritance: no The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | ScrollControlBase | ||
| Type: Class CSS Inheritance: no The class to use as the skin that indicates that a column can be dropped in the current location. | AdvancedDataGridBaseEx | ||
| Type: Class CSS Inheritance: no The class to use as the skin for a column that is being resized. | AdvancedDataGridBaseEx | ||
| Type: Object CSS Inheritance: no The effect used when changes occur in the control's data provider. | AdvancedListBase | ||
| Type: Class CSS Inheritance: no Name of the class of the itemEditor to be used if one is not specified for a column. | AdvancedDataGridBaseEx | ||
| Type: 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 | ||
| Type: String CSS Inheritance: yes The directionality of the text displayed by the component. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. | ScrollControlBase | ||
| Type: 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 | ||
| Type: Class CSS Inheritance: no The skin to use to indicate where a dragged item can be dropped. | AdvancedListBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
| Type: Number CSS Inheritance: no Specifies the alpha transparency value of the focus skin. | AdvancedListBase | ||
| Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent | ||
| Type: String CSS Inheritance: no Specifies which corners of the focus rectangle should be rounded. | AdvancedListBase | ||
| Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: no Thickness, in pixels, of the focus rectangle outline. | UIComponent | ||
folderClosedIcon | Type: Class Format: EmbeddedFile CSS Inheritance: no Specifies the folder closed icon for a branch 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 | ||
| Type: String CSS Inheritance: yes Sets the antiAliasType property of internal TextFields. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Name of the font to use. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Sets the gridFitType property of internal TextFields that represent text in Flex controls. | ScrollControlBase | ||
| Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls. | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Determines whether the text is italic font. | ScrollControlBase | ||
| Type: Number CSS Inheritance: yes Sets the thickness property of internal TextFields that represent text in Flex controls. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Determines whether the text is boldface. | ScrollControlBase | ||
| Type: 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 | ||
| Type: Array Format: Color CSS Inheritance: yes An array of two colors used to draw the header background gradient. | AdvancedDataGridBaseEx | ||
| Type: 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 | ||
| Type: 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 | ||
| Type: String CSS Inheritance: no The name of a CSS style declaration for controlling other aspects of the appearance of the column headers. | AdvancedDataGridBaseEx | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the horizontal grid lines. | AdvancedDataGridBaseEx | ||
| Type: Boolean CSS Inheritance: no A flag that indicates whether to show horizontal grid lines between the rows. | AdvancedDataGridBaseEx | ||
| Type: 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 | ||
| Type: String CSS Inheritance: no Style name for horizontal scrollbar. | ScrollControlBase | ||
| Type: 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 | ||
| Type: 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 | ||
| Type: String CSS Inheritance: yes The primary interaction mode for this component. | UIComponent | ||
| Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled ( true) or disabled (false). | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: yes Additional vertical space between lines of text. | ScrollControlBase | ||
| Type: String CSS Inheritance: no The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent | ||
| Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes The locale of the text displayed by this component. | ScrollControlBase | ||
openDuration | Type: Number Format: Time CSS Inheritance: no Length of an open or close transition 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 | AdvancedDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no The number of pixels between the bottom of the row and the bottom of the renderer in the row. | 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 | ||
| Type: Number Format: Length CSS Inheritance: no The number of pixels between the top of the row and the top of the renderer in the row. | AdvancedListBase | ||
| Type: String CSS Inheritance: no The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the row background when the user rolls over the row. | AdvancedDataGridBaseEx | ||
| Type: 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 | ||
| Type: 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 | AdvancedDataGrid | ||
| Type: Boolean CSS Inheritance: yes Show the error border or skin when this component is invalid | UIComponent | ||
| Type: Boolean CSS Inheritance: yes Show the error tip when this component is invalid and the user rolls over it | UIComponent | ||
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 | ||
| Type: Class CSS Inheritance: no The class to use as the skin for the cursor that indicates that a column can be resized. | AdvancedDataGridBaseEx | ||
| Type: String CSS Inheritance: yes Alignment of text within a container. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Determines whether the text is underlined. | ScrollControlBase | ||
| Type: Class CSS Inheritance: no The class implementing IUITextField that is used by this component to render text. | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. | ScrollControlBase | ||
textRollOverColor | Type: uint Format: Color CSS Inheritance: yes Color of the text when the user rolls over a row. The default value 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 | ||
| Type: String CSS Inheritance: no The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent | ||
| Type: Boolean CSS Inheritance: no A flag that controls whether items are highlighted as the mouse rolls over them. | AdvancedListBase | ||
| Type: String CSS Inheritance: no The vertical alignment of a renderer in a row. | AdvancedListBase | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the vertical grid lines. | AdvancedDataGridBaseEx | ||
| Type: Boolean CSS Inheritance: no A flag that indicates whether to show vertical grid lines between the columns. | AdvancedDataGridBaseEx | ||
| Type: 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 | ||
| Type: String CSS Inheritance: no Style name for vertical scrollbar. | ScrollControlBase | ||
| Type: 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
Halo Theme Styles
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| DEFAULT_MAX_HEIGHT : Number = 10000 [static]
The default value for the maxHeight property. | UIComponent | |
| DEFAULT_MAX_WIDTH : Number = 10000 [static]
The default value for the maxWidth property. | UIComponent | |
| DEFAULT_MEASURED_HEIGHT : Number = 22 [static]
The default value for the measuredHeight property. | UIComponent | |
| DEFAULT_MEASURED_MIN_HEIGHT : Number = 22 [static]
The default value for the measuredMinHeight property. | UIComponent | |
| DEFAULT_MEASURED_MIN_WIDTH : Number = 40 [static]
The default value for the measuredMinWidth property. | UIComponent | |
| DEFAULT_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 | ||
| MULTIPLE_CELLS : String = "multipleCells" [static]
Constant definition for the selectionMode property
to allow the selection of multiple cells. | AdvancedDataGridBase | |
| MULTIPLE_ROWS : String = "multipleRows" [static]
Constant definition for the selectionMode property
to allow the selection of multiple rows. | AdvancedDataGridBase | |
| NONE : String = "none" [static]
Constant definition for the selectionMode property. | AdvancedDataGridBase | |
| SINGLE_CELL : String = "singleCell" [static]
Constant definition for the selectionMode property
to allow the selection of a single cell. | AdvancedDataGridBase | |
| SINGLE_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.
Related API Elements
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):voiddisplayItemsExpanded | 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):voidfirstVisibleItem | 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):voidgroupedColumns | 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):voidgroupIconFunction | 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):voidgroupItemRenderer | 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):voidgroupLabelFunction | 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):voidgroupRowHeight | property |
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):voidRelated API Elements
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.
Related API Elements
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):voidlockedRowCount | 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):voidrendererProviders | 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):voidselectedCells | 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:
selectionMode | Value of rowIndex and columnIndex properties |
|---|---|
| none | No 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}] |
multipleRows | Click 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} ] |
singleCell | Click any cell to select the cell.
After the selection, selectedCells contains a single Object:
[{rowIndex: selectedRowIndex, columnIndex:selectedColIndex}] |
multipleCells | Click 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):voidselectedColumnIndex | 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):voidtreeColumnIndex | property |
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.
|
Related API Elements
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.
|
Boolean — true 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 |
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)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)open event
after the open animation is complete (true), or not (false).
| |
cause:Event (default = null) |
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.
|
* — 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.
|
Boolean — true 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:Boolean — true 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:Boolean — true to specify that the Shift key is pressed,
and false if not.
| |
ctrlKey:Boolean — true to specify that the Control key is pressed,
and false if not.
| |
transition:Boolean (default = true)true to animate the transition.
|
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:Boolean — true if the Shift key was held down when
the mouse was clicked.
| |
ctrlKey:Boolean — true 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.
|
Boolean — true 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.
|
Boolean — true if the keyboard navigation is handled correctly.
|
Event Detail
headerDragOutside | Event |
Event Object Type:
property AdvancedDataGridEvent.type =
mx.events.AdvancedDataGridEventproperty 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 thetype 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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
columnIndex | The zero-based index of the
item's column in the AdvancedDataGrid object's columns array. |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
dataField | The name of the field or property in the data associated with the column. |
itemRenderer | The header renderer that is being released. |
localX | NaN |
reason | null |
rowIndex | null |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | AdvancedDataGridEvent.HEADER_RELEASE |
headerDropOutside | Event |
Event Object Type:
property AdvancedDataGridEvent.type =
mx.events.AdvancedDataGridEventproperty 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 thetype property of the event object for a
headerDropOutside event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
columnIndex | The zero-based index of the
item's column in the AdvancedDataGrid object's columns array. |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
dataField | The name of the field or property in the data associated with the column. |
item | The AdvancedDataGrid item (node) that closed. |
itemRenderer | The header renderer that is being released. |
localX | NaN |
multiColumnSort | false |
reason | null |
removeColumnFromSort | false |
rowIndex | null |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
triggerEvent | If the node closed in response to a user action, identifies it as a keyboard action or a mouse action. |
type | AdvancedDataGridEvent.HEADER_RELEASE |
itemClose | Event |
Event Object Type:
property AdvancedDataGridEvent.type =
mx.events.AdvancedDataGridEventproperty 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.
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
dataField | The name of the field or property in the data associated with the column. |
item | The AdvancedDataGrid item (node) that closed. |
itemRenderer | The ListItemRenderer for the node that closed. |
localX | NaN |
multiColumnSort | false |
removeColumnFromSort | false |
rowIndex | -1 |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
triggerEvent | If the node closed in response to a user action, identifies it as a keyboard action or a mouse action. |
type | AdvancedDataGridEvent.ITEM_CLOSE |
itemOpen | Event |
Event Object Type:
property AdvancedDataGridEvent.type =
mx.events.AdvancedDataGridEventproperty 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.
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
item | The AdvancedDataGrid node that opened. |
itemRenderer | The ListItemRenderer for the item (node) that opened. |
localX | NaN |
multiColumnSort | false |
removeColumnFromSort | false |
rowIndex | -1 |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
triggerEvent | If the item (node) opened in response to a user action, identifies it as a keyboard action or a mouse action. |
type | AdvancedDataGridEvent.ITEM_OPEN |
itemOpening | Event |
Event Object Type:
property AdvancedDataGridEvent.type =
mx.events.AdvancedDataGridEventproperty 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.
| Property | Value |
|---|---|
animate | Whether to animate the opening or closing operation. |
bubbles | false |
cancelable | true |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event
listener, myButton is the value of the currentTarget. |
dispatchEvent | Whether to dispatch an
ITEM_OPEN or ITEM_CLOSE event
after the open or close animation is complete. true |
item | The AdvancedDataGrid node that opened. |
itemRenderer | The ListItemRenderer for the item (node) that opened. |
localX | NaN |
multiColumnSort | false |
removeColumnFromSort | false |
rowIndex | -1 |
opening | true if the item is opening, false
if it is closing. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
triggerEvent | If the item opened in response to a user action, identifies it as a keyboard action or a mouse action. |
type | AdvancedDataGridEvent.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.
Examples How to use this example
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>
Mon Nov 28 2011, 06:48 AM -08:00