Packagemx.controls
Classpublic class DataGrid
InheritanceDataGrid Inheritance DataGridBase Inheritance ListBase Inheritance ScrollControlBase Inheritance UIComponent Inheritance FlexSprite Inheritance flash.display.Sprite
Implements IIMESupport
Subclasses FileSystemDataGrid, PrintDataGrid

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


Starting with Flex 4.5, Apache recommends that you use the spark.components.DataGrid class as an alternative to this class.

The DataGrid control is like a List except that it can show more than one column of data making it suited for showing objects with multiple properties.

The DataGrid control provides the following features:

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

The DataGrid control has the following default sizing characteristics:

CharacteristicDescription
Default sizeIf the columns are empty, the default width is 300 pixels. If the columns contain information but define no explicit widths, the default width is 100 pixels per column. The DataGrid width is sized to fit the width of all columns, if possible. The default number of displayed rows, including the header is 7, and each row, by default, is 20 pixels high.
Minimum size0 pixels.
Maximum size5000 by 5000.

MXML SyntaxexpandedHide MXML Syntax

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

  <mx:DataGrid
    Properties
    columns="From dataProvider"
    draggableColumns="true|false"
    editable="false|true"
    editedItemPosition="null"
    horizontalScrollPosition="null"
    imeMode="null"
    itemEditorInstance="null"
    minColumnWidth="NaN"
    resizableColumns="true|false"
    sortableColumns="true|false"
    
    Styles
    backgroundDisabledColor="0xEFEEEF"
    columnDropIndicatorSkin="DataGridColumnDropIndicator"
    columnResizeSkin="DataGridColumnResizeSkin"
    disabledIconColor="0x999999"
    headerColors="[#FFFFFF, #E6E6E6]"
    headerDragProxyStyleName="headerDragProxyStyle"
    headerSeparatorSkin="DataGridHeaderSeparator"
    headerStyleName="dataGridStyles"
    horizontalGridLineColor="0xF7F7F7"
    horizontalGridLines="false|true"
    horizontalLockedSeparatorSkin="undefined"
    horizontalSeparatorSkin="undefined"
    iconColor="0x111111"
    rollOverColor="0xB2E1FF"
    selectionColor="0x7FCEFF"
    sortArrowSkin="DataGridSortArrow"
    stretchCursor=""cursorStretch" symbol from the Assets.swf file"
    verticalGridLineColor="0xCCCCCC"
    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 DataGrid code sample specifies the column order:
  <mx:DataGrid>
    <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:DataGridColumn dataField="Album"/>
        <mx:DataGridColumn dataField="Price"/>
    </mx:columns>
  </mx:DataGrid>
  

Default MXML PropertydataProvider

View the examples

See also

mx.controls.dataGridClasses.DataGridItemRenderer
mx.controls.dataGridClasses.DataGridColumn
mx.controls.dataGridClasses.DataGridDragProxy
mx.events.DataGridEvent


Public Properties
 PropertyDefined By
 InheritedaccessibilityDescription : String
A convenience accessor for the description property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityEnabled : Boolean
A convenience accessor for the silent property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityName : String
A convenience accessor for the name property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityShortcut : String
A convenience accessor for the shortcut property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedactiveEffects : Array
[read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances.
UIComponent
 InheritedallowDragSelection : Boolean = false
A flag that indicates whether drag-selection is enabled.
ListBase
 InheritedallowMultipleSelection : Boolean
A flag that indicates whether you can allow more than one item to be selected at the same time.
ListBase
 InheritedautomationDelegate : Object
The delegate object that handles the automation-related functionality.
UIComponent
 InheritedautomationEnabled : Boolean
[read-only] True if this component is enabled for automation, false otherwise.
UIComponent
 InheritedautomationName : String
Name that can be used as an identifier for this object.
UIComponent
 InheritedautomationOwner : DisplayObjectContainer
[read-only] The owner of this component for automation purposes.
UIComponent
 InheritedautomationParent : DisplayObjectContainer
[read-only] The parent of this component for automation purposes.
UIComponent
 InheritedautomationTabularData : Object
[read-only] An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.
UIComponent
 InheritedautomationValue : Array
[read-only] This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application.
UIComponent
 InheritedautomationVisible : Boolean
[read-only] True if this component is visible for automation, false otherwise.
UIComponent
 Inheritedbaseline : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 InheritedbaselinePosition : Number
[read-only] The y-coordinate of the baseline of the first line of text of the component.
UIComponent
 InheritedborderMetrics : EdgeMetrics
[read-only] Returns an EdgeMetrics object that has four properties: left, top, right, and bottom.
ScrollControlBase
 Inheritedbottom : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 InheritedcacheHeuristic : Boolean
[write-only] Used by Flex to suggest bitmap caching for the object.
UIComponent
 InheritedcachePolicy : String
Specifies the bitmap caching policy for this object.
UIComponent
 InheritedclassName : String
[read-only] The name of this instance's class, such as "Button".
UIComponent
  columns : Array
[override] An array of DataGridColumn objects, one for each column that can be displayed.
DataGrid
 InheritedcontentMouseX : Number
[read-only] Returns the x position of the mouse, in the content coordinate system.
UIComponent
 InheritedcontentMouseY : Number
[read-only] Returns the y position of the mouse, in the content coordinate system.
UIComponent
 InheritedcurrentState : String
The current view state of the component.
UIComponent
 InheritedcursorManager : ICursorManager
[read-only] Gets the CursorManager that controls the cursor for this component and its peers.
UIComponent
 Inheriteddata : Object
The item in the data provider this component should render when this component is used as an item renderer or item editor.
ListBase
 InheriteddataProvider : Object
Set of data to be viewed.
ListBase
 InheriteddataTipField : String
Name of the field in the data provider items to display as the data tip.
ListBase
 InheriteddataTipFunction : Function
User-supplied function to run on each item to determine its dataTip.
ListBase
 Inheriteddepth : Number
Determines the order in which items inside of containers are rendered.
UIComponent
 Inheriteddescriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.
UIComponent
 InheriteddesignLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual element.
UIComponent
 Inheriteddocument : Object
A reference to the document object associated with this UIComponent.
UIComponent
 InheriteddoubleClickEnabled : Boolean
[override] Specifies whether the UIComponent object receives doubleClick events.
UIComponent
 InheriteddragEnabled : Boolean
A flag that indicates whether you can drag items out of this control and drop them on other controls.
ListBase
  draggableColumns : Boolean
A flag that indicates whether the user is allowed to reorder columns.
DataGrid
 InheriteddragMoveEnabled : Boolean
A flag that indicates whether items can be moved instead of just copied from the control as part of a drag-and-drop operation.
ListBase
 InheriteddropEnabled : Boolean
A flag that indicates whether dragged items can be dropped onto the control.
ListBase
  editable : Boolean
A flag that indicates whether or not the user can edit items in the data provider.
DataGrid
  editedItemPosition : Object
The column and row index of the item renderer for the data provider item being edited, if any.
DataGrid
  editedItemRenderer : IListItemRenderer
[read-only] A reference to the item renderer in the DataGrid control whose item is currently being edited.
DataGrid
 Inheritedenabled : 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.
DataGrid
 InheritederrorString : String
The text that displayed by a component's error tip when a component is monitored by a Validator and validation fails.
UIComponent
 InheritedexplicitHeight : Number
Number that specifies the explicit height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMinHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMinWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitWidth : Number
Number that specifies the explicit width of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedflexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
UIComponent
 InheritedfocusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
UIComponent
 InheritedfocusManager : IFocusManager
Gets the FocusManager that controls focus for this component and its peers.
UIComponent
 InheritedfocusPane : Sprite
The focus pane associated with this object.
UIComponent
 InheritedfontContext : IFlexModuleFactory
The module factory that provides the font context for this component.
DataGridBase
 InheritedhasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus.
UIComponent
 InheritedhasLayoutMatrix3D : Boolean
[read-only] Contains true if the element has 3D Matrix.
UIComponent
 InheritedheaderHeight : Number
The height of the header cell of the column, in pixels.
DataGridBase
 Inheritedheight : Number
[override] Number that specifies the height of the component, in pixels, in the parent's coordinates.
UIComponent
 InheritedhorizontalCenter : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 InheritedhorizontalScrollPolicy : String
A property that indicates whether the horizontal scroll bar is always on, always off, or automatically changes based on the parameters passed to the setScrollBarProperties() method.
ScrollControlBase
  horizontalScrollPosition : Number
[override] The offset into the content from the left edge.
DataGrid
 Inheritedid : String
ID of the component.
UIComponent
  imeMode : String
Specifies the IME (input method editor) mode.
DataGrid
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
UIComponent
 InheritedinheritingStyles : Object
The beginning of this component's chain of inheriting styles.
UIComponent
 Inheritedinitialized : Boolean
A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required).
UIComponent
 InheritedinstanceIndex : int
[read-only] The index of a repeated component.
UIComponent
 InheritedinstanceIndices : Array
An Array containing the indices required to reference this UIComponent object from its parent document.
UIComponent
 Inheritedis3D : Boolean
[read-only] Contains true when the element is in 3D.
UIComponent
 InheritedisDocument : Boolean
[read-only] Contains true if this UIComponent instance is a document object.
UIComponent
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
UIComponent
  itemEditorInstance : IListItemRenderer
A reference to the currently active instance of the item editor, if it exists.
DataGrid
 InheriteditemRenderer : IFactory
The custom item renderer for the control.
ListBase
 InheritedlabelFunction : Function
A user-supplied function to run on each item to determine its label.
ListBase
 InheritedlayoutMatrix3D : Matrix3D
[write-only] The transform matrix that is used to calculate a component's layout relative to its siblings.
UIComponent
 Inheritedleft : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 InheritedlistData : BaseListData
When a component is used as a drop-in item renderer or drop-in item editor, Flex initializes the listData property of the component with the additional data from the list control.
ListBase
 InheritedliveScrolling : Boolean = true
A flag that indicates whether scrolling is live as the scrollbar thumb is moved or the view is not updated until the thumb is released.
ScrollControlBase
 InheritedlockedColumnCount : int
The index of the first column in the control that scrolls.
DataGridBase
 InheritedlockedRowCount : int
The index of the first row in the control that scrolls.
DataGridBase
 InheritedmaintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the middle of its bounding box.
UIComponent
 InheritedmaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedmaxHorizontalScrollPosition : Number
The maximum value for the horizontalScrollPosition property.
ScrollControlBase
 InheritedmaxVerticalScrollPosition : Number
The maximum value for the verticalScrollPosition property.
ScrollControlBase
 InheritedmaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmeasuredHeight : Number
The default height of the component, in pixels.
UIComponent
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
UIComponent
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
UIComponent
 InheritedmeasuredWidth : Number
The default width of the component, in pixels.
UIComponent
 InheritedmenuSelectionMode : Boolean = false
A flag that indicates whether menu-style selection should be used.
ListBase
  minColumnWidth : Number
The minimum width of the columns, in pixels.
DataGrid
 InheritedminHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedminWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmoduleFactory : IFlexModuleFactory
A module factory is used as context for using embedded fonts and for finding the style manager that controls the styles for this component.
UIComponent
 InheritedmouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
UIComponent
 InheritedMXMLDescriptor : Array
[read-only]
UIComponent
 InheritedMXMLProperties : Array
[read-only]
UIComponent
 InheritednestLevel : int
Depth of this object in the containment hierarchy.
UIComponent
 InheritednonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
UIComponent
 InheritednullItemRenderer : IFactory
The custom item renderer for the control.
ListBase
 InheritednumAutomationChildren : int
[read-only] The number of automation children this container has.
UIComponent
 Inheritedowner : DisplayObjectContainer
The owner of this IVisualElement object.
UIComponent
 Inheritedparent : DisplayObjectContainer
[override] [read-only] The parent container or component for this component.
UIComponent
 InheritedparentApplication : Object
[read-only] A reference to the Application object that contains this UIComponent instance.
UIComponent
 InheritedparentDocument : Object
[read-only] A reference to the parent document object for this UIComponent.
UIComponent
 InheritedpercentHeight : Number
Specifies the height of a component as a percentage of its parent's size.
UIComponent
 InheritedpercentWidth : Number
Specifies the width of a component as a percentage of its parent's size.
UIComponent
 InheritedpostLayoutTransformOffsets : TransformOffsets
Defines a set of adjustments that can be applied to the object's transform in a way that is invisible to its parent's layout.
UIComponent
 InheritedprocessedDescriptors : Boolean
Set to true after immediate or deferred child creation, depending on which one happens.
UIComponent
 Inheritedrepeater : IRepeater
[read-only] A reference to the Repeater object in the parent document that produced this UIComponent.
UIComponent
 InheritedrepeaterIndex : int
[read-only] The index of the item in the data provider of the Repeater that produced this UIComponent.
UIComponent
 InheritedrepeaterIndices : Array
An Array containing the indices of the items in the data provider of the Repeaters in the parent document that produced this UIComponent.
UIComponent
 Inheritedrepeaters : Array
An Array containing references to the Repeater objects in the parent document that produced this UIComponent.
UIComponent
  resizableColumns : Boolean = true
A flag that indicates whether the user can change the size of the columns.
DataGrid
 Inheritedright : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 Inheritedrotation : Number
[override]
UIComponent
 InheritedrotationX : Number
[override] Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 InheritedrotationY : Number
[override] Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 InheritedrotationZ : Number
[override]
UIComponent
 InheritedrowCount : int
Number of rows to be displayed.
ListBase
 InheritedrowHeight : Number
The height of the rows in pixels.
ListBase
 InheritedscaleX : Number
[override] Number that specifies the horizontal scaling factor.
UIComponent
 InheritedscaleY : Number
[override] Number that specifies the vertical scaling factor.
UIComponent
 InheritedscaleZ : Number
[override] Number that specifies the scaling factor along the z axis.
UIComponent
 Inheritedscreen : Rectangle
[read-only] Returns an object that contains the size and position of the base drawing surface for this object.
UIComponent
 InheritedscrollTipFunction : Function
A function that computes the string to be displayed as the ScrollTip.
ScrollControlBase
 Inheritedselectable : Boolean
A flag that indicates whether the list shows selected items as selected.
ListBase
 InheritedselectedIndex : int
The index in the data provider of the selected item.
ListBase
 InheritedselectedIndices : Array
An array of indices in the data provider of the selected items.
ListBase
 InheritedselectedItem : Object
A reference to the selected item in the data provider.
ListBase
 InheritedselectedItems : Array
An array of references to the selected items in the data provider.
ListBase
 InheritedselectedItemsCompareFunction : Function
A function used to compare items in the selectedItems property against items in the data provider.
ListBase
 InheritedshowHeaders : Boolean
A flag that indicates whether the control should show column headers.
DataGridBase
 InheritedshowInAutomationHierarchy : Boolean
A flag that determines if an automation object shows in the automation hierarchy.
UIComponent
 InheritedshowScrollTips : Boolean = false
A flag that indicates whether a tooltip should appear near the scroll thumb when it is being dragged.
ScrollControlBase
  sortableColumns : Boolean = true
A flag that indicates whether the user can sort the data provider items by clicking on a column header cell.
DataGrid
 Inheritedstates : Array
The view states that are defined for this component.
UIComponent
 InheritedstyleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
UIComponent
 InheritedstyleManager : IStyleManager2
[read-only] Returns the StyleManager instance used by this component.
UIComponent
 InheritedstyleName : Object
The class style used by this component.
UIComponent
 InheritedstyleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors.
UIComponent
 InheritedsystemManager : ISystemManager
Returns the SystemManager object used by this component.
UIComponent
 InheritedtabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus via the TAB key This is similar to the tabEnabled property used by the Flash Player. This is usually true for components that handle keyboard input, but some components in controlbars have them set to false because they should not steal focus from another component like an editor.
UIComponent
 InheritedtoolTip : String
Text to display in the ToolTip.
UIComponent
 Inheritedtop : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 Inheritedtransform : Transform
[override] An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
UIComponent
 InheritedtransformX : Number
Sets the x coordinate for the transform center of the component.
UIComponent
 InheritedtransformY : Number
Sets the y coordinate for the transform center of the component.
UIComponent
 InheritedtransformZ : Number
Sets the z coordinate for the transform center of the component.
UIComponent
 Inheritedtransitions : Array
An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs.
UIComponent
 InheritedtweeningProperties : Array
Array of properties that are currently being tweened on this object.
UIComponent
 Inheriteduid : String
A unique identifier for the object.
UIComponent
 InheritedupdateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases of layout validation (provided that any were required).
UIComponent
 InheritedvalidationSubField : String
Used by a validator to associate a subfield with this component.
UIComponent
 Inheritedvalue : Object
[read-only] The selected item, or the data or label field of the selected item.
ListBase
 InheritedvariableRowHeight : Boolean
A flag that indicates whether the individual rows can have different height.
ListBase
 InheritedverticalCenter : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 InheritedverticalScrollPolicy : String
A property that indicates whether the vertical scroll bar is always on, always off, or automatically changes based on the parameters passed to the setScrollBarProperties() method.
ScrollControlBase
 InheritedverticalScrollPosition : Number
The offset into the content from the top edge.
ScrollControlBase
 InheritedviewMetrics : EdgeMetrics
[read-only] An EdgeMetrics object taking into account the scroll bars, if visible.
ScrollControlBase
 Inheritedvisible : Boolean
[override] Whether or not the display object is visible.
UIComponent
 Inheritedwidth : Number
[override] Number that specifies the width of the component, in pixels, in the parent's coordinates.
UIComponent
 InheritedwordWrap : Boolean
A flag that indicates whether text in the row should be word wrapped.
ListBase
 Inheritedx : Number
[override] Number that specifies the component's horizontal position, in pixels, within its parent container.
UIComponent
 Inheritedy : Number
[override] Number that specifies the component's vertical position, in pixels, within its parent container.
UIComponent
 Inheritedz : Number
[override]
UIComponent
Protected Properties
 PropertyDefined By
 InheritedactualCollection : ICollectionView
A copy of the value normally stored in collection used while running data changes effects.
ListBase
 InheritedactualIterator : IViewCursor
A copy of the value normally stored in iterator used while running data changes effects.
ListBase
 InheritedallowItemSizeChangeNotification : Boolean
[write-only] If false, renderers cannot invalidate size of List.
ListBase
 InheritedanchorBookmark : CursorBookmark
A bookmark to the item that is the anchor.
ListBase
 InheritedanchorIndex : int = -1
The offset of the item in the data provider that is the selection anchor point.
ListBase
 Inheritedborder : IFlexDisplayObject
The border object.
ScrollControlBase
 InheritedcachedItemsChangeEffect : IEffect = null
The effect that plays when changes occur in the data provider for the control, set through the itemsChangeEffect style.
ListBase
 InheritedcaretBookmark : CursorBookmark
A bookmark to the item under the caret.
ListBase
 InheritedcaretIndex : int = -1
The offset of the item in the data provider that is the selection caret point.
ListBase
 InheritedcaretIndicator : Sprite
The DisplayObject that contains the graphics that indicate which renderer is the caret.
ListBase
 InheritedcaretItemRenderer : IListItemRenderer
The renderer for the item under the caret.
ListBase
 InheritedcaretUID : String
The UID of the item under the caret.
ListBase
 Inheritedcollection : ICollectionView
An ICollectionView that represents the data provider.
ListBase
 InheritedcolumnCaretIndicator : Sprite
The DisplayObject that contains the graphics that indicates which renderer is the caret for lockedColumns.
DataGridBase
 InheritedcolumnHighlightIndicator : Sprite
The DisplayObject that contains the graphics that indicates which renderer is highlighted for lockedColumns.
DataGridBase
 InheritedcolumnMap : Object
A map of item renderes to columns.
DataGridBase
 InheritedcurrentCSSState : String
[read-only] The state to be used when matching CSS pseudo-selectors.
UIComponent
 InheriteddataEffectCompleted : Boolean = false
A flag that indicates that the a data change effect has just completed.
ListBase
 InheriteddataItemWrappersByRenderer : Dictionary
A dictionary mapping item renderers to the ItemWrappers used to supply their data.
ListBase
 InheriteddefaultColumnCount : int = 4
The default number of columns to display.
ListBase
 InheriteddefaultRowCount : int = 4
The default number of rows to display.
ListBase
 InheriteddragImage : IUIComponent
[read-only] Gets an instance of a class that displays the visuals during a drag and drop operation.
ListBase
 InheriteddragImageOffsets : Point
[read-only] Gets the offset of the drag image for drag and drop.
ListBase
 InheritedexplicitColumnCount : int = -1
The column count requested by explicitly setting the columnCount property.
ListBase
 InheritedexplicitColumnWidth : Number
The column width requested by explicitly setting the columnWidth.
ListBase
 InheritedexplicitRowCount : int = -1
The row count requested by explicitly setting rowCount.
ListBase
 InheritedexplicitRowHeight : Number
The row height requested by explicitly setting rowHeight.
ListBase
 InheritedfactoryMap : Dictionary
A map of item renderers by factory.
ListBase
 InheritedfreeItemRenderers : Array
A stack of unused item renderers.
ListBase
 InheritedfreeItemRenderersByFactory : Dictionary
A map of free item renderers by factory.
ListBase
 InheritedfreeItemRenderersTable : Dictionary
A per-column table of unused item renderers.
DataGridBase
 InheritedhasComplexLayoutMatrix : Boolean
[read-only] Returns true if the UIComponent has any non-translation (x,y) transform properties.
UIComponent
 Inheritedheader : DataGridHeaderBase
The header sub-component.
DataGridBase
 InheritedheaderMask : Shape
The header mask.
DataGridBase
 InheritedhighlightIndicator : Sprite
The DisplayObject that contains the graphics that indicates which renderer is highlighted.
ListBase
 InheritedhighlightItemRenderer : IListItemRenderer
The renderer that is currently rolled over or under the caret.
ListBase
 InheritedhighlightUID : String
The UID of the item that is current rolled over or under the caret.
ListBase
 InheritedhorizontalScrollBar : ScrollBar
The horizontal scroll bar.
ScrollControlBase
 InheriteditemsNeedMeasurement : Boolean = true
A flag that indicates whether the columnWidth and rowHeight properties need to be calculated.
ListBase
 InheriteditemsSizeChanged : Boolean = false
A flag that indicates that the size of the renderers may have changed.
ListBase
 Inheritediterator : IViewCursor
The main IViewCursor used to fetch items from the data provider and pass the items to the renderers.
ListBase
 InheritediteratorValid : Boolean = true
A flag that indicates that a page fault as occurred and that the iterator's position is not valid (not positioned at the topmost item being displayed).
ListBase
 InheritedkeySelectionPending : Boolean = false
A flag that indicates if keyboard selection was interrupted by a page fault.
ListBase
 InheritedlastDropIndex : int
The most recently calculated index where the drag item should be added to the drop target.
ListBase
 InheritedlastSeekPending : ListBaseSeekPending
The most recent seek that caused a page fault.
ListBase
 InheritedlistContent : ListBaseContentHolder
An internal display object that parents all of the item renderers, selection and highlighting indicators and other supporting graphics.
ListBase
 InheritedlistContentStyleFilters : Object
[read-only] The set of styles to pass from the ListBase to the listContent.
ListBase
 InheritedlistItems : Array
[read-only] An Array of Arrays that contains the itemRenderer instances that render each data provider item.
ListBase
 InheritedlockedColumnAndRowContent : DataGridLockedRowContentHolder
The sub-component that contains locked rows for locked columns.
DataGridBase
 InheritedlockedColumnContent : ListBaseContentHolder
The sub-component that contains locked columns.
DataGridBase
 InheritedlockedColumnHeader : DataGridHeaderBase
The header sub-component for locked columns.
DataGridBase
 InheritedlockedRowContent : DataGridLockedRowContentHolder
The sub-component that contains locked rows.
DataGridBase
 InheritedmaskShape : Shape
The mask.
ScrollControlBase
 InheritedmodifiedCollectionView : ModifiedCollectionView
The collection view that temporarily preserves previous data provider state to facilitate running data change effects.
ListBase
 InheritedrendererChanged : Boolean = false
A flag that indicates that the renderer changed.
ListBase
 InheritedreservedItemRenderers : Object
A hash map of currently unused item renderers that may be used again in the near future.
ListBase
 InheritedresourceManager : IResourceManager
[read-only] A reference to the object which manages all of the application's localized resources.
UIComponent
 InheritedrowInfo : Array
[read-only] An array of ListRowInfo objects that cache row heights and other tracking information for the rows in listItems.
ListBase
 InheritedrowMap : Object
A hash map of item renderers to their respective ListRowInfo object.
ListBase
 InheritedrunDataEffectNextUpdate : Boolean = false
A flag that indicates if a data effect should be initiated the next time the display is updated.
ListBase
 InheritedrunningDataEffect : Boolean = false
A flag indicating if a data change effect is currently running.
ListBase
 InheritedscrollAreaChanged : Boolean
A flag that the scrolling area changed due to the appearance or disappearance of scrollbars.
ScrollControlBase
 InheritedselectedData : Object
A hash table of ListBaseSelectionData objects that track which items are currently selected.
ListBase
 InheritedselectionIndicators : Object
A hash table of selection indicators.
ListBase
 InheritedselectionLayer : Sprite
The layer in listContent where all selection and highlight indicators are drawn.
ListBase
 InheritedselectionTweens : Object
A hash table of selection tweens.
ListBase
 InheritedshowCaret : Boolean
A flag that indicates whether to show caret.
ListBase
 InheritedunconstrainedRenderers : Dictionary
A hash map of item renderers that are not subject to the layout algorithms of the list.
ListBase
 InheritedunscaledHeight : Number
[read-only] A convenience method for determining the unscaled height of the component.
UIComponent
 InheritedunscaledWidth : Number
[read-only] A convenience method for determining the unscaled width of the component All of a component's drawing and child layout should be done within a bounding rectangle of this width, which is also passed as an argument to updateDisplayList().
UIComponent
 InheritedverticalScrollBar : ScrollBar
The vertical scroll bar.
ScrollControlBase
 InheritedvisibleData : Object
[read-only] A hash table of data provider item renderers currently in view.
ListBase
 InheritedwordWrapChanged : Boolean = false
A flag that indicates whether the value of the wordWrap property has changed since the last time the display list was updated.
ListBase
Public Methods
 MethodDefined By
  
Constructor.
DataGrid
 Inherited
addDataEffectItem(item:Object):void
Adds an item renderer if a data change effect is running.
ListBase
 Inherited
Adds a non-visual style client to this component instance.
UIComponent
 Inherited
calculateDropIndex(event:DragEvent = null):int
Returns the index where the dropped items should be added to the drop target.
ListBase
 Inherited
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
UIComponent
 Inherited
clearStyle(styleProp:String):void
Deletes a style property from this component instance.
UIComponent
 Inherited
contentToGlobal(point:Point):Point
Converts a Point object from content coordinates to global coordinates.
UIComponent
 Inherited
contentToLocal(point:Point):Point
Converts a Point object from content to local coordinates.
UIComponent
 Inherited
Returns a set of properties that identify the child within this container.
UIComponent
 Inherited
Returns a set of properties as automation IDs that identify the child within this container.
UIComponent
 Inherited
createColumnItemRenderer(c:DataGridColumn, forHeader:Boolean, data:Object):IListItemRenderer
Returns the item renderer for a column cell or for a column header.
DataGridBase
  
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.
DataGrid
 Inherited
Creates an item renderer given the data object.
ListBase
 Inherited
Creates an id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Deletes the id reference to this IUIComponent object on its parent document object.
UIComponent
  
This method closes an item editor currently open on an item renderer.
DataGrid
 Inherited
Returns a UITextFormat object corresponding to the text styles for this UIComponent.
UIComponent
 Inherited
dispatchEvent(event:Event):Boolean
[override] Dispatches an event into the event flow.
UIComponent
 Inherited
drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component.
UIComponent
 Inherited
drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object.
UIComponent
 Inherited
Called by the effect instance when it stops playing on the component.
UIComponent
 Inherited
Called by the effect instance when it starts playing on the component.
UIComponent
 Inherited
Ends all currently playing effects on the component.
UIComponent
 Inherited
executeBindings(recurse:Boolean = false):void
Executes all the bindings for which the UIComponent object is the destination.
UIComponent
 Inherited
findString(str:String):Boolean
Finds an item in the list based on a String, and moves the selection to it.
ListBase
 Inherited
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete.
UIComponent
 Inherited
generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array
UIComponent
 Inherited
generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):*
UIComponent
 Inherited
Provides the automation object at the specified index.
UIComponent
 Inherited
Provides the automation object list .
UIComponent
 Inherited
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size.
UIComponent
 Inherited
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size.
UIComponent
 Inherited
Finds the type selectors for this UIComponent instance.
UIComponent
 Inherited
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as getting the constraint style for this component.
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured height
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured width
UIComponent
 Inherited
getFocus():InteractiveObject
Gets the object that currently has focus.
UIComponent
 Inherited
Return the appropriate factory, using the default factory if none specified.
ListBase
 Inherited
getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height.
UIComponent
 Inherited
getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width.
UIComponent
 Inherited
getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen.
UIComponent
 Inherited
getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen.
UIComponent
 Inherited
Returns the transform matrix that is used to calculate the component's layout relative to its siblings.
UIComponent
 Inherited
Returns the layout transform Matrix3D for this element.
UIComponent
 Inherited
getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height.
UIComponent
 Inherited
getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width.
UIComponent
 Inherited
getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height.
UIComponent
 Inherited
getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width.
UIComponent
 Inherited
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height.
UIComponent
 Inherited
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width.
UIComponent
 Inherited
getRendererSemanticValue(target:Object, semanticProperty:String):Object
Returns true or false to indicates whether the effect should play on the target.
ListBase
 Inherited
getRepeaterItem(whichRepeater:int = -1):Object
Returns the item in the dataProvider that was used by the specified Repeater to produce this Repeater, or null if this Repeater isn't repeated.
UIComponent
 Inherited
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this component's style lookup chain.
UIComponent
 Inherited
getVisibleRect(targetParent:DisplayObject = null):Rectangle
Get the bounds of this object that are visible to the user on the screen.
UIComponent
 Inherited
globalToContent(point:Point):Point
Converts a Point object from global to content coordinates.
UIComponent
 Inherited
hasCSSState():Boolean
Returns true if currentCSSState is not null.
UIComponent
 Inherited
hasState(stateName:String):Boolean
Determines whether the specified state has been defined on this UIComponent.
UIComponent
 Inherited
Hides the drop indicator under the mouse pointer that indicates that a drag and drop operation is allowed.
ListBase
 Inherited
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
 Inherited
Get an item renderer for the index of an item in the data provider, if one exists.
ListBase
 Inherited
indicesToIndex(rowIndex:int, colIndex:int):int
Computes the offset into the data provider of the item at colIndex, rowIndex.
ListBase
 Inherited
initialize():void
Initializes the internal structure of this component.
UIComponent
 Inherited
Initializes various properties which keep track of repeated instances of this component.
UIComponent
 Inherited
Marks a component so that its updateDisplayList() method gets called during a later screen update.
UIComponent
 Inherited
Called by a component's items to indicate that their depth property has changed.
UIComponent
 Inherited
An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes.
UIComponent
 Inherited
Refresh all rows on the next update.
ListBase
 Inherited
Marks a component so that its commitProperties() method gets called during a later screen update.
UIComponent
 Inherited
Marks a component so that its measure() method gets called during a later screen update.
UIComponent
  
isItemEditable(data:Object):Boolean
Determines whether to allow editing of a dataprovider item on a per-row basis.
DataGrid
 Inherited
isItemHighlighted(data:Object):Boolean
Determines if the item renderer for a data provider item is highlighted (is rolled over via the mouse or under the caret due to keyboard navigation).
ListBase
 Inherited
isItemSelectable(data:Object):Boolean
Determines if the item renderer for a data provider item is selectable.
ListBase
 Inherited
isItemSelected(data:Object):Boolean
Determines if the item renderer for a data provider item is selected.
ListBase
 Inherited
isItemShowingCaret(data:Object):Boolean
Determines if the item renderer for a data provider item is the item under the caret due to keyboard navigation.
ListBase
 Inherited
isItemVisible(item:Object):Boolean
Determines if an item is being displayed by a renderer.
ListBase
 Inherited
itemRendererContains(renderer:IListItemRenderer, object:DisplayObject):Boolean
Determines whether a renderer contains (or owns) a display object.
ListBase
 Inherited
Returns the index of the item in the data provider of the item being rendered by this item renderer.
ListBase
 Inherited
itemToDataTip(data:Object):String
Returns the dataTip string the renderer would display for the given data object based on the dataTipField and dataTipFunction properties.
ListBase
 Inherited
itemToIcon(data:Object):Class
Returns the class for an icon, if any, for a data item, based on the iconField and iconFunction properties.
ListBase
 Inherited
Returns the item renderer for a given item in the data provider, if there is one.
ListBase
 Inherited
itemToLabel(data:Object):String
Returns the string the renderer would display for the given data object based on the labelField and labelFunction properties.
ListBase
 Inherited
localToContent(point:Point):Point
Converts a Point object from local to content coordinates.
UIComponent
 Inherited
matchesCSSState(cssState:String):Boolean
Returns true if cssState matches currentCSSState.
UIComponent
 Inherited
matchesCSSType(cssType:String):Boolean
Determines whether this instance is the same as, or is a subclass of, the given type.
UIComponent
 Inherited
measureHeightOfItems(index:int = -1, count:int = 0):Number
Measures a set of items from the data provider using the current item renderer and returns the sum of the heights of those items.
ListBase
 Inherited
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
 Inherited
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
 Inherited
measureWidthOfItems(index:int = -1, count:int = 0):Number
Measures a set of items from the data provider using the current item renderer and returns the maximum width found.
ListBase
 Inherited
move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
UIComponent
 Inherited
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children.
UIComponent
 Inherited
owns(child:DisplayObject):Boolean
Returns true if the chain of owner properties points from child to this UIComponent.
UIComponent
 Inherited
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent.
UIComponent
 Inherited
Prepares an IFlexDisplayObject for printing.
UIComponent
 Inherited
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
 Inherited
registerEffects(effects:Array):void
For each effect event, registers the EffectManager as one of the event listeners.
UIComponent
 Inherited
removeDataEffectItem(item:Object):void
Removes an item renderer if a data change effect is running.
ListBase
 Inherited
Removes a non-visual style client from this component instance.
UIComponent
 Inherited
replayAutomatableEvent(event:Event):Boolean
Replays the specified event.
UIComponent
 Inherited
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided.
UIComponent
 Inherited
[static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing().
UIComponent
 Inherited
scrollToIndex(index:int):Boolean
Ensures that the data provider item at the given index is visible.
ListBase
 Inherited
setActualSize(w:Number, h:Number):void
Sizes the object.
UIComponent
 Inherited
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as setting the constraint style for this component.
UIComponent
 Inherited
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
UIComponent
 Inherited
setFocus():void
Sets the focus to this component.
UIComponent
 Inherited
setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen.
UIComponent
 Inherited
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element.
UIComponent
 Inherited
setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings.
UIComponent
 Inherited
setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.
UIComponent
 Inherited
setMXMLDescriptor(value:Array):void
UIComponent
 Inherited
setMXMLProperties(value:Array):void
UIComponent
 Inherited
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
UIComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes.
UIComponent
 Inherited
Displays a drop indicator under the mouse pointer to indicate that a drag and drop operation is allowed and where the items will be dropped.
ListBase
 Inherited
styleChanged(styleProp:String):void
Detects changes to style properties.
UIComponent
 Inherited
Flex calls the stylesInitialized() method when the styles for a component are first initialized.
UIComponent
 Inherited
[static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.
UIComponent
 Inherited
toString():String
[override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.
FlexSprite
 Inherited
transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the transform while keeping a particular point, specified in the component's own coordinate space, fixed in the parent's coordinate space.
UIComponent
 Inherited
transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
A utility method to transform a point specified in the local coordinates of this object to its location in the object's parent's coordinates.
UIComponent
 Inherited
unconstrainRenderer(item:Object):void
Called by an UnconstrainItemAction effect as part of a data change effect if the item renderers corresponding to certain data items need to move outside the normal positions of item renderers in the control.
ListBase
 Inherited
Validates the position and size of children and draws other visuals.
UIComponent
 Inherited
Validate and update the properties and layout of this object and redraw it, if necessary.
UIComponent
 Inherited
Used by layout logic to validate the properties of a component by calling the commitProperties() method.
UIComponent
 Inherited
validateSize(recursive:Boolean = false):void
Validates the measured size of the component If the LayoutManager.invalidateSize() method is called with this ILayoutManagerClient, then the validateSize() method is called when it's time to do measurements.
UIComponent
 Inherited
Handles both the valid and invalid events from a validator assigned to this component.
UIComponent
 Inherited
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
Protected Methods
 MethodDefined By
 Inherited
addDragData(dragSource:Object):void
Adds the selected items to the DragSource object as part of a drag-and-drop operation.
ListBase
 Inherited
addMXMLChildren(comps:Array):void
UIComponent
 Inherited
Adds a renderer to the recycled renderer list, making it invisible and cleaning up references to it.
ListBase
 Inherited
Add a blank row to the beginning of the arrays that store references to the rows.
ListBase
 Inherited
adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle.
UIComponent
  
adjustListContent(unscaledWidth:Number = -1, unscaledHeight:Number = -1):void
[override] Called from the updateDisplayList() method to adjust the size and position of listContent.
DataGrid
 Inherited
adjustRow(contentHolder:ListBaseContentHolder, rowNum:int, yy:Number, hh:Number):void
Adjusts the size and positions of the renderers for the given rowNum, row position and height.
DataGridBase
 Inherited
Commits the computed matrix built from the combination of the layout matrix and the transform offsets to the flash displayObject's transform.
UIComponent
 Inherited
applySelectionEffect(indicator:Sprite, uid:String, itemRenderer:IListItemRenderer):void
Sets up the effect for applying the selection indicator.
ListBase
 Inherited
This is an internal method used by the Flex framework to support the Dissolve effect.
UIComponent
 Inherited
calculateDropIndicatorY(rowCount:Number, rowNum:int):Number
Calculates the y position of the drop indicator when performing a drag-and-drop operation.
ListBase
 Inherited
calculateRowHeight(data:Object, hh:Number, skipVisible:Boolean = false):Number
Calculates the row height of columns in a row.
DataGridBase
 Inherited
Determines if the call to the measure() method can be skipped.
UIComponent
 Inherited
Performs any final processing after child objects are created.
UIComponent
 Inherited
clearCaretIndicator(indicator:Sprite, itemRenderer:IListItemRenderer):void
Clears the caret indicator into the given Sprite.
ListBase
 Inherited
clearHighlightIndicator(indicator:Sprite, itemRenderer:IListItemRenderer):void
Clears the highlight indicator in the given Sprite.
ListBase
 Inherited
Removes all selection and highlight and caret indicators.
ListBase
 Inherited
clearRow(contentHolder:ListBaseContentHolder, rowNum:int):void
Removes renderers from a row that should be empty for the given rowNum.
DataGridBase
 Inherited
clearSelected(transition:Boolean = false):void
Clears the set of selected items and removes all graphics depicting the selected state of those items.
ListBase
  
Removes column header separators that the user normally uses to resize columns.
DataGrid
 Inherited
Empty the visibleData hash table.
ListBase
 Inherited
collectionChangeHandler(event:Event):void
Handles CollectionEvents dispatched from the data provider as the data changes.
ListBase
 Inherited
[override] Calculates the column width and row height and number of rows and columns based on whether properties like columnCount columnWidth, rowHeight and rowCount were explicitly set.
ListBase
 Inherited
Configures the ScrollBars based on the number of rows and columns and viewable rows and columns.
ListBase
 Inherited
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.
ListBase
 Inherited
copySelectedItems(useDataField:Boolean = true):Array
Copies the selected items in the order that they were selected.
ListBase
 Inherited
Creates the border for this component.
ScrollControlBase
 Inherited
[override] Creates objects that are children of this ListBase; in this case, the listContent object that will hold all the item renderers.
ListBase
 Inherited
createInFontContext(classObj:Class):Object
Creates a new object using a context based on the embedded font being used.
UIComponent
 Inherited
createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
Creates the object using a given moduleFactory.
UIComponent
 Inherited
destroyRow(i:int, numCols:int):void
Recycle a row that is no longer needed, and remove its indicators.
ListBase
 Inherited
dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void
Helper method for dispatching a PropertyChangeEvent when a property is updated.
UIComponent
 Inherited
Handles DragEvent.DRAG_COMPLETE events.
ListBase
 Inherited
Handles DragEvent.DRAG_DROP events.
ListBase
 Inherited
Handles DragEvent.DRAG_ENTER events.
ListBase
 Inherited
Handles DragEvent.DRAG_EXIT events.
ListBase
 Inherited
Handles DragEvent.DRAG_OVER events.
ListBase
 Inherited
dragScroll():void
Interval function that scrolls the list up or down if the mouse goes above or below the list.
ListBase
 Inherited
The default handler for the dragStart event.
ListBase
 Inherited
drawCaretIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Draws the caret indicator into the given Sprite at the position, width and height specified using the color specified.
ListBase
  
drawColumnBackground(s:Sprite, columnIndex:int, color:uint, column:DataGridColumn):void
Draws a column background for a column with the suggested color.
DataGrid
  
Draws the background of the headers into the given UIComponent.
DataGrid
 Inherited
drawHighlightIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Draws the highlight indicator into the given Sprite at the position, width and height specified using the color specified.
ListBase
  
drawHorizontalLine(s:Sprite, rowIndex:int, color:uint, y:Number):void
Draws a line between rows.
DataGrid
 Inherited
drawItem(item:IListItemRenderer, selected:Boolean = false, highlighted:Boolean = false, caret:Boolean = false, transition:Boolean = false):void
Draws the renderer with indicators that it is highlighted, selected, or the caret.
ListBase
  
Draw lines between columns, and column backgrounds.
DataGrid
  
drawLinesAndColumnGraphics(contentHolder:ListBaseContentHolder, visibleColumns:Array, separators:Object):void
Draw lines between columns, and column backgrounds.
DataGrid
  
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.
DataGrid
 Inherited
Draws any alternating row colors, borders and backgrounds for the rows.
ListBase
 Inherited
drawSelectionIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Draws the selection indicator into the given Sprite at the position, width and height specified using the color specified.
ListBase
  
Creates and displays the column header separators that the user normally uses to resize columns.
DataGrid
  
drawVerticalLine(s:Sprite, colIndex:int, color:uint, x:Number):void
Draw lines between columns.
DataGrid
 Inherited
drawVisibleItem(uid:String, selected:Boolean = false, highlighted:Boolean = false, caret:Boolean = false, transition:Boolean = false):void
Draws an item if it is visible.
DataGridBase
 Inherited
findKey(eventCode:int):Boolean
Tries to find the next item in the data provider that starts with the character in the eventCode parameter.
ListBase
 Inherited
Cleans up after a data change effect has finished running by restoring the original collection and iterator and removing any cached values used by the effect.
ListBase
 Inherited
[override] Sets selected items based on the caretIndex and anchorIndex properties.
DataGridBase
 Inherited
focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus.
UIComponent
 Inherited
focusOutHandler(event:FocusEvent):void
The event handler called when a UIComponent object loses focus.
UIComponent
 Inherited
generateMXMLAttributes(data:Array):void
UIComponent
 Inherited
generateMXMLInstances(document:Object, data:Array, recursive:Boolean = true):void
UIComponent
 Inherited
generateMXMLObject(document:Object, data:Array):Object
UIComponent
 Inherited
Retrieves an already-created item renderer not currently in use.
ListBase
 Inherited
indexToColumn(index:int):int
The column for the data provider item at the given index.
ListBase
 Inherited
indexToRow(index:int):int
The row for the data provider item at the given index.
ListBase
 Inherited
Initializes the implementation and storage of some of the less frequently used advanced layout features of a component.
UIComponent
 Inherited
Finalizes the initialization of this component.
UIComponent
 Inherited
Initializes this component's accessibility code.
UIComponent
 Inherited
initiateDataChangeEffect(unscaledWidth:Number, unscaledHeight:Number):void
Initiates a data change effect when there have been changes in the data provider.
ListBase
 Inherited
Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true).
UIComponent
 Inherited
isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects, where the UITextField object gets focus.
UIComponent
 Inherited
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.
ListBase
 Inherited
[override] Returns a Point object that defines the columnIndex and rowIndex properties of an item renderer.
DataGridBase
 Inherited
itemToUID(data:Object):String
Determines the UID for a data provider item.
ListBase
 Inherited
keyDownHandler(event:KeyboardEvent):void
The event handler called for a keyDown event.
UIComponent
 Inherited
keyUpHandler(event:KeyboardEvent):void
The event handler called for a keyUp event.
UIComponent
 Inherited
layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void
Responds to size changes by setting the positions and sizes of this control's borders.
ScrollControlBase
 Inherited
layoutColumnItemRenderer(c:DataGridColumn, item:IListItemRenderer, xx:Number, yy:Number):Point
Sizes and temporarily positions an itemRenderer for a column, returning its size as a Point.
DataGridBase
 Inherited
makeListData(data:Object, uid:String, rowNum:int, columnNum:int, column:DataGridColumn):BaseListData
Creates a new DataGridListData instance and populates the fields based on the input data provider item.
DataGridBase
 Inherited
makeRow(contentHolder:ListBaseContentHolder, rowNum:int, left:Number, right:Number, yy:Number, data:Object, uid:String):Number
Creates the renderers for the given rowNum, dataObject and uid.
DataGridBase
 Inherited
makeRowsAndColumns(left:Number, top:Number, right:Number, bottom:Number, firstColumn:int, firstRow:int, byCount:Boolean = false, rowsNeeded:uint = 0):Point
Make enough rows and columns to fill the area described by left, top, right, bottom.
ListBase
 Inherited
measure():void
[override] Calculates the measured width and height of the component based on the rowCount, columnCount, rowHeight and columnWidth properties.
ListBase
 Inherited
mouseClickHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_CLICK events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
mouseDoubleClickHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_DOUBLE_CLICK events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
mouseDownHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_DOWN events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
Determines which item renderer is under the mouse.
ListBase
 Inherited
mouseMoveHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_MOVE events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
mouseOutHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_OUT events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
mouseOverHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_OVER events from any mouse targets contained in the list, including the renderers.
ListBase
 Inherited
mouseUpHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_DOWN events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
mouseWheelHandler(event:MouseEvent):void
[override] Handles mouseWheel events by changing scroll positions.
ListBase
 Inherited
moveIndicatorsHorizontally(uid:String, moveBlockDistance:Number):void
Move the selection and highlight indicators horizontally.
ListBase
 Inherited
moveIndicatorsVertically(uid:String, moveBlockDistance:Number):void
Move the selection and highlight indicators vertically.
ListBase
 Inherited
moveRowVertically(i:int, numCols:int, moveBlockDistance:Number):void
Move a row vertically, and update the rowInfo record.
ListBase
 Inherited
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.
ListBase
 Inherited
moveSelectionVertically(code:uint, shiftKey:Boolean, ctrlKey:Boolean):void
[override] Moves the selection in a vertical direction in response to the user selecting items with the up arrow or down arrow keys and modifiers such as the Shift and Ctrl keys.
DataGridBase
  
Draws the sort arrow graphic on the column that is the current sort key.
DataGrid
 Inherited
Prepares the data effect for the collection event.
ListBase
 Inherited
prepareRowArray(contentHolder:ListBaseContentHolder, rowNum:int):void
Ensures that there is a slot in the row arrays for the given row number.
DataGridBase
 Inherited
Called by the updateDisplayList() method to remove existing item renderers and clean up various caching structures when the renderer changes.
ListBase
 Inherited
Update the keys in the visibleData hash table.
ListBase
 Inherited
Removes extra row from the end of the contentHolder.
DataGridBase
 Inherited
Remove a row from the arrays that store references to the row.
ListBase
 Inherited
removeIndicators(uid:String):void
Cleans up selection highlights and other associated graphics for a given item in the data provider.
ListBase
 Inherited
This method is called when a UIComponent is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way.
UIComponent
 Inherited
restoreRowArrays(modDeltaPos:int):void
Remove the requested number of rows from the beginning of the arrays that store references to the rows.
ListBase
 Inherited
roomForScrollBar(bar:ScrollBar, unscaledWidth:Number, unscaledHeight:Number):Boolean
Determines if there is enough space in this component to display a given scrollbar.
ScrollControlBase
 Inherited
scrollHandler(event:Event):void
Default event handler for the scroll event.
ScrollControlBase
 Inherited
scrollHorizontally(pos:int, deltaPos:int, scrollUp:Boolean):void
Adjusts the renderers in response to a change in scroll position.
ListBase
  
scrollPositionToIndex(horizontalScrollPosition:int, verticalScrollPosition:int):int
[override] Returns the data provider index for the item at the first visible row and column for the given scroll positions.
DataGrid
  
scrollVertically(pos:int, deltaPos:int, scrollUp:Boolean):void
[override] Adjusts the renderers in response to a change in scroll position.
DataGrid
 Inherited
The default failure handler when a seek fails due to a page fault.
ListBase
 Inherited
The default result handler when a seek fails due to a page fault.
ListBase
 Inherited
seekPositionSafely(index:int):Boolean
Seek to a position, and handle an ItemPendingError if necessary.
ListBase
 Inherited
selectItem(item:IListItemRenderer, shiftKey:Boolean, ctrlKey:Boolean, transition:Boolean = true):Boolean
Updates the set of selected items given that the item renderer provided was clicked by the mouse and the keyboard modifiers are in the given state.
ListBase
 Inherited
setRowCount(v:int):void
Sets the rowCount property without causing invalidation or setting the explicitRowCount property, which permanently locks in the number of rows.
ListBase
 Inherited
setRowHeight(v:Number):void
Sets the rowHeight property without causing invalidation or setting of explicitRowHeight which permanently locks in the height of the rows.
ListBase
 Inherited
setRowInfo(contentHolder:ListBaseContentHolder, rowNum:int, yy:Number, hh:Number, uid:String):void
Sets the rowInfo for the given rowNum, row position and height.
DataGridBase
 Inherited
setScrollBarProperties(totalColumns:int, visibleColumns:int, totalRows:int, visibleRows:int):void
Causes the ScrollControlBase to show or hide scrollbars based on the parameters passed in.
ScrollControlBase
 Inherited
setStretchXY(stretchX:Number, stretchY:Number):void
Specifies a transform stretch factor in the horizontal and vertical direction.
UIComponent
 Inherited
setupColumnItemRenderer(c:DataGridColumn, contentHolder:ListBaseContentHolder, rowNum:int, colNum:int, data:Object, uid:String):IListItemRenderer
Sets up an item renderer for a column and put it in the listItems array at the requested position.
DataGridBase
 Inherited
shiftRow(oldIndex:int, newIndex:int, numCols:int, shiftItems:Boolean):void
Shift a row in the arrays that reference rows.
ListBase
 Inherited
stateChanged(oldState:String, newState:String, recursive:Boolean):void
This method is called when a state changes to check whether state-specific styles apply to this component.
UIComponent
 Inherited
sumRowHeights(startRowIdx:int, endRowIdx:int):Number
Determine the height of the requested set of rows.
ListBase
 Inherited
truncateRowArrays(numRows:int):void
Remove all remaining rows from the end of the arrays that store references to the rows.
ListBase
 Inherited
Find an item renderer based on its UID if it is visible.
ListBase
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
[override] Adds or removes item renderers if the number of displayable items changed.
ListBase
 Inherited
updateList():void
Refreshes all rows.
ListBase
 Inherited
Redraws the renderer synchronously.
DataGridBase
Events
 Event Summary Defined By
 InheritedDispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method.UIComponent
 InheritedDispatched when the selectedIndex or selectedItem property changes as a result of user interaction.ListBase
  Dispatched when a user changes the width of a column, indicating that the amount of data displayed in that column may have changed.DataGrid
 InheritedDispatched when the component has finished its construction, property processing, measuring, layout, and drawing.UIComponent
 InheritedDispatched after the view state has changed.UIComponent
 InheritedDispatched after the currentState property changes, but before the view state changes.UIComponent
 InheritedDispatched when the data property changes.ListBase
 InheritedDispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop.UIComponent
 InheritedDispatched by the drop target when the user releases the mouse over it.UIComponent
 InheritedDispatched by a component when the user moves the mouse over the component during a drag operation.UIComponent
 InheritedDispatched by the component when the user drags outside the component, but does not drop the data onto the target.UIComponent
 InheritedDispatched by a component when the user moves the mouse while over the component during a drag operation.UIComponent
 InheritedDispatched by the drag initiator when starting a drag operation.UIComponent
 InheritedDispatched after an effect ends.UIComponent
 InheritedDispatched just before an effect starts.UIComponent
 InheritedDispatched after an effect is stopped, which happens only by a call to stop() on the effect.UIComponent
 InheritedDispatched after the component has entered a view state.UIComponent
 InheritedDispatched 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.DataGrid
  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.DataGrid
 InheritedDispatched when an object's state changes from visible to invisible.UIComponent
 InheritedDispatched when the component has finished its construction and has all initialization properties set.UIComponent
 InheritedDispatched when a component is monitored by a Validator and the validation failed.UIComponent
 InheritedDispatched when the user clicks on an item in the control.ListBase
 InheritedDispatched when the user double-clicks on an item in the control.ListBase
  Dispatched when the editedItemPosition property has been set and the item can be edited.DataGrid
  Dispatched when the user releases the mouse button while over an item renderer, tabs to the DataGrid control or within the DataGrid control, or in any other way attempts to edit an item.DataGrid
  Dispatched when an item editing session ends for any reason.DataGrid
  Dispatched when the item editor has just been instantiated.DataGrid
  Dispatched when an item renderer gets focus, which can occur if the user clicks on an item in the DataGrid control or navigates to the item using a keyboard.DataGrid
  Dispatched when an item renderer loses focus, which can occur if the user clicks another item in the DataGrid control or clicks outside the control, or uses the keyboard to navigate to another item in the DataGrid control or outside the control.DataGrid
 InheritedDispatched when the user rolls the mouse pointer out of an item in the control.ListBase
 InheritedDispatched when the user rolls the mouse pointer over an item in the control.ListBase
 InheritedDispatched from a component opened using the PopUpManager when the user clicks outside it.UIComponent
 InheritedDispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.UIComponent
 InheritedDispatched when the object has moved.UIComponent
 InheritedDispatched at the beginning of the component initialization sequence.UIComponent
 InheritedDispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method.UIComponent
 InheritedDispatched when the component is resized.UIComponent
 InheritedDispatched when the content is scrolled.ScrollControlBase
 InheritedDispatched when an object's state changes from invisible to visible.UIComponent
 InheritedDispatched after the component has entered a new state and any state transition animation to that state has finished playing.UIComponent
 InheritedDispatched when a component interrupts a transition to its current state in order to switch to a new state.UIComponent
 InheritedDispatched by the component when it is time to create a ToolTip.UIComponent
 InheritedDispatched by the component when its ToolTip has been hidden and is to be discarded soon.UIComponent
 InheritedDispatched by the component when its ToolTip is about to be hidden.UIComponent
 InheritedDispatched by the component when its ToolTip is about to be shown.UIComponent
 InheritedDispatched by the component when its ToolTip has been shown.UIComponent
 InheritedDispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.UIComponent
 InheritedA non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture.UIComponent
 InheritedA non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture.UIComponent
 InheritedA cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture.UIComponent
 InheritedDispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).UIComponent
 InheritedDispatched when a component is monitored by a Validator and the validation succeeded.UIComponent
 InheritedDispatched when values are changed programmatically or by user interaction.UIComponent
Styles
 Style Description Defined By
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Accent color used by component skins.
ScrollControlBase
 InheritedType: Array Format: Color CSS Inheritance: yes
The colors to use for the backgrounds of the items in the list.
ListBase
 InheritedType: Number CSS Inheritance: no Theme: halo
Alpha level of the color defined by the backgroundColor property, of the image or SWF file defined by the backgroundImage style.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: no Theme: halo
Background color of a component.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
Background color of the component when it is disabled.
ScrollControlBase
 InheritedType: Object Format: File CSS Inheritance: no Theme: halo
Background image of a component.
ScrollControlBase
 InheritedType: String CSS Inheritance: no Theme: halo
Scales the image specified by backgroundImage to different percentage sizes.
ScrollControlBase
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the top edge of the content area to the control's baseline position.
UIComponent
 InheritedType: Number CSS Inheritance: no Theme: spark
Alpha of the border.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: no Theme: halo, spark
Color of the border.
ScrollControlBase
 InheritedType: String CSS Inheritance: no Theme: halo
Bounding box sides.
ScrollControlBase
 InheritedType: Class CSS Inheritance: no
The border skin class of the component.
ScrollControlBase
 InheritedType: String CSS Inheritance: no
Bounding box style.
ScrollControlBase
 InheritedType: Number Format: Length CSS Inheritance: no Theme: halo
Bounding box thickness.
ScrollControlBase
 InheritedType: Boolean CSS Inheritance: no Theme: spark
Visibility of the border.
ScrollControlBase
 InheritedType: String CSS Inheritance: no
The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area.
UIComponent
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
The main color for a component.
ScrollControlBase
 InheritedType: 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).
DataGrid
  
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).
DataGrid
 InheritedType: Number CSS Inheritance: yes Theme: spark
The alpha of the content background for this component.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of the content area of the component.
ScrollControlBase
  
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 DataGrids instead of having to set each one individually. If you set the DataGridColumn's itemEditor property, it supercedes this value. The default value is null.
DataGrid
  
defaultDataGridItemRenderer
Type: Class CSS Inheritance: no
Name of the class of the itemRenderer to be used if one is not specified for a column or its header. This is a way to set an itemRenderer for a group of DataGrids instead of having to set each one individually. If you set the DataGrid's itemRenderer property, it supercedes this value. The default value is null.
DataGrid
 InheritedType: String CSS Inheritance: yes
The directionality of the text displayed by the component.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of text in the component if it is disabled.
ScrollControlBase
  
disabledIconColor
Type: uint Format: Color CSS Inheritance: yes Theme: halo
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.
DataGrid
 InheritedType: Class CSS Inheritance: no
The skin to use to indicate where a dragged item can be dropped.
ListBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
Color of the drop shadow.
ScrollControlBase
 InheritedType: Boolean CSS Inheritance: no Theme: halo
Boolean property that specifies whether the component has a visible drop shadow.
ScrollControlBase
 InheritedType: Boolean CSS Inheritance: no Theme: spark
Boolean property that specifies whether the component has a visible drop shadow.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of the component highlight when validation fails.
UIComponent
 InheritedType: Number CSS Inheritance: no
Specifies the alpha transparency value of the focus skin.
ScrollControlBase
 InheritedType: String CSS Inheritance: no
Blend mode used by the focus rectangle.
UIComponent
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of focus ring when the component is in focus.
ScrollControlBase
 InheritedType: String CSS Inheritance: no
Specifies which corners of the focus rectangle should be rounded.
ScrollControlBase
 InheritedType: Class CSS Inheritance: no
Skin used to draw the focus rectangle.
UIComponent
 InheritedType: Number Format: Length CSS Inheritance: no
Thickness, in pixels, of the focus rectangle outline.
UIComponent
 InheritedType: String CSS Inheritance: yes
Sets the antiAliasType property of internal TextFields.

See also

flash.text.TextField
flash.text.AntiAliasType
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Name of the font to use.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Sets the gridFitType property of internal TextFields that represent text in Flex controls.

See also

flash.text.TextField
flash.text.GridFitType
ScrollControlBase
 InheritedType: Number CSS Inheritance: yes
Sets the sharpness property of internal TextFields that represent text in Flex controls.

See also

flash.text.TextField
ScrollControlBase
 InheritedType: Number Format: Length CSS Inheritance: yes
Height of the text, in pixels.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Determines whether the text is italic font.
ScrollControlBase
 InheritedType: Number CSS Inheritance: yes
Sets the thickness property of internal TextFields that represent text in Flex controls.

See also

flash.text.TextField
ScrollControlBase
 InheritedType: 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 DataGrid control. The default value for the Halo theme is mx.skins.halo.DataGridHeaderBackgroundSkin. The default value for the Spark theme is mx.skins.spark.DataGridHeaderBackgroundSkin.
DataGrid
  
headerColors
Type: Array Format: Color CSS Inheritance: yes Theme: halo
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].
DataGrid
  
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".
DataGrid
  
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 DataGrid control. The default value for the Halo theme is mx.skins.halo.DataGridHeaderSeparator. The default value for the Spark theme is mx.skins.spark.DataGridHeaderSeparatorSkin.
DataGrid
  
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".
DataGrid
 InheritedType: String CSS Inheritance: no
The horizontal distance in pixels from the center of the component's content area to the center of the component.
UIComponent
  
horizontalGridLineColor
Type: uint Format: Color CSS Inheritance: yes
The color of the horizontal grid lines. The default value is 0xF7F7F7.
DataGrid
  
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.
DataGrid
  
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 DataGrid control. By default, the DataGrid control uses the drawHorizontalLine() and drawVerticalLine() methods to draw the separators. The default value is undefined.
DataGrid
 InheritedType: 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 DataGrid control. By default, the DataGrid control uses the drawHorizontalLine() and drawVerticalLine() methods to draw the separators. The default value is undefined.
DataGrid
  
iconColor
Type: uint Format: Color CSS Inheritance: yes Theme: halo
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.
DataGrid
 InheritedType: String CSS Inheritance: yes
The primary interaction mode for this component.

See also

UIComponent
 InheritedType: Boolean CSS Inheritance: yes
A Boolean value that indicates whether kerning is enabled (true) or disabled (false).
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Specifies the desired layout direction of a component.

See also

UIComponent
 InheritedType: Number Format: Length CSS Inheritance: yes
Additional vertical space between lines of text.
ScrollControlBase
 InheritedType: String CSS Inheritance: no
The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area.
UIComponent
 InheritedType: Number CSS Inheritance: yes
The number of additional pixels to appear between each character.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
The locale of the text displayed by this component.
ScrollControlBase
 InheritedType: Number Format: Length CSS Inheritance: no
The number of pixels between the bottom of the row and the bottom of the renderer in the row.
ListBase
 InheritedType: Number Format: Length CSS Inheritance: no
Number of pixels between the component's left border and the left edge of its content area.
ListBase
 InheritedType: Number Format: Length CSS Inheritance: no
Number of pixels between the component's right border and the right edge of its content area.
ListBase
 InheritedType: Number Format: Length CSS Inheritance: no
The number of pixels between the top of the row and the top of the renderer in the row.
ListBase
 InheritedType: String CSS Inheritance: no
The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area.
UIComponent
  
rollOverColor
Type: uint Format: Color CSS Inheritance: yes
The color of the row background when the user rolls over the row. The default value for the Halo theme is 0xB2E1FF. The default value for the Spark theme is 0xCEDBEF.
DataGrid
  
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 for the Halo theme is 0x7FCEFF. The default value for the Spark theme is 0xA8C6EE.
DataGrid
 InheritedType: uint Format: Color CSS Inheritance: yes
The color of the background of a renderer when the component is disabled.
ListBase
 InheritedType: Number Format: Time CSS Inheritance: no
The duration of the selection effect.
ListBase
 InheritedType: Function CSS Inheritance: no
The easingFunction for the selection effect.
ListBase
 InheritedType: String CSS Inheritance: no Theme: halo
Direction of the drop shadow.
ScrollControlBase
 InheritedType: Number Format: Length CSS Inheritance: no Theme: halo
Distance of the drop shadow.
ScrollControlBase
 InheritedType: Boolean CSS Inheritance: yes
Show the error border or skin when this component is invalid.
UIComponent
 InheritedType: Boolean CSS Inheritance: yes
Show the error tip when this component is invalid and the user rolls over it.
UIComponent
  
sortArrowSkin
Type: Class CSS Inheritance: no
The class to use as the skin for the arrow that indicates the column sort direction. The default value for the Halo theme is mx.skins.halo.DataGridSortArrow. The default value for the Spark theme is mx.skins.spark.DataGridSortArrow.
DataGrid
  
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 the "cursorStretch" symbol from the Assets.swf file.
DataGrid
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of any symbol of a component.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Alignment of text within a container.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Determines whether the text is underlined.
ScrollControlBase
 InheritedType: Class CSS Inheritance: no
The class implementing IUITextField that is used by this component to render text.
ScrollControlBase
 InheritedType: Number Format: Length CSS Inheritance: yes
Offset of first line of text from the left side of the container, in pixels.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes
The color of the text of a renderer when the user rolls over a it.
ListBase
 InheritedType: uint Format: Color CSS Inheritance: yes
The color of the text of a renderer when the user selects it.
ListBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
Theme color of a component.
UIComponent
 InheritedType: String CSS Inheritance: no
The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area.
UIComponent
 InheritedType: Boolean CSS Inheritance: no
A flag that controls whether items are highlighted as the mouse rolls over them.
ListBase
 InheritedType: String CSS Inheritance: no
The vertical alignment of a renderer in a row.
ListBase
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the center of the component's content area to the center of the component.
UIComponent
  
verticalGridLineColor
Type: uint Format: Color CSS Inheritance: yes
The color of the vertical grid lines. The default value for the Halo theme is 0xCCCCCC. The default value for the Spark theme is 0x696969.
DataGrid
  
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.
DataGrid
  
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 DataGrid control. By default, the DataGrid control uses the drawHorizontalLine() and drawVerticalLine() methods to draw the separators. The default value is undefined.
DataGrid
 InheritedType: 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 DataGrid control. By default, the DataGrid control uses the drawHorizontalLine() and drawVerticalLine() methods to draw the separators. The default value is undefined.
DataGrid
Effects
 Effect Description Defined By
 Inherited Triggering Event: added
Played when the component is added as a child to a Container.
UIComponent
 Inherited Triggering Event: creationComplete
Played when the component is created.
UIComponent
 Inherited Triggering Event: focusIn
Played when the component gains keyboard focus.
UIComponent
 Inherited Triggering Event: focusOut
Played when the component loses keyboard focus.
UIComponent
 Inherited Triggering Event: hide
Played when the component becomes invisible.
UIComponent
 Inherited Triggering Event: mouseDown
Played when the user presses the mouse button while over the component.
UIComponent
 Inherited Triggering Event: mouseUp
Played when the user releases the mouse button while over the component.
UIComponent
 Inherited Triggering Event: move
Played when the component is moved.
UIComponent
 Inherited Triggering Event: removed
Played when the component is removed from a Container.
UIComponent
 Inherited Triggering Event: resize
Played when the component is resized.
UIComponent
 Inherited Triggering Event: rollOut
Played when the user rolls the mouse so it is no longer over the component.
UIComponent
 Inherited Triggering Event: rollOver
Played when the user rolls the mouse over the component.
UIComponent
 Inherited Triggering Event: show
Played when the component becomes visible.
UIComponent
Public Constants
 ConstantDefined By
 InheritedDEFAULT_MAX_HEIGHT : Number = 10000
[static] The default value for the maxHeight property.
UIComponent
 InheritedDEFAULT_MAX_WIDTH : Number = 10000
[static] The default value for the maxWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_HEIGHT : Number = 22
[static] The default value for the measuredHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_HEIGHT : Number = 22
[static] The default value for the measuredMinHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_WIDTH : Number = 40
[static] The default value for the measuredMinWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_WIDTH : Number = 160
[static] The default value for the measuredWidth property.
UIComponent
Property Detail
columnsproperty
columns:Array[override]

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

An array of DataGridColumn objects, one for each column that can be displayed. If not explicitly set, the DataGrid 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 DataGrid control returned a new copy of the array of columns and therefore did not notice the changes.

This property can be used as the source for data binding.


Implementation
    public function get columns():Array
    public function set columns(value:Array):void
draggableColumnsproperty 
draggableColumns:Boolean

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

A flag that indicates whether the user is allowed to reorder columns. If true, the user can reorder the columns of the DataGrid control by dragging the header cells.

The default value is true.


Implementation
    public function get draggableColumns():Boolean
    public function set draggableColumns(value:Boolean):void
editableproperty 
editable:Boolean

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

A flag that indicates whether or not the user can edit items in the data provider. If true, the item renderers in the control are editable. The user can click on an item renderer to open an editor.

You can turn off editing for individual columns of the DataGrid control using the DataGridColumn.editable property, or by handling the itemEditBeginning and itemEditBegin events

The default value is false.


Implementation
    public function get editable():Boolean
    public function set editable(value:Boolean):void
editedItemPositionproperty 
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.


Implementation
    public function get editedItemPosition():Object
    public function set editedItemPosition(value:Object):void
editedItemRendererproperty 
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 DataGrid 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.


Implementation
    public function get editedItemRenderer():IListItemRenderer
enableIMEproperty 
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.


Implementation
    public function get enableIME():Boolean
horizontalScrollPositionproperty 
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 a DataGrid control. The DataGrid 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 that scrolls by pixels. The DataGrid control always aligns the left edge of a column with the left edge of the DataGrid control.


Implementation
    public function get horizontalScrollPosition():Number
    public function set horizontalScrollPosition(value:Number):void
imeModeproperty 
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 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.


Implementation
    public function get imeMode():String
    public function set imeMode(value:String):void

See also

flash.system.IMEConversionMode
itemEditorInstanceproperty 
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 DataGridColumn.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.

minColumnWidthproperty 
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 DataGrid 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.


Implementation
    public function get minColumnWidth():Number
    public function set minColumnWidth(value:Number):void
resizableColumnsproperty 
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 DataGrid control by dragging the grid lines between the header cells. If true, individual columns must also have their resizable properties set to false to prevent the user from resizing a particular column.

The default value is true.

sortableColumnsproperty 
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 DataGridColumn.dataField property of the column or the DataGridColumn.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 DataGrid 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 DataGrid sorts using that column's DataGridColumn.dataField or DataGridColumn.sortCompareFunction properties.

The default value is true.

See also

Constructor Detail
DataGrid()Constructor
public function DataGrid()

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

Constructor.

Method Detail
adjustListContent()method
override protected function adjustListContent(unscaledWidth:Number = -1, unscaledHeight:Number = -1):void

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

Called from the updateDisplayList() method to adjust the size and position of listContent.

Parameters

unscaledWidth:Number (default = -1) — The width of the listContent. This value ignores changes to the width from external components or settings.
 
unscaledHeight:Number (default = -1) — The height of the listContent. This value ignores changes to the height from external components or settings.

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 the user normally uses to resize columns.

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 only call this method 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.

drawColumnBackground()method 
protected function drawColumnBackground(s:Sprite, columnIndex:int, color:uint, column:DataGridColumn):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 DataGridColumn for that column has changed.
 
color:uint — The suggested color for the indicator
 
column:DataGridColumn — The column of the DataGrid 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 may 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

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

drawLinesAndColumnGraphics()method 
protected function drawLinesAndColumnGraphics(contentHolder:ListBaseContentHolder, visibleColumns:Array, separators:Object):void

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

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

Parameters

contentHolder:ListBaseContentHolder — A container of all of the DataGrid's item renderers and item editors.
 
visibleColumns:Array — An array of the visible columns in the DataGrid.
 
separators:Object — An object that defines the top, bottom, left, and right lines that separate the columns and rows.

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 10th 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 and 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

Draw 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

isItemEditable()method 
public function isItemEditable(data:Object):Boolean

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

Determines whether to allow editing of a dataprovider item on a per-row basis. The default implementation of this method only checks the editable property of the DataGrid and returns false if editable is false or if the dataprovider item is null.

This method can be overridden to allow fine-grained control of which dataprovider items are editable. For example, if you want to disallow editing of grouping rows or summary rows you would override this method with custom logic to this behavior.

Parameters

data:Object — The data provider item. The default implementation of this method returns false if the data object is null.

Returns
Boolean — The default behavior is to return true if the DataGrid's editable property is true and the data object is not null.
placeSortArrow()method 
protected function placeSortArrow():void

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

Draws the sort arrow graphic on the column that is the current sort key. This implementation creates or reuses an instance of the skin specified by sortArrowSkin style property and places it in the appropriate column header. It also shrinks the size of the column header if the text in the header would be obscured by the sort arrow.

scrollPositionToIndex()method 
override protected function scrollPositionToIndex(horizontalScrollPosition:int, verticalScrollPosition:int):int

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

Returns the data provider index for the item at the first visible row and column for the given scroll positions.

Parameters

horizontalScrollPosition:int — The horizontalScrollPosition property value corresponding to the scroll position.
 
verticalScrollPosition:int — The verticalScrollPosition property value corresponding to the scroll position.

Returns
int — The data provider index.
scrollVertically()method 
override protected function scrollVertically(pos:int, deltaPos:int, scrollUp:Boolean):void

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

Adjusts the renderers in response to a change in scroll position.

The list classes attempt to optimize scrolling when the scroll position has changed by less than the number of visible rows. In that situation some rows are unchanged and just need to be moved, other rows are removed and then new rows are added. If the scroll position changes too much, all old rows are removed and new rows are added by calling the makeRowsAndColumns() method for the entire viewable area.

Parameters

pos:int — The new scroll position.
 
deltaPos:int — The change in position. This value is always a positive number.
 
scrollUp:Booleantrue if the scroll position is getting smaller.

Event Detail
columnStretch Event
Event Object Type: mx.events.DataGridEvent
DataGridEvent.type property = mx.events.DataGridEvent.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 "off", other columns shrink or expand to compensate for the columns' resizing, and they also dispatch this event.

The DataGridEvent.COLUMN_STRETCH constant defines the value of the 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:

PropertyValue
bubblesfalse
cancelablefalse
columnIndex The zero-based index of the item's column in the DataGrid object's columns array.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dataFieldThe name of the field or property in the data associated with the column.
itemRenderernull
localXthe x position of the mouse
reasonnull
rowIndexThe zero-based index of the item in the data provider.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeDataGridEvent.COLUMN_STRETCH
headerRelease Event  
Event Object Type: mx.events.DataGridEvent
DataGridEvent.type property = mx.events.DataGridEvent.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 DataGrid 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.

The DataGridEvent.HEADER_RELEASE constant defines the value of the 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:

PropertyValue
bubblesfalse
cancelabletrue
columnIndex The zero-based index of the item's column in the DataGrid object's columns array.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dataFieldThe name of the field or property in the data associated with the column.
itemRendererThe header renderer that is being released.
localXNaN
reasonnull
rowIndexnull
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeDataGridEvent.HEADER_RELEASE
headerShift Event  
Event Object Type: mx.events.IndexChangedEvent
IndexChangedEvent.type property = mx.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 the type 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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
inputTypeIndicates whether this event was caused by a mouse or keyboard interaction.
newIndexThe zero-based index of the header after the change.
oldIndexThe zero-based index of the header before the change.
relatedObjectnull
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TriggerEventThe event that triggered this event.
TypeIndexChangedEvent.HEADER_SHIFT
itemEditBegin Event  
Event Object Type: mx.events.DataGridEvent
DataGridEvent.type property = mx.events.DataGridEvent.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.

The DataGridEvent.ITEM_EDIT_BEGIN constant defines the value of the 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:

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:

  1. Call preventDefault() to stop Flex from calling the createItemEditor() method as part of the default event listener.
  2. Set the itemEditor property to the appropriate editor.
  3. Call the createItemEditor() method.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
columnIndex The zero-based index of the item's column in the DataGrid object's columns array.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dataFieldnull
itemRendererThe item renderer for the item that is being edited.
localXNaN
reasonnull
rowIndexThe zero-based index of the item in the data provider.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeDataGridEvent.ITEM_EDIT_BEGIN
itemEditBeginning Event  
Event Object Type: mx.events.DataGridEvent
DataGridEvent.type property = mx.events.DataGridEvent.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 DataGrid control or within the DataGrid control, or in any other way attempts to edit an item.

The DataGridEvent.ITEM__EDIT_BEGINNING constant defines the value of the type 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 DataGrid.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:

PropertyValue
bubblesfalse
cancelabletrue
columnIndex The zero-based index of the item's column in the DataGrid object's columns array.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dataFieldThe name of the field or property in the data associated with the item's column.
itemRendererThe 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.
localXNaN
reasonnull
rowIndexThe zero-based index of the item in the data provider.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeDataGridEvent.ITEM_EDIT_BEGINNING
itemEditEnd Event  
Event Object Type: mx.events.DataGridEvent
DataGridEvent.type property = mx.events.DataGridEvent.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 DataGridEvent.ITEM_EDIT_END constant defines the value of the type 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:

You typically write an event listener for this event to perform the following actions:

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
columnIndex The zero-based index of the item's column in the DataGrid object's columns array.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dataFieldThe name of the field or property in the data associated with the item's column.
itemRendererThe item renderer for the item that is being edited.
localXNaN
reasonA constant defining the reason for the event. The value must be a member of the DataGridEventReason class.
rowIndexThe zero-based index of the item in the data provider.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeDataGridEvent.ITEM_EDIT_END
itemEditorCreate Event  
Event Object Type: mx.events.DataGridEvent
DataGridEvent.type property = mx.events.DataGridEvent.ITEM_EDITOR_CREATE

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

Dispatched when the item editor has just been instantiated.

The DataGridEvent.ITEM_EDITOR_CREATE constant defines the value of the type property of the event object for a itemEditorCreate event, which indicates that the datagrid has completed the creation of the item editor.

There is no default listener for this event.

You typically write your own event listener for this event to allow custom modifications to the itemEditor before the user can begin editing.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
columnIndex The zero-based index of the item's column in the DataGrid object's columns array.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dataFieldnull
itemRenderernull
localXNaN
reasonnull
rowIndexThe zero-based index of the item in the data provider.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeDataGridEvent.ITEM_EDITOR_CREATE
itemFocusIn Event  
Event Object Type: mx.events.DataGridEvent
DataGridEvent.type property = mx.events.DataGridEvent.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 DataGrid control or navigates to the item using a keyboard. Only dispatched if the item is editable.

The DataGridEvent.ITEM_FOCUS_IN constant defines the value of the type 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:

PropertyValue
bubblesfalse
cancelablefalse
columnIndex The zero-based index of the item's column in the DataGrid object's columns array.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dataFieldnull
itemRendererThe item editor instance for the item that is being edited.
localXNaN
reasonnull
rowIndexThe zero-based index of the item in the data provider.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeDataGridEvent.ITEM_FOCUS_IN
itemFocusOut Event  
Event Object Type: mx.events.DataGridEvent
DataGridEvent.type property = mx.events.DataGridEvent.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 DataGrid control or clicks outside the control, or uses the keyboard to navigate to another item in the DataGrid control or outside the control. Only dispatched if the item is editable.

The DataGridEvent.ITEM_FOCUS_OUT constant defines the value of the type 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:

PropertyValue
bubblesfalse
cancelablefalse
columnIndex The zero-based index of the item's column in the DataGrid object's columns array.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dataFieldnull
itemRendererThe item editor instance for the item that is being edited.
localXNaN
reasonnull
rowIndexThe zero-based index of the item in the data provider.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeDataGridEvent.ITEM_FOCUS_OUT
Examples
SimpleDataGrid.mxml
<?xml version="1.0" encoding="utf-8"?>
<!--

  Licensed to the Apache Software Foundation (ASF) under one or more
  contributor license agreements.  See the NOTICE file distributed with
  this work for additional information regarding copyright ownership.
  The ASF licenses this file to You under the Apache License, Version 2.0
  (the "License"); you may not use this file except in compliance with
  the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

-->
<!-- Simple example to demonstrate the Halo DataGrid control. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
        xmlns:s="library://ns.adobe.com/flex/spark"
        xmlns:mx="library://ns.adobe.com/flex/mx">

    <fx:Declarations>
        <fx:XMLList id="employees">
            <employee>
                <name>Christina Coenraets</name>
                <phone>555-219-2270</phone>
                <email>ccoenraets@fictitious.com</email>
                <active>true</active>
            </employee>
            <employee>
                <name>Joanne Wall</name>
                <phone>555-219-2012</phone>
                <email>jwall@fictitious.com</email>
                <active>true</active>
            </employee>
            <employee>
                <name>Maurice Smith</name>
                <phone>555-219-2012</phone>
                <email>maurice@fictitious.com</email>
                <active>false</active>
            </employee>
            <employee>
                <name>Mary Jones</name>
                <phone>555-219-2000</phone>
                <email>mjones@fictitious.com</email>
                <active>true</active>
            </employee>
        </fx:XMLList>
    </fx:Declarations>

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

            <mx:DataGrid id="dg" width="100%" height="100%" rowCount="5" dataProvider="{employees}">
                <mx:columns>
                    <mx:DataGridColumn dataField="name" headerText="Name"/>
                    <mx:DataGridColumn dataField="phone" headerText="Phone"/>
                    <mx:DataGridColumn dataField="email" headerText="Email"/>
                </mx:columns>
            </mx:DataGrid>

            <mx:Form width="100%" height="100%">
                <mx:FormItem label="Name">
                    <mx:Label text="{dg.selectedItem.name}"/>
                </mx:FormItem>
                <mx:FormItem label="Email">
                    <mx:Label text="{dg.selectedItem.email}"/>
                </mx:FormItem>
                <mx:FormItem label="Phone">
                    <mx:Label text="{dg.selectedItem.phone}"/>
                </mx:FormItem>
            </mx:Form>
        </s:VGroup>
    </s:Panel>

</s:Application>