| Package | mx.controls |
| Class | public class AdvancedDataGridBaseEx |
| Inheritance | AdvancedDataGridBaseEx  AdvancedDataGridBase AdvancedListBase ScrollControlBase UIComponent FlexSprite flash.display.Sprite |
| Implements | IIMESupport |
| Subclasses | AdvancedDataGrid |
| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Hide MXML Syntax
The <mx:AdvancedDataGridBaseEx> tag inherits all of the tag attributes
of its superclass, except for labelField, iconField,
and iconFunction, and adds the following tag attributes:
Show MXML Syntax
<mx:AdvancedDataGridBaseEx
Properties
columns="From dataProvider"
draggableColumns="true|false"
editable="item group summary"
editedItemPosition="null"
horizontalScrollPosition="null"
imeMode="null"
itemEditorInstance="null"
lookAheadDuratio="400"
minColumnWidth="NaN"
resizableColumns="true|false"
sortableColumns="true|false"
sortExpertMode="false|true"
Styles
columnDropIndicatorSkin="DataGridColumnDropIndicator"
columnResizeSkin="DataGridColumnResizeSkin"
disabledIconColor="0x999999"
headerBackgroundSkin="DataGridHeaderSeparator"
headerColors="[#FFFFFF, #E6E6E6]"
headerDragProxyStyleName="headerDragProxyStyle"
headerHorizontalSeparatorSkin="AdvancedDataGridHeaderHorizontalSeparator"
headerSeparatorSkin="DataGridHeaderSeparator"
headerStyleName="No default"
horizontalGridLineColor="No default"
horizontalGridLines="false|true"
horizontalLockedSeparatorSkin="undefined"
horizontalSeparatorSkin="undefined"
iconColor="0x111111"
rollOverColor="#E3FFD6"
selectionColor="#CDFFC1"
stretchCursor="DataGridStretchCursor"
verticalGridLineColor="#666666"
verticalGridLines="false|true"
verticalLockedSeparatorSkin="undefined"
verticalSeparatorSkin="undefined"
Events
columnStretch="No default"
headerRelease="No default"
headerShift="No default"
itemEditBegin="No default"
itemEditBeginning="No default"
itemEditEnd="No default"
itemFocusIn="No default"
itemFocusOut="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
See also
| 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 | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| fontContext : IFlexModuleFactory
The module factory that provides the font context for this component. | AdvancedDataGridBase | |
| 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 | |
| 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 | ||
| 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 | |
| lockedColumnCount : int
The index of the first column in the control that scrolls,
where the first column is at an index of 0. | AdvancedListBase | |
| lockedRowCount : int
The index of the first row in the control that scrolls,
where the first row is at an index of 0. | AdvancedListBase | |
| 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 | |
| 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 | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| MXMLDescriptor : Array [read-only] | UIComponent | |
| MXMLProperties : Array [read-only] | UIComponent | |
| 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 | |
| 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 : 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 | |
| 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 | |
| rotation : Number [override] | 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]
| UIComponent | |
| rowCount : int
Number of rows to be displayed. | AdvancedListBase | |
| rowHeight : Number
The height of the rows in pixels. | AdvancedListBase | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 : 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 | |
| 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 | |
| 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]
| UIComponent | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | AdvancedDataGridBaseEx | ||
| addDataEffectItem(item:Object):void
Adds an item renderer if a data change effect is running. | AdvancedListBase | |
| addStyleClient(styleClient:IAdvancedStyleClient):void
Adds a non-visual style client to this component instance. | UIComponent | |
| calculateDropIndex(event:DragEvent = null):int
Returns the index where the dropped items should be added
to the drop target. | AdvancedListBase | |
| callLater(method:Function, args:Array = null):void
Queues a function to be called later. | UIComponent | |
| clearStyle(styleProp:String):void
Deletes a style property from this component instance. | UIComponent | |
| contentToGlobal(point:Point):Point
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
| contentToLocal(point:Point):Point
Converts a Point object from content to local coordinates. | UIComponent | |
| createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within
this container. | UIComponent | |
| createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object
Returns a set of properties as automation IDs that identify the child within
this container. | UIComponent | |
createItemEditor(colIndex:int, rowIndex:int):void
Creates the item editor for the item renderer at the
editedItemPosition using the editor
specified by the itemEditor property. | AdvancedDataGridBaseEx | ||
| createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
| deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
destroyItemEditor():void
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 | |
| dispatchEvent(event:Event):Boolean [override]
Dispatches an event into the event flow. | UIComponent | |
| drawFocus(isFocused:Boolean):void
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 | |
| effectFinished(effectInst:IEffectInstance):void
Called by the effect instance when it stops playing on the component. | UIComponent | |
| effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component. | UIComponent | |
| endEffectsStarted():void
Ends all currently playing effects on the component. | UIComponent | |
| executeBindings(recurse:Boolean = false):void
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
| findString(str:String):Boolean
Finds an item in the list based on a string
and moves the selection to it. | AdvancedListBase | |
| finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete. | UIComponent | |
| generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array | UIComponent | |
| generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):* | UIComponent | |
| getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index. | UIComponent | |
| getAutomationChildren():Array
Provides the automation object list . | UIComponent | |
| getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
| getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
| getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance. | UIComponent | |
| getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
| getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
| getExplicitOrMeasuredWidth():Number
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 | ||
| getFocus():InteractiveObject
Gets the object that currently has focus. | UIComponent | |
| getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height. | UIComponent | |
| getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width. | UIComponent | |
| getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
| getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
| getLayoutMatrix():Matrix
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
| getLayoutMatrix3D():Matrix3D
Returns the layout transform Matrix3D for this element. | UIComponent | |
| getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height. | UIComponent | |
| getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width. | UIComponent | |
| getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height. | UIComponent | |
| getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width. | UIComponent | |
| getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height. | UIComponent | |
| getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width. | UIComponent | |
| getRendererSemanticValue(target:Object, semanticProperty:String):Object
Returns the value for a particular semantic property of
an item renderer, or null if that property is not defined,
while a data effect is running. | AdvancedListBase | |
| getRepeaterItem(whichRepeater:int = -1):Object
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
| getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
| getVisibleRect(targetParent:DisplayObject = null):Rectangle
Get the bounds of this object that are visible to the user
on the screen. | UIComponent | |
| globalToContent(point:Point):Point
Converts a Point object from global to content coordinates. | UIComponent | |
| hasCSSState():Boolean
Returns true if currentCSSState is not null. | UIComponent | |
| hasState(stateName:String):Boolean
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
| hideDropFeedback(event:DragEvent):void
Hides the drop indicator under the mouse pointer that indicates that a
drag and drop operation is allowed. | AdvancedListBase | |
| horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
| indexToItemRenderer(index:int):IListItemRenderer
Get an item renderer for the index of an item in the data provider,
if one exists. | AdvancedListBase | |
| indicesToIndex(rowIndex:int, colIndex:int):int
Computes the offset into the data provider of the item
at colIndex, rowIndex. | AdvancedListBase | |
| initialize():void
Initializes the internal structure of this component. | UIComponent | |
| initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
| invalidateDisplayList():void
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
| invalidateLayering():void
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
| invalidateLayoutDirection():void
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | |
| invalidateList():void
Refresh all rows on next update. | AdvancedListBase | |
| invalidateProperties():void
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
| invalidateSize():void
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
| isItemHighlighted(data:Object):Boolean
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 | |
| isItemSelectable(data:Object):Boolean
Determines if the item renderer for a data provider item
is selectable. | AdvancedListBase | |
| isItemSelected(data:Object):Boolean
Determines if the item renderer for a data provider item
is selected. | AdvancedListBase | |
| isItemShowingCaret(data:Object):Boolean
Determines if the item renderer for a data provider item
is the item under the caret due to keyboard navigation. | AdvancedListBase | |
| isItemVisible(item:Object):Boolean
Determines if an item is being displayed by a renderer. | AdvancedListBase | |
| itemRendererContains(renderer:IListItemRenderer, object:DisplayObject):Boolean
Determines whether a renderer contains (or owns) a display object. | AdvancedListBase | |
| itemRendererToIndex(itemRenderer:IListItemRenderer):int
Returns the index of the item in the data provider of the item
being rendered by this item renderer. | AdvancedListBase | |
| itemToDataTip(data:Object):String
Returns the dataTip string the renderer would display for the given
data object based on the dataTipField and dataTipFunction properties. | AdvancedListBase | |
| itemToIcon(data:Object):Class
Returns the class for an icon, if any, for a data item,
based on the iconField and iconFunction properties. | AdvancedListBase | |
| itemToItemRenderer(item:Object):IListItemRenderer
Returns the item renderer for a given item in the data provider,
if there is one. | AdvancedListBase | |
| itemToLabel(data:Object):String
Returns the string the renderer would display for the given data object
based on the labelField and labelFunction properties. | AdvancedListBase | |
| localToContent(point:Point):Point
Converts a Point object from local to content coordinates. | UIComponent | |
| matchesCSSState(cssState:String):Boolean
Returns true if cssState matches currentCSSState. | UIComponent | |
| matchesCSSType(cssType:String):Boolean
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
| measureHeightOfItems(index:int = -1, count:int = 0):Number
Measures a set of items from the data provider using the
current item renderer and returns the sum of the heights
of those items. | AdvancedListBase | |
| measureHTMLText(htmlText:String):TextLineMetrics
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 | |
| measureText(text:String):TextLineMetrics
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 | |
| measureWidthOfItems(index:int = -1, count:int = 0):Number
Measures a set of items from the data provider using
the current item renderer and returns the
maximum width found. | AdvancedListBase | |
| move(x:Number, y:Number):void
Moves the component to a specified position within its parent. | UIComponent | |
moveFocusToHeader(columnIndex:int = -1):void
Moves focus to the specified column header. | AdvancedDataGridBaseEx | ||
| notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children. | UIComponent | |
| owns(child:DisplayObject):Boolean
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
| parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
| prepareToPrint(target:IFlexDisplayObject):Object
Prepares an IFlexDisplayObject for printing. | UIComponent | |
| regenerateStyleCache(recursive:Boolean):void
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 | |
| registerEffects(effects:Array):void
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
| removeDataEffectItem(item:Object):void
Removes an item renderer if a data change effect is running. | AdvancedListBase | |
| removeStyleClient(styleClient:IAdvancedStyleClient):void
Removes a non-visual style client from this component instance. | UIComponent | |
| replayAutomatableEvent(event:Event):Boolean
Replays the specified event. | UIComponent | |
| resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided. | UIComponent | |
| resumeBackgroundProcessing():void [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
| scrollToIndex(index:int):Boolean
Ensures that the data provider item at the given index is visible. | AdvancedListBase | |
| setActualSize(w:Number, h:Number):void
Sizes the object. | UIComponent | |
| setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
| setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state. | UIComponent | |
| setFocus():void
Sets the focus to this component. | UIComponent | |
| setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
| setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element. | UIComponent | |
| setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
| setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
| setMXMLDescriptor(value:Array):void | UIComponent | |
| setMXMLProperties(value:Array):void | UIComponent | |
| setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance. | UIComponent | |
| setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes. | UIComponent | |
| showDropFeedback(event:DragEvent):void
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 | |
| styleChanged(styleProp:String):void
Detects changes to style properties. | UIComponent | |
| stylesInitialized():void
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| suspendBackgroundProcessing():void [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
| toString():String [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 | |
| transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | |
| unconstrainRenderer(item:Object):void
Temporarily stops an item renderer from being positioned
by the control's layout algorithm. | AdvancedListBase | |
| validateDisplayList():void
Validates the position and size of children and draws other
visuals. | UIComponent | |
| validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
| validateProperties():void
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
| validateSize(recursive:Boolean = false):void
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
| validationResultHandler(event:ValidationResultEvent):void
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
| verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
| Method | Defined By | ||
|---|---|---|---|
absoluteToDisplayColumnIndex(columnIndex:int):int
Converts an absolute column index to the corresponding index in the
displayed columns. | AdvancedDataGridBaseEx | ||
absoluteToVisibleColumnIndex(columnIndex:int):int
Converts an absolute column index to the corresponding index in the
visible columns. | AdvancedDataGridBaseEx | ||
absoluteToVisibleIndices(rowIndex:int, columnIndex:int):Object
Convert an absolute row index and column index into the corresponding
row index and column index of the item as it is currently displayed by the control. | AdvancedDataGridBaseEx | ||
| addDragData(dragSource:Object):void
Adds the selected items to the DragSource object as part of a
drag-and-drop operation. | AdvancedListBase | |
| addMXMLChildren(comps:Array):void | UIComponent | |
addSortField(columnName:String, columnNumber:int, collection:ICollectionView):void
Adds a data field to the list of sort fields. | AdvancedDataGridBaseEx | ||
| addToFreeItemRenderers(item:IListItemRenderer):void
Adds a renderer to the recycled renderer list,
making it invisible and cleaning up references to it. | AdvancedListBase | |
| adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle. | UIComponent | |
| adjustListContent(unscaledWidth:Number = -1, unscaledHeight:Number = -1):void
Called from the updateDisplayList() method to
adjust the size and position of list content. | AdvancedListBase | |
| applyComputedMatrix():void
Commits the computed matrix built from the combination of the layout
matrix and the transform offsets to the flash displayObject's transform. | UIComponent | |
| applySelectionEffect(indicator:Sprite, uid:String, itemRenderer:IListItemRenderer):void
Sets up the effect for applying the selection indicator. | AdvancedListBase | |
| attachOverlay():void
This is an internal method used by the Flex framework
to support the Dissolve effect. | UIComponent | |
| calculateDropIndicatorY(rowCount:Number, rowNum:int):Number
Calculates the y position of the drop indicator
when performing a drag-and-drop operation. | AdvancedListBase | |
| calculateRowHeight(data:Object, hh:Number, skipVisible:Boolean = false):Number
Calculates the row height of columns in a row. | AdvancedDataGridBase | |
| canSkipMeasurement():Boolean
Determines if the call to the measure() method can be skipped. | UIComponent | |
| childrenCreated():void
Performs any final processing after child objects are created. | UIComponent | |
| clearIndicators():void [override]
Removes all selection and highlight and caret indicators. | AdvancedDataGridBase | |
| clearSelected(transition:Boolean = false):void
Clears the set of selected items and removes all graphics
depicting the selected state of those items. | AdvancedListBase | |
clearSeparators():void
Removes column header separators that you normally use
to resize columns. | AdvancedDataGridBaseEx | ||
| collectionChangeHandler(event:Event):void
Handles CollectionEvents dispatched from the data provider
as the data changes. | AdvancedListBase | |
colNumToIndex(colNum:int):int
Returns the index of a column as it is currently displayed. | AdvancedDataGridBaseEx | ||
| commitProperties():void [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 | |
| configureScrollBars():void
Configures the ScrollBars based on the number of rows and columns and
viewable rows and columns. | AdvancedListBase | |
| copyItemWithUID(item:Object):Object
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 | |
| copySelectedItems(useDataField:Boolean = true):Array
Makes a copy of the selected items in the order they were
selected. | AdvancedListBase | |
| createBorder():void
Creates the border for this component. | ScrollControlBase | |
| createChildren():void [override]
Create objects that are children of this ListBase, in this case
the listContent object that will hold all the item
renderers. | AdvancedListBase | |
| createHeaders(left:Number, top:Number):void
Creates the column headers. | AdvancedDataGridBase | |
createHeaderSeparators(n:int, seperators:Array, headerLines:UIComponent):void
Creates the header separators between column headers,
and populates the separators Array with the separators created. | AdvancedDataGridBaseEx | ||
| createInFontContext(classObj:Class):Object
Creates a new object using a context
based on the embedded font being used. | UIComponent | |
| createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
Creates the object using a given moduleFactory. | UIComponent | |
| createLockedRows(left:Number, top:Number, right:Number, bottom:Number):void
Creates the locked rows, if necessary. | AdvancedDataGridBase | |
| dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | |
displayToAbsoluteColumnIndex(columnIndex:int):int
Converts the current display column index of a column to
its corresponding absolute index. | AdvancedDataGridBaseEx | ||
| dragCompleteHandler(event:DragEvent):void
Handles DragEvent.DRAG_COMPLETE events. | AdvancedListBase | |
| dragDropHandler(event:DragEvent):void
Handles DragEvent.DRAG_DROP events. | AdvancedListBase | |
| dragEnterHandler(event:DragEvent):void
Handles DragEvent.DRAG_ENTER events. | AdvancedListBase | |
| dragExitHandler(event:DragEvent):void
Handles DragEvent.DRAG_EXIT events. | AdvancedListBase | |
| dragOverHandler(event:DragEvent):void
Handles DragEvent.DRAG_OVER events. | AdvancedListBase | |
| dragScroll():void
Interval function that scrolls the list up or down
if the mouse goes above or below the list. | AdvancedListBase | |
| dragStartHandler(event:DragEvent):void
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 | |
drawColumnBackground(s:Sprite, columnIndex:int, color:uint, column:AdvancedDataGridColumn):void
Draws a column background for a column with the suggested color. | AdvancedDataGridBaseEx | ||
drawHeaderBackground(headerBG:UIComponent):void
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 | |
drawHorizontalLine(s:Sprite, rowIndex:int, color:uint, y:Number):void
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 | ||
drawRowBackground(s:Sprite, rowIndex:int, y:Number, height:Number, color:uint, dataIndex:int):void
Draws a row background
at the position and height specified using the
color specified. | AdvancedDataGridBaseEx | ||
| drawRowBackgrounds():void
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 | |
drawSeparators():void
Creates and displays the column header separators that the user
normally uses to resize columns. | AdvancedDataGridBaseEx | ||
drawVerticalLine(s:Sprite, colIndex:int, color:uint, x:Number):void
Draws lines between columns. | AdvancedDataGridBaseEx | ||
| 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 | |
findHeaderRenderer(pt:Point):IListItemRenderer
A helper method to determine which item renderer is under the mouse. | AdvancedDataGridBaseEx | ||
| findKey(eventCode:int):Boolean
Tries to find the next item in the data provider that
starts with the character in the eventCode parameter. | AdvancedListBase | |
findRenderer(pt:Point, items:Array, info:Array, yy:Number = 0):IListItemRenderer
A helper method to determine which item renderer is under the mouse. | AdvancedDataGridBaseEx | ||
findSortField(name:String):int
Returns the column index corresponding to the field name of a sortable field. | AdvancedDataGridBaseEx | ||
| finishDataChangeEffect(event:EffectEvent):void
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 | |
| finishKeySelection():void
Sets selected items based on the caretIndex and
anchorIndex properties. | AdvancedListBase | |
| focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus. | UIComponent | |
| focusOutHandler(event:FocusEvent):void
The event handler called when a UIComponent object loses focus. | UIComponent | |
| generateMXMLAttributes(data:Array):void | UIComponent | |
| generateMXMLInstances(document:Object, data:Array, recursive:Boolean = true):void | UIComponent | |
| generateMXMLObject(document:Object, data:Array):Object | UIComponent | |
|
Returns the header item renderer. | AdvancedDataGridBase | |
| getReservedOrFreeItemRenderer(data:Object):IListItemRenderer
Retrieves an already-created item renderer not currently in use. | AdvancedListBase | |
| getRowHeight(itemData:Object = null):Number
Returns the row height. | AdvancedDataGridBase | |
Returns the header separators between column headers,
and populates the separators Array with the separators returned. | AdvancedDataGridBaseEx | ||
indexToColNum(columnIndex:int):int
Returns the column number of a currently displayed column
as it is currently displayed. | AdvancedDataGridBaseEx | ||
| indexToColumn(index:int):int
The column for the data provider item at the given index. | AdvancedListBase | |
| indexToRow(index:int):int
The row for the data provider item at the given index. | AdvancedListBase | |
| initAdvancedLayoutFeatures():void
Initializes the implementation and storage of some of the less frequently
used advanced layout features of a component. | UIComponent | |
| initializationComplete():void
Finalizes the initialization of this component. | UIComponent | |
| initializeAccessibility():void
Initializes this component's accessibility code. | UIComponent | |
| initiateDataChangeEffect(unscaledWidth:Number, unscaledHeight:Number):void
Initiates a data change effect when there have been changes
in the data provider. | AdvancedListBase | |
|
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | UIComponent | |
| isCellSelectionMode():Boolean
Returns true if selectedMode is
SINGLE_CELL or MULTIPLE_CELLS. | AdvancedDataGridBase | |
isColumnFullyVisible(columnIndex:int, rowIndex:int = -1):Boolean
Returns true if the specified row in a column is visible. | AdvancedDataGridBaseEx | ||
isDataEditable(data:Object):Boolean
Checks if editing is allowed for a group or summary row. | AdvancedDataGridBaseEx | ||
isDraggingAllowed(draggedColumn:AdvancedDataGridColumn):Boolean
Checks if dragging is allowed for a particular column or not. | AdvancedDataGridBaseEx | ||
| isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus. | UIComponent | |
| isRendererUnconstrained(item:Object):Boolean
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 | |
| isRowSelectionMode():Boolean
Return true if selectedMode is
SINGLE_ROW or MULTIPLE_ROWS. | AdvancedDataGridBase | |
| itemRendererToIndices(item:IListItemRenderer):Point
Returns a Point instance containing the column index and row index of an
item renderer. | AdvancedListBase | |
| itemToUID(data:Object):String
Determines the UID for a data provider item. | AdvancedListBase | |
| keyDownHandler(event:KeyboardEvent):void
The event handler called for a keyDown event. | UIComponent | |
| keyUpHandler(event:KeyboardEvent):void
The event handler called for a keyUp event. | UIComponent | |
| layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void
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 | |
| measure():void [override]
Calculates the measured width and height of the component based
on the rowCount,
columnCount, rowHeight and
columnWidth properties. | AdvancedListBase | |
| mouseClickHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_CLICK events from any mouse
targets contained in the list including the renderers. | AdvancedListBase | |
| mouseDoubleClickHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_DOUBLE_CLICK events from any
mouse targets contained in the list including the renderers. | AdvancedListBase | |
| mouseDownHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_DOWN events from any mouse
targets contained in the list including the renderers. | AdvancedListBase | |
| mouseEventToItemRenderer(event:MouseEvent):IListItemRenderer
Determines which item renderer is under the mouse. | AdvancedListBase | |
| mouseMoveHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_MOVE events from any mouse
targets contained in the list including the renderers. | AdvancedListBase | |
| mouseOutHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_OUT events from any mouse targets
contained in the list including the renderers. | AdvancedListBase | |
| mouseOverHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_OVER events from any mouse
targets contained in the list, including the renderers. | AdvancedListBase | |
| mouseUpHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_DOWN events from any mouse
targets contained in the list including the renderers. | AdvancedListBase | |
| mouseWheelHandler(event:MouseEvent):void [override]
Handles mouseWheel events by changing scroll positions. | AdvancedListBase | |
| moveIndicatorsHorizontally(uid:String, moveBlockDistance:Number):void
Move the selection and highlight indicators horizontally. | AdvancedListBase | |
| moveIndicatorsVertically(uid:String, moveBlockDistance:Number):void
Move the selection and highlight indicators vertically. | AdvancedListBase | |
| moveSelectionHorizontally(code:uint, shiftKey:Boolean, ctrlKey:Boolean):void
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 | |
| moveSelectionVertically(code:uint, shiftKey:Boolean, ctrlKey:Boolean):void
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 | |
| removeIndicators(uid:String):void
Cleans up selection highlights and other associated graphics
for a given item in the data provider. | AdvancedListBase | |
removeSortField(columnName:String, columnNumber:int, collection:ICollectionView):void
Removes a data field from the list of sort fields. | AdvancedDataGridBaseEx | ||
| resourcesChanged():void
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 | |
| roomForScrollBar(bar:ScrollBar, unscaledWidth:Number, unscaledHeight:Number):Boolean
Determines if there is enough space in this component to display
a given scrollbar. | ScrollControlBase | |
| scrollHandler(event:Event):void
Default event handler for the scroll event. | ScrollControlBase | |
| scrollHorizontally(pos:int, deltaPos:int, scrollUp:Boolean):void
Adjusts the renderers in response to a change
in scroll position. | AdvancedListBase | |
| scrollPositionToIndex(horizontalScrollPosition:int, verticalScrollPosition:int):int
Returns the data provider index for the item at the first visible
row and column for the given scroll positions. | AdvancedListBase | |
scrollToViewColumn(newColumnIndex:int, columnIndex:int):void
Changes the value of the horizontalScrollPosition property
to make the specified column visible. | AdvancedDataGridBaseEx | ||
| scrollVertically(pos:int, deltaPos:int, scrollUp:Boolean):void
Adjusts the renderers in response to a change
in scroll position. | AdvancedListBase | |
| seekPendingFailureHandler(data:Object, info:ListBaseSeekPending):void
The default failure handler when a seek fails due to a page fault. | AdvancedListBase | |
| seekPendingResultHandler(data:Object, info:ListBaseSeekPending):void
The default result handler when a seek fails due to a page fault. | AdvancedListBase | |
selectColumnHeader(columnNumber:int):void
Selects the specified column header. | AdvancedDataGridBaseEx | ||
| selectItem(item:IListItemRenderer, shiftKey:Boolean, ctrlKey:Boolean, transition:Boolean = true):Boolean
Updates the set of selected items given that the item renderer provided
was clicked by the mouse and the keyboard modifiers are in the given
state. | AdvancedListBase | |
| setRowCount(v:int):void
Sets the rowCount property without causing
invalidation or setting the explicitRowCount
property, which permanently locks in the number of rows. | AdvancedListBase | |
| setRowHeight(v:Number):void
Sets the rowHeight property without causing invalidation or
setting of explicitRowHeight which
permanently locks in the height of the rows. | AdvancedListBase | |
| setScrollBarProperties(totalColumns:int, visibleColumns:int, totalRows:int, visibleRows:int):void
Causes the ScrollControlBase to show or hide scrollbars based
on the parameters passed in. | ScrollControlBase | |
| setStretchXY(stretchX:Number, stretchY:Number):void
Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent | |
| setVisibleDataItem(uid:String, item:IListItemRenderer):void
Sets the cell defined by uid to use the item renderer
specified by item. | AdvancedDataGridBase | |
| stateChanged(oldState:String, newState:String, recursive:Boolean):void
This method is called when a state changes to check whether
state-specific styles apply to this component. | UIComponent | |
unselectColumnHeader(columnNumber:int, completely:Boolean = false):void
Deselects the specified column header. | AdvancedDataGridBaseEx | ||
| updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override]
Adds or removes item renderers if the number of displayable items
changed. | AdvancedListBase | |
| updateList():void
Refreshes all rows now. | AdvancedListBase | |
visibleToAbsoluteColumnIndex(columnIndex:int):int
Converts the current visible column index of a column to
its corresponding absolute index. | AdvancedDataGridBaseEx | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| 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 the selectedIndex or selectedItem property changes as a result of user interaction. | AdvancedListBase | ||
| 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 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 data property changes. | AdvancedListBase | ||
| 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 | ||
| Dispatched after the component has entered a view state. | UIComponent | ||
| Dispatched just before the component exits a view state. | UIComponent | ||
| 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 | ||
| 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 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 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 from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| 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 at the beginning of the component initialization sequence. | UIComponent | ||
| Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when the content is scrolled. | ScrollControlBase | ||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| 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 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 | ||
| 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 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 | ||
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Accent color used by component skins. | ScrollControlBase | ||
| Type: Array Format: Color CSS Inheritance: yes The colors to use for the backgrounds of the items in the list. | AdvancedListBase | ||
| Type: Number CSS Inheritance: no Theme: halo Alpha level of the color defined by the backgroundColor property, of the image or SWF file defined by the backgroundImage style. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: no Theme: halo Background color of a component. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: halo Background color of the component when it is disabled. | ScrollControlBase | ||
| Type: Object Format: File CSS Inheritance: no Theme: halo Background image of a component. | ScrollControlBase | ||
| Type: String CSS Inheritance: no Theme: halo Scales the image specified by backgroundImage to different percentage sizes. | ScrollControlBase | ||
| 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: Number CSS Inheritance: no Theme: spark Alpha of the border. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: no Theme: halo, spark Color of the border. | ScrollControlBase | ||
| Type: String CSS Inheritance: no Theme: halo Bounding box sides. | ScrollControlBase | ||
| Type: Class CSS Inheritance: no The border skin class of the component. | ScrollControlBase | ||
| Type: String CSS Inheritance: no Bounding box style. | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: no Theme: halo Bounding box thickness. | ScrollControlBase | ||
| Type: Boolean CSS Inheritance: no Theme: spark Visibility of the border. | 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 Theme: spark The main color for a component. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | ScrollControlBase | ||
columnDropIndicatorSkin | Type: Class CSS Inheritance: no The class to use as the skin that indicates that a column can be dropped in the current location. The default value is mx.skins.halo.DataGridColumnDropIndicator (for both Halo and Spark themes). | AdvancedDataGridBaseEx | ||
columnResizeSkin | Type: Class CSS Inheritance: no The class to use as the skin for a column that is being resized. The default value is mx.skins.halo.DataGridColumnResizeSkin (for both Halo and Spark themes). | AdvancedDataGridBaseEx | ||
| Type: Number CSS Inheritance: yes Theme: spark The alpha of the content background for this component. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of the content area of the component. | ScrollControlBase | ||
| Type: Object CSS Inheritance: no The effect used when changes occur in the control's data provider. | AdvancedListBase | ||
defaultDataGridItemEditor | Type: Class CSS Inheritance: no Name of the class of the itemEditor to be used if one is not specified for a column. This is a way to set an item editor for a group of AdvancedDataGrids instead of having to set each one individually. If you set the AdvancedDataGridColumn's itemEditor property, it supercedes this value. The default value is null. | AdvancedDataGridBaseEx | ||
defaultDataGridItemRenderer | Type: Class CSS Inheritance: no Name of the class of the itemRenderer to be used if one is not specified for a column. This is a way to set an itemRenderer for a group of AdvancedDataGrids instead of having to set each one individually. If you set the AdvancedDataGrid's itemRenderer property, it supercedes this value. The default value is null. | AdvancedDataGridBaseEx | ||
| 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 | ||
disabledIconColor | Type: uint Format: Color CSS Inheritance: yes The color for the icon in a disabled skin. For example, this style is used by the CheckBoxIcon skin class to draw the check mark for a disabled CheckBox control, by the ComboBoxSkin class to draw the down arrow of a disabled ComboBox control, and by the DateChooserMonthArrowSkin skin class to draw the month arrow for a disabled DateChooser control. The default value depends on the component class; if it is not overridden by the class, the default value is 0x999999.
| AdvancedDataGridBaseEx | ||
| 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 Theme: halo Color of the drop shadow. | ScrollControlBase | ||
| Type: Boolean CSS Inheritance: no Theme: halo Boolean property that specifies whether the component has a visible drop shadow. | ScrollControlBase | ||
| Type: Boolean CSS Inheritance: no Theme: spark Boolean property that specifies whether the component has a visible drop shadow. | ScrollControlBase | ||
| 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: uint Format: Color CSS Inheritance: yes Theme: spark Color of focus ring when the component is in focus. | ScrollControlBase | ||
| 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 | ||
| Type: String CSS Inheritance: yes Sets the antiAliasType property of internal TextFields.See also flash.text.TextField flash.text.AntiAliasType | 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.See also flash.text.TextField flash.text.GridFitType | ScrollControlBase | ||
| Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls.See also flash.text.TextField | 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.See also flash.text.TextField | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Determines whether the text is boldface. | ScrollControlBase | ||
headerBackgroundSkin | 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. The default skin class is based on the theme. For example, with the Halo theme,
the default skin class is | AdvancedDataGridBaseEx | ||
headerColors | Type: Array Format: Color CSS Inheritance: yes An array of two colors used to draw the header background gradient. The first color is the top color. The second color is the bottom color. The default value is [0xFFFFFF, 0xE6E6E6]. | AdvancedDataGridBaseEx | ||
headerDragProxyStyleName | 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. The default value is "headerDragProxyStyle". | AdvancedDataGridBaseEx | ||
headerHorizontalSeparatorSkin | Type: Class CSS Inheritance: no The class to use as the skin that defines the appearance of the separator between a column group and its children columns/column group headers in an AdvancedDataGrid control. The default value is mx.skins.halo.AdvancedDataGridHeaderHorizontalSeparator. | AdvancedDataGridBaseEx | ||
headerSeparatorSkin | 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. The default skin class is based on the theme. For example, with the Halo theme,
the default skin class is | AdvancedDataGridBaseEx | ||
headerStyleName | Type: String CSS Inheritance: no The name of a CSS style declaration for controlling other aspects of the appearance of the column headers. The default value is "dataGridStyles". | 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 | ||
horizontalGridLineColor | Type: uint Format: Color CSS Inheritance: yes The color of the horizontal grid lines. | AdvancedDataGridBaseEx | ||
horizontalGridLines | Type: Boolean CSS Inheritance: no A flag that indicates whether to show horizontal grid lines between the rows. If true, shows horizontal grid lines.
If false, hides horizontal grid lines.
The default value is false. | AdvancedDataGridBaseEx | ||
horizontalLockedSeparatorSkin | 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. By default, the AdvancedDataGrid control uses the drawHorizontalLine() and drawVerticalLine() methods
to draw the separators.
The default value is undefined. | AdvancedDataGridBaseEx | ||
| Type: String CSS Inheritance: no Style name for horizontal scrollbar. | ScrollControlBase | ||
horizontalSeparatorSkin | 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. By default, the AdvancedDataGrid control uses the drawHorizontalLine() and drawVerticalLine() methods
to draw the separators.
The default value is undefined. | AdvancedDataGridBaseEx | ||
iconColor | Type: uint Format: Color CSS Inheritance: yes The color for the icon in a skin. For example, this style is used by the CheckBoxIcon skin class to draw the check mark for a CheckBox control, by the ComboBoxSkin class to draw the down arrow of the ComboBox control, and by the DateChooserMonthArrowSkin skin class to draw the month arrow for the DateChooser control. The default value depends on the component class; if it is not overridden by the class, the default value is 0x111111.
| AdvancedDataGridBaseEx | ||
| Type: String CSS Inheritance: yes The primary interaction mode for this component. See also | 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. See also | 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 | ||
| 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 | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's left border and the left edge of its content area. | AdvancedListBase | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's right border and the right edge of its content area. | AdvancedListBase | ||
| 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 | ||
rollOverColor | Type: uint Format: Color CSS Inheritance: yes The color of the row background when the user rolls over the row. The default value is 0xE3FFD6. | AdvancedDataGridBaseEx | ||
selectionColor | 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. The default value is 0xCDFFC1. | AdvancedDataGridBaseEx | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the background of a renderer when the component is disabled. | AdvancedListBase | ||
| Type: Number Format: Time CSS Inheritance: no The duration of the selection effect. | AdvancedListBase | ||
| Type: Function CSS Inheritance: no The easingFunction for the selection effect. | AdvancedListBase | ||
| Type: String CSS Inheritance: no Theme: halo Direction of the drop shadow. | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: no Theme: halo Distance of the drop shadow. | ScrollControlBase | ||
| 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 | ||
stretchCursor | Type: Class CSS Inheritance: no The class to use as the skin for the cursor that indicates that a column can be resized. The default value is mx.skins.halo.DataGridStretchCursor. | AdvancedDataGridBaseEx | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of any symbol of a component. | ScrollControlBase | ||
| 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 | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the text of a renderer when the user rolls over a it. | AdvancedListBase | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the text of a renderer when the user selects it. | AdvancedListBase | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: halo Theme color of a component. | UIComponent | ||
| 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 | ||
verticalGridLineColor | Type: uint Format: Color CSS Inheritance: yes The color of the vertical grid lines. The default value is 0x666666. | AdvancedDataGridBaseEx | ||
verticalGridLines | Type: Boolean CSS Inheritance: no A flag that indicates whether to show vertical grid lines between the columns. If true, shows vertical grid lines.
If false, hides vertical grid lines.
The default value is true. | AdvancedDataGridBaseEx | ||
verticalLockedSeparatorSkin | 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. By default, the AdvancedDataGrid control uses the drawHorizontalLine() and drawVerticalLine() methods
to draw the separators.
The default value is undefined. | AdvancedDataGridBaseEx | ||
| Type: String CSS Inheritance: no Style name for vertical scrollbar. | ScrollControlBase | ||
verticalSeparatorSkin | 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. By default, the AdvancedDataGrid control uses the drawHorizontalLine() and drawVerticalLine() methods
to draw the separators.
The default value is undefined. | AdvancedDataGridBaseEx | ||
| columns | property |
columns:Array| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
An array of AdvancedDataGridColumn objects, one for each column that can be displayed. If not explicitly set, the AdvancedDataGrid control attempts to examine the first data provider item to determine the set of properties and display those properties in alphabetic order.
If you want to change the set of columns, you must get this Array,
make modifications to the columns and order of columns in the Array,
and then assign the new Array to the columns property. This is because
the AdvancedDataGrid control returns a copy of the Array of columns,
not a reference, and therefore cannot detect changes to the copy.
This property can be used as the source for data binding.
public function get columns():Array public function set columns(value:Array):void| draggableColumns | property |
draggableColumns:Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Indicates whether you are allowed to reorder columns.
If true, you can reorder the columns
of the AdvancedDataGrid control by dragging the header cells.
The default value is true.
public function get draggableColumns():Boolean public function set draggableColumns(value:Boolean):void| editable | property |
editable:String| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Indicates whether or not the user can edit items in the data provider.
If "item", the item renderers in the control are editable.
The user can click on an item renderer to open an editor.
If "item group", the item renderers and grouping headers can be edited.
If "item summary", the item renderers and summary cells can be edited.
You can combine these values. For example, editable = "item group summary".
Note that item editing has to be enabled if enabling group or summary editing.
If you specify an empty String, no editing is allowed.
The values "true" and "false" correspond
to item editing and no editing.
A value of "all" means everything is editable.
You can turn off editing for individual columns of the
AdvancedDataGrid control using the AdvancedDataGridColumn.editable property,
or by handling the itemEditBeginning and
itemEditBegin events.
The default value is "".
public function get editable():String public function set editable(value:String):void| editedItemPosition | property |
editedItemPosition:Object| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
The column and row index of the item renderer for the data provider item being edited, if any.
This Object has two fields, columnIndex and
rowIndex,
the zero-based column and row indexes of the item.
For example: {columnIndex:2, rowIndex:3}
Setting this property scrolls the item into view and
dispatches the itemEditBegin event to
open an item editor on the specified item renderer.
The default value is null.
This property can be used as the source for data binding.
public function get editedItemPosition():Object public function set editedItemPosition(value:Object):void| editedItemRenderer | property |
editedItemRenderer:IListItemRenderer [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
A reference to the item renderer in the AdvancedDataGrid control whose item is currently being edited.
From within an event listener for the itemEditBegin
and itemEditEnd events,
you can access the current value of the item being edited
using the editedItemRenderer.data property.
public function get editedItemRenderer():IListItemRenderer| enableIME | property |
enableIME:Boolean [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
A flag that indicates whether the IME should be enabled when the component receives focus. If the editor is up, it will set enableIME accordingly.
public function get enableIME():Boolean| headerInfoInitialized | property |
protected var headerInfoInitialized:Boolean = false| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Contains true if the headerInfos property
has been initialized with AdvancedDataGridHeaderInfo instances.
See also
| horizontalScrollPosition | property |
horizontalScrollPosition:Number[override] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
The offset into the content from the left edge.
This can be a pixel offset in some subclasses or some other metric
like the number of columns in an AdvancedDataGrid control.
The AdvancedDataGrid scrolls by columns so the value of the
horizontalScrollPosition property is always
in the range of 0 to the index of the columns
that will make the last column visible.
This is different from the List control, which scrolls by pixels.
The AdvancedDataGrid control always aligns the left edge
of a column with the left edge of the AdvancedDataGrid control.
public function get horizontalScrollPosition():Number public function set horizontalScrollPosition(value:Number):void| imeMode | property |
imeMode:String| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Specifies the IME (input method editor) mode. The IME mode enables users to enter text in Chinese, Japanese, and Korean. Flex sets the specified IME mode when the control gets the focus, and sets it back to the previous value when the control loses the focus.
The flash.system.IMEConversionMode class defines constants for the
valid values for this property.
You can also specify null to specify no IME.
The default value is null.
public function get imeMode():String public function set imeMode(value:String):voidSee also
| isKeyPressed | property |
protected var isKeyPressed:Boolean = false| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Contains true if a key press is in progress.
| itemEditorInstance | property |
public var itemEditorInstance:IListItemRenderer| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
A reference to the currently active instance of the item editor, if it exists.
To access the item editor instance and the new item value when an
item is being edited, you use the itemEditorInstance
property. The itemEditorInstance property
is not valid until after the event listener for
the itemEditBegin event executes. Therefore, you typically
only access the itemEditorInstance property from within
the event listener for the itemEditEnd event.
The AdvancedDataGridColumn.itemEditor property defines the
class of the item editor,
and therefore the data type of the item editor instance.
You do not set this property in MXML.
| lookAheadDuration | property |
public var lookAheadDuration:Number = 400| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
The type look-ahead duration, in milliseconds, for multi-character look ahead. Setting it to 0 will turn off multiple character type ahead lookup.
The default value is 400.
| minColumnWidth | property |
minColumnWidth:Number| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
The minimum width of the columns, in pixels. If not NaN, the AdvancedDataGrid control applies this value as the minimum width for all columns. Otherwise, individual columns can have their own minimum widths.
The default value is NaN.
public function get minColumnWidth():Number public function set minColumnWidth(value:Number):void| orderedHeadersList | property |
protected var orderedHeadersList:Array| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
An ordered list of AdvancedDataGridHeaderInfo instances that correspond to the visible column headers.
| resizableColumns | property |
public var resizableColumns:Boolean = true| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
A flag that indicates whether the user can change the size of the
columns.
If true, the user can stretch or shrink the columns of
the AdvancedDataGrid control by dragging the grid lines between the header cells.
If true, individual columns must also have their
resizeable properties set to false to
prevent the user from resizing a particular column.
The default value is true.
| sortableColumns | property |
public var sortableColumns:Boolean = true| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
A flag that indicates whether the user can sort the data provider items
by clicking on a column header cell.
If true, the user can sort the data provider items by
clicking on a column header cell.
The AdvancedDataGridColumn.dataField property of the column
or the AdvancedDataGridColumn.sortCompareFunction property
of the column is used as the sort field.
If a column is clicked more than once,
the sort alternates between ascending and descending order.
If true, individual columns can be made to not respond
to a click on a header by setting the column's sortable
property to false.
When a user releases the mouse button over a header cell, the AdvancedDataGrid
control dispatches a headerRelease event if both
this property and the column's sortable property are true.
If no handler calls the preventDefault() method on the event, the
AdvancedDataGrid sorts using that column's AdvancedDataGridColumn.dataField or
AdvancedDataGridColumn.sortCompareFunction properties.
The default value is true.
See also
| sortExpertMode | property |
sortExpertMode:Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
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.
You then click in the multiple-column sort area of the header to sort by additional columns.
If you set the sortExpertMode property to true,
you use the Control key to select every column after the first column to perform sort.
The default value is false.
public function get sortExpertMode():Boolean public function set sortExpertMode(value:Boolean):void| AdvancedDataGridBaseEx | () | Constructor |
public function AdvancedDataGridBaseEx()| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Constructor.
| absoluteToDisplayColumnIndex | () | method |
protected function absoluteToDisplayColumnIndex(columnIndex:int):int| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Converts an absolute column index to the corresponding index in the displayed columns. Because users can reorder columns, the absolute column index may be different from the index of the displayed column.
Parameters
columnIndex:int — Absolute index of the column.
|
int — The index of the column as it is currently displayed,
or -1 if columnIndex is not found.
|
| absoluteToVisibleColumnIndex | () | method |
protected function absoluteToVisibleColumnIndex(columnIndex:int):int| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Converts an absolute column index to the corresponding index in the visible columns. Because users can reorder columns, the absolute column index may be different from the index of the visible column.
Parameters
columnIndex:int — Absolute index of the column.
|
int — The index of the column as it is currently visible,
or -1 if columnIndex is not currently visible.
|
| absoluteToVisibleIndices | () | method |
protected function absoluteToVisibleIndices(rowIndex:int, columnIndex:int):Object| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
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.
Parameters
rowIndex:int — An absolute row index.
| |
columnIndex:int — An absolute column index.
|
Object — An Object containing two fields, rowIndex and columnIndex,
that contain the row index and column index of the item as it is currently displayed by the control.
|
| addSortField | () | method |
protected function addSortField(columnName:String, columnNumber:int, collection:ICollectionView):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Adds a data field to the list of sort fields. Indicate the data field by specifying its column location.
Parameters
columnName:String — The name of the column that corresponds to the data field.
| |
columnNumber:int — The column index in the AdvancedDataGrid control.
| |
collection:ICollectionView — The data collection that contains the data field.
|
| clearSeparators | () | method |
protected function clearSeparators():void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Removes column header separators that you normally use to resize columns.
| colNumToIndex | () | method |
protected function colNumToIndex(colNum:int):int| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Returns the index of a column as it is currently displayed. This method is useful when all columns of the control are not currently visible.
Parameters
colNum:int — Absolute index of the column.
|
int — The index of the column as it is currently displayed,
or -1 if colNum is not found.
|
| createHeaderSeparators | () | method |
protected function createHeaderSeparators(n:int, seperators:Array, headerLines:UIComponent):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Creates the header separators between column headers,
and populates the separators Array with the separators created.
Parameters
n:int — The number of separators to create.
| |
seperators:Array — Array to be populated with the header objects.
| |
headerLines:UIComponent — The parent component of the header separators to which the separators are added.
That is, Flex calls the headerLines.addChild() method internally to add the separators to the display.
|
| createItemEditor | () | method |
public function createItemEditor(colIndex:int, rowIndex:int):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Creates the item editor for the item renderer at the
editedItemPosition using the editor
specified by the itemEditor property.
This method sets the editor instance as the
itemEditorInstance property.
You may only call this method from within the event listener
for the itemEditBegin event.
To create an editor at other times, set the
editedItemPosition property to generate
the itemEditBegin event.
Parameters
colIndex:int — The column index in the data provider of the item to be edited.
| |
rowIndex:int — The row index in the data provider of the item to be edited.
|
| destroyItemEditor | () | method |
public function destroyItemEditor():void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
This method closes an item editor currently open on an item renderer.
You typically call this method only from within the event listener
for the itemEditEnd event, after
you have already called the preventDefault() method to
prevent the default event listener from executing.
| displayToAbsoluteColumnIndex | () | method |
protected function displayToAbsoluteColumnIndex(columnIndex:int):int| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Converts the current display column index of a column to its corresponding absolute index. Because users can reorder columns, the absolute column index may be different from the index of the displayed column.
Parameters
columnIndex:int — Index of the column as it is currently displayed by the control.
|
int — The absolute index of the column.
|
| drawColumnBackground | () | method |
protected function drawColumnBackground(s:Sprite, columnIndex:int, color:uint, column:AdvancedDataGridColumn):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Draws a column background for a column with the suggested color. This implementation creates a Shape as a child of the input Sprite and fills it with the appropriate color.
Parameters
s:Sprite — A Sprite that will contain a display object
that contains the graphics for that column.
| |
columnIndex:int — The column's index in the set of displayed columns.
The left-most visible column has a column index of 0.
This is used to keep track of the objects used for drawing
backgrounds, so a particular column can re-use the same display object
even though the index of the AdvancedDataGridColumn for that column has changed.
| |
color:uint — The suggested color for the indicator.
| |
column:AdvancedDataGridColumn — The column of the AdvancedDataGrid control that you are drawing the background for.
|
| drawHeaderBackground | () | method |
protected function drawHeaderBackground(headerBG:UIComponent):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Draws the background of the headers into the given UIComponent. The graphics drawn can be scaled horizontally if the component's width changes, or this method will be called again to redraw at a different width and/or height
Parameters
headerBG:UIComponent — A UIComponent that will contain the header
background graphics.
|
| drawHorizontalLine | () | method |
protected function drawHorizontalLine(s:Sprite, rowIndex:int, color:uint, y:Number):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Draws a line between rows. 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 will contain a display object
that contains the graphics for that row.
| |
rowIndex:int — The row's index in the set of displayed rows. The
header does not count; the top-most visible row has a row index of 0.
This is used to keep track of the objects used for drawing
backgrounds so a particular row can re-use the same display object
even though the index of the item that row is rendering has changed.
| |
color:uint — The suggested color for the indicator.
| |
y:Number — The suggested y position for the background.
|
| drawLinesAndColumnBackgrounds | () | method |
protected function drawLinesAndColumnBackgrounds():void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Draws lines between columns, and column backgrounds.
This implementation calls the drawHorizontalLine(),
drawVerticalLine(),
and drawColumnBackground() methods as needed.
It creates a
Sprite that contains all of these graphics and adds it as a
child of the listContent at the front of the z-order.
| drawRowBackground | () | method |
protected function drawRowBackground(s:Sprite, rowIndex:int, y:Number, height:Number, color:uint, dataIndex:int):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Draws a row background
at the position and height specified using the
color specified. This implementation creates a Shape as a
child of the input Sprite and fills it with the appropriate color.
This method also uses the backgroundAlpha style property
setting to determine the transparency of the background color.
Parameters
s:Sprite — A Sprite that will contain a display object
that contains the graphics for that row.
| |
rowIndex:int — The row's index in the set of displayed rows. The
header does not count, the top most visible row has a row index of 0.
This is used to keep track of the objects used for drawing
backgrounds so a particular row can re-use the same display object
even though the index of the item that row is rendering has changed.
| |
y:Number — The suggested y position for the background.
| |
height:Number — The suggested height for the indicator.
| |
color:uint — The suggested color for the indicator.
| |
dataIndex:int — The index of the item for that row in the
data provider. This can be used to color the tenth item differently,
for example.
|
| drawSeparators | () | method |
protected function drawSeparators():void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Creates and displays the column header separators that the user
normally uses to resize columns. This implementation uses
the same Sprite as the lines and column backgrounds, adds
instances of the headerSeparatorSkin, and attaches mouse
listeners to them in order to know when the user wants
to resize a column.
| drawVerticalLine | () | method |
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 lines 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 will contain a display object
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 suggested color for the indicator.
| |
x:Number — The suggested x position for the background.
|
| findHeaderRenderer | () | method |
protected function findHeaderRenderer(pt:Point):IListItemRendererA helper method to determine which item renderer is under the mouse.
Parameters
pt:Point |
IListItemRenderer |
| findRenderer | () | method |
protected function findRenderer(pt:Point, items:Array, info:Array, yy:Number = 0):IListItemRendererA helper method to determine which item renderer is under the mouse.
Parameters
pt:Point | |
items:Array | |
info:Array | |
yy:Number (default = 0) |
IListItemRenderer |
| findSortField | () | method |
protected function findSortField(name:String):int| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Returns the column index corresponding to the field name of a sortable field.
Parameters
name:String — The name of a sortable field of the data provider, as defined by
an instance of the SortField class.
|
int — The column index of the sortable field.
|
| getFieldSortInfo | () | method |
public function getFieldSortInfo(column:AdvancedDataGridColumn):SortInfo| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Returns a SortInfo instance containing sorting information for the column.
Parameters
column:AdvancedDataGridColumn — The column index.
|
SortInfo — A SortInfo instance.
|
See also
| getSeparator | () | method |
protected function getSeparator(i:int, seperators:Array, headerLines:UIComponent):UIComponent| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Returns the header separators between column headers,
and populates the separators Array with the separators returned.
Parameters
i:int — The number of separators to return.
| |
seperators:Array — Array to be populated with the header objects.
| |
headerLines:UIComponent — The parent component of the header separators.
Flex calls the headerLines.getChild() method internally to return the separators.
|
UIComponent — The header separators between column headers.
|
| indexToColNum | () | method |
protected function indexToColNum(columnIndex:int):int| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Returns the column number of a currently displayed column as it is currently displayed. This method is useful when all columns of the control are not currently visible.
Parameters
columnIndex:int — The index of the column as it is currently displayed.
|
int — The column number of the displayed column in the control,
or -1 if columnIndex is not found.
|
| isColumnFullyVisible | () | method |
protected function isColumnFullyVisible(columnIndex:int, rowIndex:int = -1):Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Returns true if the specified row in a column is visible.
Parameters
columnIndex:int — The column index.
| |
rowIndex:int (default = -1)verticalScrollPosition property.
|
Boolean — true if the specified row in the column is visible.
|
| isDataEditable | () | method |
protected function isDataEditable(data:Object):Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Checks if editing is allowed for a group or summary row.
Parameters
data:Object — Data provider Object for the row.
|
Boolean — true if editing is allowed for the group or summary row.
|
| isDraggingAllowed | () | method |
protected function isDraggingAllowed(draggedColumn:AdvancedDataGridColumn):Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Checks if dragging is allowed for a particular column or not.
Parameters
draggedColumn:AdvancedDataGridColumn — The column being dragged.
|
Boolean — true if dragging is allowed for the column.
|
| moveFocusToHeader | () | method |
public function moveFocusToHeader(columnIndex:int = -1):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Moves focus to the specified column header.
Parameters
columnIndex:int (default = -1) |
| removeSortField | () | method |
protected function removeSortField(columnName:String, columnNumber:int, collection:ICollectionView):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Removes a data field from the list of sort fields. Indicate the data field by specifying its column location.
Parameters
columnName:String — The name of the column that corresponds to the data field.
| |
columnNumber:int — The column index in the AdvancedDataGrid control.
| |
collection:ICollectionView — The data collection that contains the data field.
|
| scrollToViewColumn | () | method |
protected function scrollToViewColumn(newColumnIndex:int, columnIndex:int):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Changes the value of the horizontalScrollPosition property
to make the specified column visible.
This method is useful when all columns of the control are not currently visible.
Parameters
newColumnIndex:int — The desired index of the column in the currently displayed columns.
| |
columnIndex:int — The index of the column to display.
|
| selectColumnHeader | () | method |
protected function selectColumnHeader(columnNumber:int):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Selects the specified column header.
Parameters
columnNumber:int — The index of the column to receive focus.
If you specify an invalid column index, the method returns without moving focus.
|
| unselectColumnHeader | () | method |
protected function unselectColumnHeader(columnNumber:int, completely:Boolean = false):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Deselects the specified column header.
Parameters
columnNumber:int — The index of the column.
If you specify an invalid column index, the method does nothing.
| |
completely:Boolean (default = false)true, clear the caretIndex property
and selects the first column header in the control.
|
| visibleToAbsoluteColumnIndex | () | method |
protected function visibleToAbsoluteColumnIndex(columnIndex:int):int| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Converts the current visible column index of a column to its corresponding absolute index. Because users can reorder columns, the absolute column index may be different from the index of the visible column.
Parameters
columnIndex:int — Index of a currently visible column in the control.
|
int — The absolute index of the column.
|
| columnStretch | Event |
mx.events.AdvancedDataGridEventmx.events.AdvancedDataGridEvent.COLUMN_STRETCH| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Dispatched when a user changes the width of a column, indicating that the
amount of data displayed in that column may have changed.
If horizontalScrollPolicy is "none", other
columns shrink or expand to compensate for the columns' resizing,
and they also dispatch this event.
type property of the event object for a
columnStretch event, which indicates that a
user expanded a column horizontally.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
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 | null |
localX | The x position of the mouse. |
multiColumnSort | false |
reason | null |
removeColumnFromSort | false |
rowIndex | The zero-based index of the item in the data provider. |
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.COLUMN_STRETCH |
| headerRelease | Event |
mx.events.AdvancedDataGridEventmx.events.AdvancedDataGridEvent.HEADER_RELEASE| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
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.
Only dispatched if the column is sortable and the data provider supports
sorting. The AdvancedDataGrid control has a default handler for this event that implements
a single-column sort. Multiple-column sort can be implemented by calling the
preventDefault() method to prevent the single column sort and setting
the sort property of the data provider.
Note: The sort arrows are defined by the default event handler for
the headerRelease event. If you call the preventDefault() method
in your event handler, the arrows are not drawn.
type property of the event object for a
headerRelease 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. |
item | The AdvancedDataGrid item (node) that closed. |
itemRenderer | The header renderer that is being released. |
localX | NaN |
multiColumnSort | undefined - Use the sort event
if you want to sort on multiple columns. |
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 |
| headerShift | Event |
mx.events.IndexChangedEventmx.events.IndexChangedEvent.HEADER_SHIFT| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
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
The IndexChangedEvent.HEADER_SHIFT constant defines the value of thetype property of the event object for a headerShift event,
which indicates that a header has changed its index, as when a user drags
a DataGrid column to a new position.
The properties of the event object have the following values:
| 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. |
inputType | Indicates whether this event was caused by a mouse or keyboard interaction. |
newIndex | The zero-based index of the header after the change. |
oldIndex | The zero-based index of the header before the change. |
relatedObject | 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 | The event that triggered this event. |
Type | IndexChangedEvent.HEADER_SHIFT |
| itemEditBegin | Event |
mx.events.AdvancedDataGridEventmx.events.AdvancedDataGridEvent.ITEM_EDIT_BEGIN| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Dispatched when the editedItemPosition property has been set
and the item can be edited.
type property of the event object for a
itemEditBegin event, which indicates that an
item is ready to be edited.
The default listener for this event performs the following actions:
createItemEditor() method.data property
from the item to the editor. By default, the item editor object is an instance
of the TextInput control. You use the itemEditor property of the
list control to specify a custom item editor class.itemEditorInstance property of the list control
to reference the item editor instance.You can write an event listener for this event to modify the data passed to the item editor. For example, you might modify the data, its format, or other information used by the item editor.
You can also create an event listener to specify the item editor used to edit the item. For example, you might have two different item editors. Within the event listener, you can examine the data to be edited or other information, and open the appropriate item editor by doing the following:
preventDefault() to stop Flex from calling
the createItemEditor() method as part
of the default event listener.itemEditor property to the appropriate editor.createItemEditor() method.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 | null |
item | The AdvancedDataGrid item (node). |
itemRenderer | The item renderer for the item that is being edited. |
localX | NaN |
multiColumnSort | false |
reason | null |
removeColumnFromSort | false |
rowIndex | The zero-based index of the item in the data provider. |
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_EDIT_BEGIN |
| itemEditBeginning | Event |
mx.events.AdvancedDataGridEventmx.events.AdvancedDataGridEvent.ITEM_EDIT_BEGINNING| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
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.
The AdvancedDataGridEvent.ITEM__EDIT_BEGINNING constant defines the value of thetype property of the event object for a
itemEditBeginning event, which indicates that the user has
prepared to edit an item, for example, by releasing the mouse button
over the item.
The default listener for this event sets the AdvancedDataGrid.editedItemPosition
property to the item that has focus, which starts the item editing session.
You typically write your own event listener for this event to
disallow editing of a specific item or items.
Calling the preventDefault() method from within your own
event listener for this event prevents the default listener from executing.
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 item's column. |
item | The AdvancedDataGrid item (node) that closed. |
itemRenderer | The item renderer for the item that will be edited. This property is null if this event is generated by keyboard, as the item to be edited may be off-screen. |
localX | NaN |
multiColumnSort | false |
reason | null |
removeColumnFromSort | false |
rowIndex | The zero-based index of the item in the data provider. |
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_EDIT_BEGINNING |
| itemEditEnd | Event |
mx.events.AdvancedDataGridEventmx.events.AdvancedDataGridEvent.ITEM_EDIT_END| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Dispatched when an item editing session ends for any reason.
The AdvancedDataGridEvent.ITEM_EDIT_END constant defines the value of thetype property of the event object for a
itemEditEnd event, which indicates that an edit
session is ending.
The list components have a default handler for this event that copies the data from the item editor to the data provider of the list control. The default event listener performs the following actions:
editorDataField property of the AdvancedDataGridColumn
associated with this event to
determine the property of the item editor containing the new data and updates
the data provider item with that new data.
Since the default item editor is the TextInput control, the default value of the
editorDataField property
is "text", to specify that the text property of the
TextInput contains the new item data.destroyItemEditor() method to close the item editor.You typically write an event listener for this event to perform the following actions:
itemEditEnd event
if you want to return multiple values.preventDefault() method
to stop Flex from passing the new data back to the list control and from closing
the editor. 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 item's column. |
item | The AdvancedDataGrid item (node) that closed. |
itemRenderer | The item renderer for the item that is being edited. |
localX | NaN |
multiColumnSort | false |
reason | A constant defining the reason for the event.
The value must be a member of the AdvancedDataGridEventReason class. |
removeColumnFromSort | false |
rowIndex | The zero-based index of the item in the data provider. |
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_EDIT_END |
| itemFocusIn | Event |
mx.events.AdvancedDataGridEventmx.events.AdvancedDataGridEvent.ITEM_FOCUS_IN| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
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. Only dispatched if the item is editable.
The AdvancedDataGridEvent.ITEM_FOCUS_IN constant defines the value of thetype property of the event object for a
itemFocusIn event, which indicates that an
item has received the focus.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
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 | null |
item | The AdvancedDataGrid item (node) that closed. |
itemRenderer | The item editor instance for the item that is being edited. |
localX | NaN |
multiColumnSort | false |
reason | null |
removeColumnFromSort | false |
rowIndex | The zero-based index of the item in the data provider. |
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_FOCUS_IN |
| itemFocusOut | Event |
mx.events.AdvancedDataGridEventmx.events.AdvancedDataGridEvent.ITEM_FOCUS_OUT| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
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. Only dispatched if the item is editable.
The AdvancedDataGridEvent.ITEM_FOCUS_OUT constant defines the value of thetype property of the event object for a
itemFocusOut event, which indicates that an
item has lost the focus.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
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 | null |
item | The AdvancedDataGrid item (node) that closed. |
itemRenderer | The item editor instance for the item that is being edited. |
localX | NaN |
multiColumnSort | false |
reason | null |
removeColumnFromSort | false |
rowIndex | The zero-based index of the item in the data provider. |
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_FOCUS_OUT |
| sort | Event |
mx.events.AdvancedDataGridEventmx.events.AdvancedDataGridEvent.SORT| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Dispatched when sorting is to be performed on the AdvancedDataGrid control.
The AdvancedDataGridEvent.SORT constant defines the value of thetype property of the event object for a
sort event.
The AdvancedDataGrid control performs sorting based on the value of the
dataField and multiColumnSort properties.
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. |
multiColumnSort | If true,
indicates that the new dataField property
should be used along with whatever sorting
is already in use, resulting in a multicolumn sort.
If |
removeColumnFromSort | false |
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.SORT |