Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
Grid

Package | spark.components
Class | public class Grid
Inheritance | Grid Group GroupBase UIComponent FlexSprite flash.display.Sprite
Implements | IDataGridElement, IDataProviderEnhance

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

The Grid control displays a list of data items called its data provider in a scrollable table or "grid", one item per row. Each of the grid's columns, defined by a GridColumn object, displays a value based on the item for the corresponding row. The grid's data provider is mutable, meaning its items can be added or removed, or changed. Similarly, the list of columns is mutable.

The Grid component is intended to be used as a DataGrid skin part, or as an element of other custom composite components. Therefore, it is not skinnable, it does not include a scroller or scrollbars, and it does not provide default mouse or keyboard event handling.

Each visible Grid cell is displayed by a GridItemRenderer instance created by using the `itemRenderer` property. specify an item renderer for each column. Before it is displayed, each item renderer instance is configured with the value of the data provider item for that row. Item renderers are created as needed and then, to keep creation overhead to a minimum, pooled and recycled.

The Grid control supports a doubleClick event, according the `doubleClickMode` property.

The Grid control supports selection, according the `selectionMode` property. The set of selected row or cell indices can be modified or queried programatically using the selection methods, such as `setSelectedIndex` or `selectionContainsIndex()`.

The Grid control displays hover, caret, and selection indicators based on the `selectionMode` property and the corresponding row index and column index properties, such as `hoverRowIndex` and `columnRowIndex`. An indicator can be any visual element. Indicators that implement IGridVisualElement can configure themselves according to the row and column in which they are used.

The Grid control supports smooth scrolling. Their vertical and horizontal scroll positions define the pixel origin of the visible part of the grid and the grid's layout only displays as many cell item renderers as are needed to fill the available space.

The Grid control supports variable height rows that automatically compute their height based on the item renderers' contents. This support is called grid virtualization because the mapping from (pixel) scroll positions to row and column indices is typically based on incomplete information about the preferred sizes for grid cells. The Grid caches the computed heights of rows that have been scrolled into view and estimates the rest based on a single `typicalItem`.

Transitions in DataGrid item renderers aren't supported. The GridItemRenderer class has disabled its `transitions` property so setting it will have no effect.

MXML Syntax Show MXML Syntax
Hide MXML Syntax

The `<s:Grid>` tag inherits all of the tag attributes of its superclass and adds the following tag attributes:

      <s:Grid
        Properties
      />

Default MXML Property `mxmlContent`

See also

DataGrid
spark.components.gridClasses.GridColumn

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | accessibilityDescription : String A convenience accessor for the description property in this UIComponent's accessibilityProperties object. | UIComponent
|  | accessibilityEnabled : Boolean A convenience accessor for the silent property in this UIComponent's accessibilityProperties object. | UIComponent
|  | accessibilityName : String A convenience accessor for the name property in this UIComponent's accessibilityProperties object. | UIComponent
|  | accessibilityShortcut : String A convenience accessor for the shortcut property in this UIComponent's accessibilityProperties object. | UIComponent
|  | activeEffects : Array [read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances. | UIComponent
|  | anchorColumnIndex : int The column index of the anchor for the next shift selection. | Grid
|  | anchorRowIndex : int The row index of the anchor for the next shift selection. | Grid
|  | autoLayout : Boolean If true, measurement and layout are done when the position or size of a child is changed. | GroupBase
|  | automationDelegate : Object The delegate object that handles the automation-related functionality. | UIComponent
|  | automationEnabled : Boolean [read-only] True if this component is enabled for automation, false otherwise. | UIComponent
|  | automationName : String Name that can be used as an identifier for this object. | UIComponent
|  | automationOwner : DisplayObjectContainer [read-only] The owner of this component for automation purposes. | UIComponent
|  | automationParent : DisplayObjectContainer [read-only] The parent of this component for automation purposes. | UIComponent
|  | automationTabularData : Object [read-only] An implementation of the IAutomationTabularData interface, which can be used to retrieve the data. | UIComponent
|  | automationValue : Array [read-only] This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application. | UIComponent
|  | automationVisible : Boolean [read-only] True if this component is visible for automation, false otherwise. | UIComponent
|  | baseline : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | baselinePosition : Number [override] [read-only] The y-coordinate of the baseline of the first line of text of the component. | Group
|  | baselinePositionElement : IVisualElement The element used to calculate the GroupBase's baselinePosition | Group
|  | blendMode : String [override] A value from the BlendMode class that specifies which blend mode to use. | Group
|  | bottom : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | cacheHeuristic : Boolean [write-only] Used by Flex to suggest bitmap caching for the object. | UIComponent
|  | cachePolicy : String Specifies the bitmap caching policy for this object. | UIComponent
|  | caretColumnIndex : int If showCaretIndicator is true, the column index of the caretIndicator. | Grid
|  | caretIndicator : IFactory If selectionMode is GridSelectionMode.SINGLE_ROW or GridSelectionMode.MULTIPLE_ROWS, a single visual element displayed for the caret row, If selectionMode is GridSelectionMode.SINGLE_CELL or GridSelectionMode.MULTIPLE_CELLS, the visual element displayed for the caret cell. | Grid
|  | caretRowIndex : int If showCaretIndicator is true, the row index of the caretIndicator. | Grid
|  | className : String [read-only] The name of this instance's class, such as "Button". | UIComponent
|  | clipAndEnableScrolling : Boolean If true, specifies to clip the children to the boundaries of the viewport. | GroupBase
|  | columns : IList The list of GridColumn objectss displayed by this grid. | Grid
|  | columnSeparator : IFactory A visual element displayed between each column. | Grid
|  | contentHeight : Number [read-only] The height of the viewport's content. | GroupBase
|  | contentMouseX : Number [read-only] Returns the x position of the mouse, in the content coordinate system. | UIComponent
|  | contentMouseY : Number [read-only] Returns the y position of the mouse, in the content coordinate system. | UIComponent
|  | contentWidth : Number [read-only] The width of the viewport's contents. | GroupBase
|  | currentState : String The current view state of the component. | UIComponent
|  | cursorManager : ICursorManager [read-only] Gets the CursorManager that controls the cursor for this component and its peers. | UIComponent
|  | dataGrid : DataGrid The DataGrid control for which this Grid is used as the grid skin part. | Grid
|  | dataProvider : IList A list of data items that correspond to the rows in the grid. | Grid
|  | dataTipField : String The name of the field in the data provider to display as the datatip. | Grid
|  | dataTipFunction : Function Specifies a callback function to run on each item of the data provider to determine its data tip. | Grid
|  | depth : Number Determines the order in which items inside of containers are rendered. | UIComponent
|  | descriptor : UIComponentDescriptor Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance. | UIComponent
|  | designLayer : DesignLayer Specifies the optional DesignLayer instance associated with this visual element. | UIComponent
|  | document : Object A reference to the document object associated with this UIComponent. | UIComponent
|  | doubleClickEnabled : Boolean [override] Specifies whether the UIComponent object receives doubleClick events. | UIComponent
|  | doubleClickMode : String The doubleClick mode of the control. | Grid
|  | enabled : Boolean Whether the component can accept user interaction. | UIComponent
|  | errorString : String The text that displayed by a component's error tip when a component is monitored by a Validator and validation fails. | UIComponent
|  | explicitHeight : Number Number that specifies the explicit height of the component, in pixels, in the component's coordinates. | UIComponent
|  | explicitMaxHeight : Number The maximum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | explicitMaxWidth : Number The maximum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | explicitMinHeight : Number The minimum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | explicitMinWidth : Number The minimum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | explicitWidth : Number Number that specifies the explicit width of the component, in pixels, in the component's coordinates. | UIComponent
|  | flexContextMenu : IFlexContextMenu The context menu for this UIComponent. | UIComponent
|  | focusEnabled : Boolean Indicates whether the component can receive focus when tabbed to. | UIComponent
|  | focusManager : IFocusManager Gets the FocusManager that controls focus for this component and its peers. | UIComponent
|  | focusPane : Sprite The focus pane associated with this object. | UIComponent
|  | gridView : IFactory Used to initialize this grid's gridViews: centerGridView, leftGridView, topGridView, topLeftGridView. | Grid
|  | hasFocusableChildren : Boolean A flag that indicates whether child objects can receive focus. | UIComponent
|  | hasLayoutMatrix3D : Boolean [read-only] Contains true if the element has 3D Matrix. | UIComponent
|  | height : Number [override] Number that specifies the height of the component, in pixels, in the parent's coordinates. | UIComponent
|  | horizontalCenter : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | horizontalScrollPosition : Number [override] The x coordinate of the origin of the viewport in the component's coordinate system, where the default value is (0,0) corresponding to the upper-left corner of the component. | Grid
|  | hoverColumnIndex : int If showHoverIndicator is true, Specifies column index of the hoverIndicator. | Grid
|  | hoverIndicator : IFactory If selectionMode is GridSelectionMode.SINGLE_ROW or GridSelectionMode.MULTIPLE_ROWS. | Grid
|  | hoverRowIndex : int If showHoverIndicator is true, specifies the column index of the hoverIndicator. | Grid
|  | id : String ID of the component. | UIComponent
|  | includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container. | UIComponent
|  | inheritingStyles : Object The beginning of this component's chain of inheriting styles. | UIComponent
|  | initialized : Boolean A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required). | UIComponent
|  | instanceIndex : int [read-only] The index of a repeated component. | UIComponent
|  | instanceIndices : Array An Array containing the indices required to reference this UIComponent object from its parent document. | UIComponent
|  | is3D : Boolean [read-only] Contains true when the element is in 3D. | UIComponent
|  | isDocument : Boolean [read-only] Contains true if this UIComponent instance is a document object. | UIComponent
|  | isFirstRow : Boolean [read-only] Returns if the selectedIndex is equal to the first row. | Grid
|  | isLastRow : Boolean [read-only] Returns if the selectedIndex is equal to the last row. | Grid
|  | isPopUp : Boolean Set to true by the PopUpManager to indicate that component has been popped up. | UIComponent
|  | itemRenderer : IFactory The item renderer that's used for columns that do not specify one. | Grid
|  | layout : LayoutBase The layout object for this container. | GroupBase
|  | layoutMatrix3D : Matrix3D [write-only] The transform matrix that is used to calculate a component's layout relative to its siblings. | UIComponent
|  | left : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | lockedColumnCount : int The first lockedColumnCount columns are "locked", i.e. | Grid
|  | lockedColumnsSeparator : IFactory A visual element displayed between the locked and unlocked columns. | Grid
|  | lockedRowCount : int The first lockedRowCount rows are "locked", i.e. | Grid
|  | lockedRowsSeparator : IFactory A visual element displayed between the locked and unlocked rows. | Grid
|  | luminosityClip : Boolean A property that controls whether the luminosity mask clips the masked content. | GroupBase
|  | luminosityInvert : Boolean A property that controls the calculation of the RGB color value of a graphic element being masked by a luminosity mask. | GroupBase
|  | maintainProjectionCenter : Boolean When true, the component keeps its projection matrix centered on the middle of its bounding box. | UIComponent
|  | mask : DisplayObject [override] Sets the mask. | GroupBase
|  | maskType : String The mask type. | GroupBase
|  | maxHeight : Number The maximum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | maxWidth : Number The maximum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | measuredHeight : Number The default height of the component, in pixels. | UIComponent
|  | measuredMinHeight : Number The default minimum height of the component, in pixels. | UIComponent
|  | measuredMinWidth : Number The default minimum width of the component, in pixels. | UIComponent
|  | measuredWidth : Number The default width of the component, in pixels. | UIComponent
|  | minHeight : Number The minimum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | minWidth : Number The minimum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | moduleFactory : IFlexModuleFactory A module factory is used as context for using embedded fonts and for finding the style manager that controls the styles for this component. | UIComponent
|  | mouseEnabledWhereTransparent : Boolean When true, this property ensures that the entire bounds of the Group respond to mouse events such as click and roll over. | GroupBase
|  | mouseFocusEnabled : Boolean Whether you can receive focus when clicked on. | UIComponent
|  | mxmlContent : Array [write-only] The visual content children for this Group. | Group
|  | MXMLDescriptor : Array [read-only] | UIComponent
|  | MXMLProperties : Array [read-only] | UIComponent
|  | nestLevel : int Depth of this object in the containment hierarchy. | UIComponent
|  | nonInheritingStyles : Object The beginning of this component's chain of non-inheriting styles. | UIComponent
|  | numAutomationChildren : int [read-only] The number of automation children this container has. | UIComponent
|  | numElements : int [read-only] The number of visual elements in this container. | GroupBase
|  | overlay : DisplayLayer [read-only] The overlay plane for this group. | GroupBase
|  | owner : DisplayObjectContainer The owner of this IVisualElement object. | UIComponent
|  | parent : DisplayObjectContainer [override] [read-only] The parent container or component for this component. | UIComponent
|  | parentApplication : Object [read-only] A reference to the Application object that contains this UIComponent instance. | UIComponent
|  | parentDocument : Object [read-only] A reference to the parent document object for this UIComponent. | UIComponent
|  | percentHeight : Number Specifies the height of a component as a percentage of its parent's size. | UIComponent
|  | percentWidth : Number Specifies the width of a component as a percentage of its parent's size. | UIComponent
|  | postLayoutTransformOffsets : TransformOffsets Defines a set of adjustments that can be applied to the object's transform in a way that is invisible to its parent's layout. | UIComponent
|  | preserveSelection : Boolean If true, the selection is preserved when the data provider refreshes its collection. | Grid
|  | processedDescriptors : Boolean Set to true after immediate or deferred child creation, depending on which one happens. | UIComponent
|  | repeater : IRepeater [read-only] A reference to the Repeater object in the parent document that produced this UIComponent. | UIComponent
|  | repeaterIndex : int [read-only] The index of the item in the data provider of the Repeater that produced this UIComponent. | UIComponent
|  | repeaterIndices : Array An Array containing the indices of the items in the data provider of the Repeaters in the parent document that produced this UIComponent. | UIComponent
|  | repeaters : Array An Array containing references to the Repeater objects in the parent document that produced this UIComponent. | UIComponent
|  | requestedColumnCount : int The measured width of this grid is large enough to display the first requestedColumnCount columns. | Grid
|  | requestedMaxRowCount : int The measured height of the grid is large enough to display no more than requestedMaxRowCount rows. | Grid
|  | requestedMinColumnCount : int The measured width of this grid is large enough to display at least requestedMinColumnCount columns. | Grid
|  | requestedMinRowCount : int The measured height of this grid is large enough to display at least requestedMinRowCount rows. | Grid
|  | requestedRowCount : int The measured height of this grid is large enough to display the first requestedRowCount rows. | Grid
|  | requireSelection : Boolean If true and the selectionMode property is not GridSelectionMode.NONE, an item must always be selected in the grid. | Grid
|  | resizableColumns : Boolean Indicates whether the user can change the size of the columns. | Grid
|  | resizeMode : String The ResizeMode for this container. | GroupBase
|  | right : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | rotation : Number [override] | UIComponent
|  | rotationX : Number [override] Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent
|  | rotationY : Number [override] Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent
|  | rotationZ : Number [override] | UIComponent
|  | rowBackground : IFactory A visual element that's displays the background for each row. | Grid
|  | rowHeight : Number If variableRowHeight is false, then this property specifies the actual height of each row, in pixels. | Grid
|  | rowSeparator : IFactory A visual element that's displayed in between each row. | Grid
|  | scaleGridBottom : Number Specifies the bottom coordinate of the scale grid. | Group
|  | scaleGridLeft : Number Specifies the left coordinate of the scale grid. | Group
|  | scaleGridRight : Number Specifies the right coordinate of the scale grid. | Group
|  | scaleGridTop : Number Specifies the top coordinate of the scale grid. | Group
|  | scaleX : Number [override] Number that specifies the horizontal scaling factor. | UIComponent
|  | scaleY : Number [override] Number that specifies the vertical scaling factor. | UIComponent
|  | scaleZ : Number [override] Number that specifies the scaling factor along the z axis. | UIComponent
|  | screen : Rectangle [read-only] Returns an object that contains the size and position of the base drawing surface for this object. | UIComponent
|  | selectedCell : CellPosition If selectionMode is GridSelectionMode.SINGLE_CELL or GridSelectionMode.MULTIPLE_CELLS, returns the first selected cell starting at row 0 column 0 and progressing through each column in a row before moving to the next row. | Grid
|  | selectedCells : Vector.<CellPosition> If selectionMode is GridSelectionMode.SINGLE_CELL or GridSelectionMode.MULTIPLE_CELLS, returns a Vector of CellPosition objects representing the positions of the selected cells in the grid. | Grid
|  | selectedIndex : int If selectionMode is GridSelectionMode.SINGLE_ROW or GridSelectionMode.MULTIPLE_ROWS, returns the rowIndex of the first selected row. | Grid
|  | selectedIndices : Vector.<int> If selectionMode is GridSelectionMode.SINGLE_ROW or GridSelectionMode.MULTIPLE_ROWS, returns a Vector of the selected rows indices. | Grid
|  | selectedItem : Object If selectionMode is GridSelectionMode.SINGLE_ROW or GridSelectionMode.MULTIPLE_ROWS, returns the item in the the data provider that is currently selected or undefined if no rows are selected. | Grid
|  | selectedItems : Vector.<Object> If selectionMode is GridSelectionMode.SINGLE_ROW or GridSelectionMode.MULTIPLE_ROWS, returns a Vector of the dataProvider items that are currently selected. | Grid
|  | selectionIndicator : IFactory If selectionMode is GridSelectionMode.SINGLE_ROW or GridSelectionMode.MULTIPLE_ROWS, a visual element that's displayed for each selected row, If selectionMode is GridSelectionMode.SINGLE_CELL or GridSelectionMode.MULTIPLE_CELLS, a visual element displayed for each selected cell. | Grid
|  | selectionLength : int [read-only] If selectionMode is GridSelectionMode.SINGLE_ROW or GridSelectionMode.MULTIPLE_ROWS, returns the number of selected rows. | Grid
|  | selectionMode : String The selection mode of the control. | Grid
|  | showCaret : Boolean Determines if the caret is visible. | Grid
|  | showDataTips : Boolean If true then a dataTip is displayed for all visible cells. | Grid
|  | showInAutomationHierarchy : Boolean A flag that determines if an automation object shows in the automation hierarchy. | UIComponent
|  | states : Array The view states that are defined for this component. | UIComponent
|  | styleDeclaration : CSSStyleDeclaration Storage for the inline inheriting styles on this object. | UIComponent
|  | styleManager : IStyleManager2 [read-only] Returns the StyleManager instance used by this component. | UIComponent
|  | styleName : Object The class style used by this component. | UIComponent
|  | styleParent : IAdvancedStyleClient A component's parent is used to evaluate descendant selectors. | UIComponent
|  | systemManager : ISystemManager Returns the SystemManager object used by this component. | UIComponent
|  | tabFocusEnabled : Boolean A flag that indicates whether this object can receive focus via the TAB key This is similar to the tabEnabled property used by the Flash Player. This is usually true for components that handle keyboard input, but some components in controlbars have them set to false because they should not steal focus from another component like an editor. | UIComponent
|  | toolTip : String Text to display in the ToolTip. | UIComponent
|  | top : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | transform : Transform [override] An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | UIComponent
|  | transformX : Number Sets the x coordinate for the transform center of the component. | UIComponent
|  | transformY : Number Sets the y coordinate for the transform center of the component. | UIComponent
|  | transformZ : Number Sets the z coordinate for the transform center of the component. | UIComponent
|  | transitions : Array An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs. | UIComponent
|  | tweeningProperties : Array Array of properties that are currently being tweened on this object. | UIComponent
|  | typicalItem : Object The grid's layout ensures that columns whose width is not specified are wide enough to display an item renderer for this default data provider item. | Grid
|  | uid : String A unique identifier for the object. | UIComponent
|  | updateCompletePendingFlag : Boolean A flag that determines if an object has been through all three phases of layout validation (provided that any were required). | UIComponent
|  | validationSubField : String Used by a validator to associate a subfield with this component. | UIComponent
|  | variableRowHeight : Boolean If true, each row's height is the maximum of preferred heights of the cells displayed so far. | Grid
|  | verticalCenter : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | verticalScrollPosition : Number [override] The y coordinate of the origin of the viewport in the component's coordinate system, where the default value is (0,0) corresponding to the upper-left corner of the component. | Grid
|  | visible : Boolean [override] Whether or not the display object is visible. | UIComponent
|  | width : Number [override] Number that specifies the width of the component, in pixels, in the parent's coordinates. | UIComponent
|  | x : Number [override] Number that specifies the component's horizontal position, in pixels, within its parent container. | UIComponent
|  | y : Number [override] Number that specifies the component's vertical position, in pixels, within its parent container. | UIComponent
|  | z : Number [override] | UIComponent

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | currentCSSState : String [read-only] The state to be used when matching CSS pseudo-selectors. | UIComponent
|  | hasComplexLayoutMatrix : Boolean [read-only] Returns true if the UIComponent has any non-translation (x,y) transform properties. | UIComponent
|  | resourceManager : IResourceManager [read-only] A reference to the object which manages all of the application's localized resources. | UIComponent
|  | unscaledHeight : Number [read-only] A convenience method for determining the unscaled height of the component. | UIComponent
|  | unscaledWidth : Number [read-only] A convenience method for determining the unscaled width of the component All of a component's drawing and child layout should be done within a bounding rectangle of this width, which is also passed as an argument to updateDisplayList(). | UIComponent

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | Grid() Constructor. | Grid
|  | addElement(element:IVisualElement):IVisualElement Adds a visual element to this container. | Group
|  | addElementAt(element:IVisualElement, index:int):IVisualElement Adds a visual element to this container. | Group
|  | addSelectedCell(rowIndex:int, columnIndex:int):Boolean If selectionMode is GridSelectionMode.SINGLE_CELL or GridSelectionMode.MULTIPLE_CELLS, adds the cell to the selection and sets the caret position to the cell. | Grid
|  | addSelectedIndex(rowIndex:int):Boolean If selectionMode is GridSelectionMode.MULTIPLE_ROWS, adds this row to the selection and sets the caret position to this row. | Grid
|  | addStyleClient(styleClient:IAdvancedStyleClient):void Adds a non-visual style client to this component instance. | UIComponent
|  | callLater(method:Function, args:Array = null):void Queues a function to be called later. | UIComponent
|  | clearSelection():Boolean Removes all of the selected rows and cells, if selectionMode is not GridSelectionMode.NONE. | Grid
|  | clearStyle(styleProp:String):void Deletes a style property from this component instance. | UIComponent
|  | containsElement(element:IVisualElement):Boolean Determines whether the specified IVisualElement is a child of the container instance or the instance itself. | GroupBase
|  | contentToGlobal(point:Point):Point Converts a Point object from content coordinates to global coordinates. | UIComponent
|  | contentToLocal(point:Point):Point Converts a Point object from content to local coordinates. | UIComponent
|  | createAutomationIDPart(child:IAutomationObject):Object Returns a set of properties that identify the child within this container. | UIComponent
|  | createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object Returns a set of properties as automation IDs that identify the child within this container. | UIComponent
|  | createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Creates an id reference to this IUIComponent object on its parent document object. | UIComponent
|  | deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Deletes the id reference to this IUIComponent object on its parent document object. | UIComponent
|  | determineTextFormatFromStyles():UITextFormat Returns a UITextFormat object corresponding to the text styles for this UIComponent. | UIComponent
|  | dispatchEvent(event:Event):Boolean [override] Dispatches an event into the event flow. | UIComponent
|  | drawFocus(isFocused:Boolean):void Shows or hides the focus indicator around this component. | UIComponent
|  | drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void Programmatically draws a rectangle into this skin's Graphics object. | UIComponent
|  | effectFinished(effectInst:IEffectInstance):void Called by the effect instance when it stops playing on the component. | UIComponent
|  | effectStarted(effectInst:IEffectInstance):void Called by the effect instance when it starts playing on the component. | UIComponent
|  | endEffectsStarted():void Ends all currently playing effects on the component. | UIComponent
|  | ensureCellIsVisible(rowIndex:int = -1, columnIndex:int = -1):void If necessary, set the verticalScrollPosition and horizontalScrollPosition properties so that the specified cell is completely visible. | Grid
|  | executeBindings(recurse:Boolean = false):void Executes all the bindings for which the UIComponent object is the destination. | UIComponent
|  | findRowIndex(field:String, value:String, startingIndex:int = 0, patternType:String):int This will search through a dataprovider checking the given field and for the given value and return the index for the match. | Grid
|  | findRowIndices(field:String, values:Array, patternType:String):Array This will search through a dataprovider checking the given field and for the given values and return an array of indices that matched. | Grid
|  | finishPrint(obj:Object, target:IFlexDisplayObject):void Called after printing is complete. | UIComponent
|  | generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array | UIComponent
|  | generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):* | UIComponent
|  | getAutomationChildAt(index:int):IAutomationObject Provides the automation object at the specified index. | UIComponent
|  | getAutomationChildren():Array Provides the automation object list . | UIComponent
|  | getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the x coordinate of the element's bounds at the specified element size. | UIComponent
|  | getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the y coordinate of the element's bounds at the specified element size. | UIComponent
|  | getCellAt(x:Number, y:Number):CellPosition Return the row and column indices of the cell that overlaps the pixel at the specified grid coordinate. | Grid
|  | getCellBounds(rowIndex:int, columnIndex:int):Rectangle Returns the current pixel bounds of the specified cell, or null if no such cell exists. | Grid
|  | getCellsAt(x:Number, y:Number, w:Number, h:Number):Vector.<CellPosition> Returns a vector of CellPosition objects whose rowIndex and columnIndex properties specify the row and column indices of the cells that overlap the specified grid region. | Grid
|  | getCellX(rowIndex:int, columnIndex:int):Number Return the X coordinate of the specified cell's origin. | Grid
|  | getCellY(rowIndex:int, columnIndex:int):Number Return the Y coordinate of the specified cell's origin. | Grid
|  | getClassStyleDeclarations():Array Finds the type selectors for this UIComponent instance. | UIComponent
|  | getColumnBounds(columnIndex:int):Rectangle Returns the current pixel bounds of the specified column, or null if no such column exists. | Grid
|  | getColumnIndexAt(x:Number, y:Number):int Returns the column index corresponding to the specified grid coordinates, or -1 if the coordinates are out of bounds. | Grid
|  | getColumnWidth(columnIndex:int):Number Return the width of the specified column. | Grid
|  | getConstraintValue(constraintName:String):* Returns a layout constraint value, which is the same as getting the constraint style for this component. | UIComponent
|  | getElementAt(index:int):IVisualElement Returns the visual element at the specified index. | GroupBase
|  | getElementIndex(element:IVisualElement):int Returns the index position of a visual element. | GroupBase
|  | getExplicitOrMeasuredHeight():Number A convenience method for determining whether to use the explicit or measured height | UIComponent
|  | getExplicitOrMeasuredWidth():Number A convenience method for determining whether to use the explicit or measured width | UIComponent
|  | getFocus():InteractiveObject Gets the object that currently has focus. | UIComponent
|  | getHorizontalScrollPositionDelta(navigationUnit:uint):Number Returns the change to the horizontal scroll position to handle different scrolling options. | GroupBase
|  | getItemRendererAt(rowIndex:int, columnIndex:int):IGridItemRenderer If the requested item renderer is visible, returns a reference to the item renderer currently displayed at the specified cell. | Grid
|  | getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's layout height. | UIComponent
|  | getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's layout width. | UIComponent
|  | getLayoutBoundsX(postLayoutTransform:Boolean = true):Number Returns the x coordinate that the element uses to draw on screen. | UIComponent
|  | getLayoutBoundsY(postLayoutTransform:Boolean = true):Number Returns the y coordinate that the element uses to draw on screen. | UIComponent
|  | getLayoutMatrix():Matrix Returns the transform matrix that is used to calculate the component's layout relative to its siblings. | UIComponent
|  | getLayoutMatrix3D():Matrix3D Returns the layout transform Matrix3D for this element. | UIComponent
|  | getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's maximum height. | UIComponent
|  | getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's maximum width. | UIComponent
|  | getMinBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's minimum height. | UIComponent
|  | getMinBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's minimum width. | UIComponent
|  | getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's preferred height. | UIComponent
|  | getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's preferred width. | UIComponent
|  | 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
|  | getRowBounds(rowIndex:int):Rectangle Returns the current pixel bounds of the specified row, or null if no such row exists. | Grid
|  | getRowIndexAt(x:Number, y:Number):int Returns the row index corresponding to the specified grid coordinates, or -1 if the coordinates are out of bounds. | Grid
|  | getStyle(styleProp:String):* Gets a style property that has been set anywhere in this component's style lookup chain. | UIComponent
|  | getVerticalScrollPositionDelta(navigationUnit:uint):Number Returns the change to the vertical scroll position to handle different scrolling options. | GroupBase
|  | getVirtualElementAt(index:int, eltWidth:Number, eltHeight:Number):IVisualElement Layouts that honor the useVirtualLayout flag will use this method at updateDisplayList() time to get layout elements that are "in view", i.e. | GroupBase
|  | getVisibleColumnIndices():Vector.<int> Return the indices of the currently visible columns. | Grid
|  | getVisibleRect(targetParent:DisplayObject = null):Rectangle Get the bounds of this object that are visible to the user on the screen. | UIComponent
|  | getVisibleRowIndices():Vector.<int> Return the data provider indices and padding indices of the currently visible rows. | Grid
|  | globalToContent(point:Point):Point Converts a Point object from global to content coordinates. | UIComponent
|  | hasCSSState():Boolean Returns true if currentCSSState is not null. | UIComponent
|  | hasState(stateName:String):Boolean Determines whether the specified state has been defined on this UIComponent. | UIComponent
|  | 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
|  | initialize():void Initializes the internal structure of this component. | UIComponent
|  | initializeRepeaterArrays(parent:IRepeaterClient):void Initializes various properties which keep track of repeated instances of this component. | UIComponent
|  | invalidateCell(rowIndex:int, columnIndex:int):void If the specified cell is visible, it is redisplayed. | Grid
|  | invalidateDisplayList():void Marks a component so that its updateDisplayList() method gets called during a later screen update. | UIComponent
|  | invalidateGraphicElementDisplayList(element:IGraphicElement):void Notify the host component that an element has changed and needs to be redrawn. | Group
|  | invalidateGraphicElementProperties(element:IGraphicElement):void Notify the host component that an element changed and needs to validate properties. | Group
|  | invalidateGraphicElementSharing(element:IGraphicElement):void Notify the host that an element layer has changed. | Group
|  | invalidateGraphicElementSize(element:IGraphicElement):void Notify the host component that an element size has changed. | Group
|  | invalidateLayering():void Called by a component's items to indicate that their depth property has changed. | UIComponent
|  | invalidateLayoutDirection():void An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes. | UIComponent
|  | invalidateProperties():void Marks a component so that its commitProperties() method gets called during a later screen update. | UIComponent
|  | invalidateSize():void Marks a component so that its measure() method gets called during a later screen update. | UIComponent
|  | invalidateTypicalItemRenderer():void Clears cached column width data that had been based on the typicalItem property, and requests a new layout pass. | Grid
|  | isCellVisible(rowIndex:int = -1, columnIndex:int = -1):Boolean Returns true if the specified cell is at least partially visible. | Grid
|  | localToContent(point:Point):Point Converts a Point object from local to content coordinates. | UIComponent
|  | matchesCSSState(cssState:String):Boolean Returns true if cssState matches currentCSSState. | UIComponent
|  | matchesCSSType(cssType:String):Boolean Determines whether this instance is the same as, or is a subclass of, the given type. | UIComponent
|  | measureHTMLText(htmlText:String):TextLineMetrics Measures the specified HTML text, which can contain HTML tags such as <font> and <b>, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent. | UIComponent
|  | measureText(text:String):TextLineMetrics Measures the specified text, assuming that it is displayed in a single-line UITextField (or UIFTETextField) using a UITextFormat determined by the styles of this UIComponent. | UIComponent
|  | move(x:Number, y:Number):void Moves the component to a specified position within its parent. | UIComponent
|  | moveIndexFindRow(field:String, value:String, startingIndex:int = 0, patternType:String):Boolean This will search through a dataprovider checking the given field and will set the selectedIndex to a matching value. | Grid
|  | moveIndexFirstRow():void Changes the selectedIndex to the first row of the dataProvider. | Grid
|  | moveIndexLastRow():void Changes the selectedIndex to the last row of the dataProvider. | Grid
|  | moveIndexNextRow():void Changes the selectedIndex to the next row of the dataProvider. | Grid
|  | moveIndexPreviousRow():void Changes the selectedIndex to the previous row of the dataProvider. | Grid
|  | notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void Propagates style changes to the children. | UIComponent
|  | owns(child:DisplayObject):Boolean Returns true if the chain of owner properties points from child to this UIComponent. | UIComponent
|  | parentChanged(p:DisplayObjectContainer):void Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent
|  | prepareToPrint(target:IFlexDisplayObject):Object Prepares an IFlexDisplayObject for printing. | UIComponent
|  | regenerateStyleCache(recursive:Boolean):void Builds or rebuilds the CSS style cache for this component and, if the recursive parameter is true, for all descendants of this component as well. | UIComponent
|  | registerEffects(effects:Array):void For each effect event, registers the EffectManager as one of the event listeners. | UIComponent
|  | removeAllElements():void Removes all visual elements from the container. | Group
|  | removeElement(element:IVisualElement):IVisualElement Removes the specified visual element from the child list of this container. | Group
|  | removeElementAt(index:int):IVisualElement Removes a visual element from the specified index position in the container. | Group
|  | removeSelectedCell(rowIndex:int, columnIndex:int):Boolean If selectionMode is GridSelectionMode.SINGLE_CELL or GridSelectionMode.MULTIPLE_CELLS, removes the cell from the selection and sets the caret position to the cell. | Grid
|  | removeSelectedIndex(rowIndex:int):Boolean If selectionMode is GridSelectionMode.SINGLE_ROW or GridSelectionMode.MULTIPLE_ROWS, removes this row from the selection and sets the caret position to this row. | Grid
|  | removeStyleClient(styleClient:IAdvancedStyleClient):void Removes a non-visual style client from this component instance. | UIComponent
|  | replayAutomatableEvent(event:Event):Boolean Replays the specified event. | UIComponent
|  | resolveAutomationIDPart(criteria:Object):Array Resolves a child by using the id provided. | UIComponent
|  | resumeBackgroundProcessing():void [static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing(). | UIComponent
|  | selectAll():Boolean If selectionMode is GridSelectionMode.MULTIPLE_ROWS, selects all rows and removes the caret or if selectionMode is GridSelectionMode.MULTIPLE_CELLS selects all cells and removes the caret. | Grid
|  | selectCellRegion(rowIndex:int, columnIndex:int, rowCount:uint, columnCount:uint):Boolean If selectionMode is GridSelectionMode.MULTIPLE_CELLS, sets the selection to all the cells in the cell region and the caret position to the last cell in the cell region. | Grid
|  | selectIndices(rowIndex:int, rowCount:int):Boolean If selectionMode is GridSelectionMode.MULTIPLE_ROWS, sets the selection to the specfied rows and the caret position to endRowIndex. | Grid
|  | selectionContainsCell(rowIndex:int, columnIndex:int):Boolean If selectionMode is GridSelectionMode.SINGLE_CELL or GridSelectionMode.MULTIPLE_CELLS, returns true if the cell is in the current selection. | Grid
|  | selectionContainsCellRegion(rowIndex:int, columnIndex:int, rowCount:int, columnCount:int):Boolean If selectionMode is GridSelectionMode.MULTIPLE_CELLS, returns true if the cells in the cell region are in the current selection. | Grid
|  | selectionContainsIndex(rowIndex:int):Boolean If selectionMode is GridSelectionMode.SINGLE_ROW or GridSelectionMode.MULTIPLE_ROWS, returns true if the row at index is in the current selection. | Grid
|  | selectionContainsIndices(rowIndices:Vector.<int>):Boolean If selectionMode is GridSelectionMode.MULTIPLE_ROWS, returns true if the rows in indices are in the current selection. | Grid
|  | setActualSize(w:Number, h:Number):void Sizes the object. | UIComponent
|  | setConstraintValue(constraintName:String, value:*):void Sets a layout constraint value, which is the same as setting the constraint style for this component. | UIComponent
|  | setContentSize(width:Number, height:Number):void Sets the contentWidth and contentHeight properties. | GroupBase
|  | setCurrentState(stateName:String, playTransition:Boolean = true):void Set the current state. | UIComponent
|  | setElementIndex(element:IVisualElement, index:int):void Changes the position of an existing visual element in the visual container. | Group
|  | setFocus():void Sets the focus to this component. | UIComponent
|  | setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void Sets the coordinates that the element uses to draw on screen. | UIComponent
|  | setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void Sets the layout size of the element. | UIComponent
|  | setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings. | UIComponent
|  | setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings. | UIComponent
|  | setMXMLDescriptor(value:Array):void | UIComponent
|  | setMXMLProperties(value:Array):void | UIComponent
|  | setSelectedCell(rowIndex:int, columnIndex:int):Boolean If selectionMode is GridSelectionMode.SINGLE_CELL or GridSelectionMode.MULTIPLE_CELLS, sets the selection and the caret position to this cell. | Grid
|  | setSelectedIndex(rowIndex:int):Boolean If selectionMode is GridSelectionMode.SINGLE_ROW or GridSelectionMode.MULTIPLE_ROWS, sets the selection and the caret position to this row. | Grid
|  | setStyle(styleProp:String, newValue:*):void Sets a style property on this component instance. | UIComponent
|  | setVisible(value:Boolean, noEvent:Boolean = false):void Called when the visible property changes. | UIComponent
|  | styleChanged(styleProp:String):void Detects changes to style properties. | UIComponent
|  | stylesInitialized():void Flex calls the stylesInitialized() method when the styles for a component are first initialized. | UIComponent
|  | suspendBackgroundProcessing():void [static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called. | UIComponent
|  | swapElements(element1:IVisualElement, element2:IVisualElement):void Swaps the index of the two specified visual elements. | Group
|  | swapElementsAt(index1:int, index2:int):void Swaps the visual elements at the two specified index positions in the container. | Group
|  | toString():String [override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application. | FlexSprite
|  | transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void A utility method to update the rotation, scale, and translation of the transform while keeping a particular point, specified in the component's own coordinate space, fixed in the parent's coordinate space. | UIComponent
|  | transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void A utility method to transform a point specified in the local coordinates of this object to its location in the object's parent's coordinates. | UIComponent
|  | validateDisplayList():void Validates the position and size of children and draws other visuals. | UIComponent
|  | validateNow():void Validate and update the properties and layout of this object and redraw it, if necessary. | UIComponent
|  | validateProperties():void Used by layout logic to validate the properties of a component by calling the commitProperties() method. | UIComponent
|  | validateSize(recursive:Boolean = false):void Validates the measured size of the component If the LayoutManager.invalidateSize() method is called with this ILayoutManagerClient, then the validateSize() method is called when it's time to do measurements. | UIComponent
|  | validationResultHandler(event:ValidationResultEvent):void Handles both the valid and invalid events from a validator assigned to this component. | UIComponent
|  | verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient. | UIComponent

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | addMXMLChildren(comps:Array):void [override] override setting of children | Group
|  | adjustFocusRect(obj:DisplayObject = null):void Adjust the focus rectangle. | UIComponent
|  | applyComputedMatrix():void Commits the computed matrix built from the combination of the layout matrix and the transform offsets to the flash displayObject's transform. | UIComponent
|  | attachOverlay():void This is an internal method used by the Flex framework to support the Dissolve effect. | UIComponent
|  | canSkipMeasurement():Boolean Determines if the call to the measure() method can be skipped. | UIComponent
|  | childrenCreated():void Performs any final processing after child objects are created. | UIComponent
|  | commitProperties():void Processes the properties set on the component. | UIComponent
|  | createChildren():void [override] If the layout object has not been set yet, createChildren() assigns this container a default layout object, BasicLayout. | GroupBase
|  | createInFontContext(classObj:Class):Object Creates a new object using a context based on the embedded font being used. | UIComponent
|  | createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object Creates the object using a given moduleFactory. | UIComponent
|  | dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void Helper method for dispatching a PropertyChangeEvent when a property is updated. | UIComponent
|  | focusInHandler(event:FocusEvent):void The event handler called when a UIComponent object gets focus. | UIComponent
|  | focusOutHandler(event:FocusEvent):void The event handler called when a UIComponent object loses focus. | UIComponent
|  | generateMXMLAttributes(data:Array):void | UIComponent
|  | generateMXMLInstances(document:Object, data:Array, recursive:Boolean = true):void | UIComponent
|  | generateMXMLObject(document:Object, data:Array):Object | UIComponent
|  | initAdvancedLayoutFeatures():void Initializes the implementation and storage of some of the less frequently used advanced layout features of a component. | UIComponent
|  | initializationComplete():void Finalizes the initialization of this component. | UIComponent
|  | initializeAccessibility():void Initializes this component's accessibility code. | UIComponent
|  | invalidateParentSizeAndDisplayList():void Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true). | UIComponent
|  | isOurFocus(target:DisplayObject):Boolean Typically overridden by components containing UITextField objects, where the UITextField object gets focus. | UIComponent
|  | keyDownHandler(event:KeyboardEvent):void The event handler called for a keyDown event. | UIComponent
|  | keyUpHandler(event:KeyboardEvent):void The event handler called for a keyUp event. | UIComponent
|  | measure():void Calculates the default size, and optionally the default minimum size, of the component. | UIComponent
|  | resourcesChanged():void This method is called when a UIComponent is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way. | UIComponent
|  | setStretchXY(stretchX:Number, stretchY:Number):void Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent
|  | 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
|  | updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void Draws the object and/or sizes and positions its children. | UIComponent

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | add | Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. | UIComponent
|  | caretChange | Dispatched after the caret changes. | Grid
|  | creationComplete | Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent
|  | currentStateChange | Dispatched after the view state has changed. | UIComponent
|  | currentStateChanging | Dispatched after the currentState property changes, but before the view state changes. | UIComponent
|  | dragComplete | Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent
|  | dragDrop | Dispatched by the drop target when the user releases the mouse over it. | UIComponent
|  | dragEnter | Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent
|  | dragExit | Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent
|  | dragOver | Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent
|  | dragStart | Dispatched by the drag initiator when starting a drag operation. | UIComponent
|  | effectEnd | Dispatched after an effect ends. | UIComponent
|  | effectStart | Dispatched just before an effect starts. | UIComponent
|  | effectStop | Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent
|  | elementAdd | Dispatched when a visual element is added to the content holder. | Group
|  | elementRemove | Dispatched when a visual element is removed from the content holder. | Group
|  | enterState | Dispatched after the component has entered a view state. | UIComponent
|  | exitState | Dispatched just before the component exits a view state. | UIComponent
|  | gridClick | Dispatched when the mouse is clicked over a cell | Grid
|  | gridDoubleClick | Dispatched when the mouse is double-clicked over a cell | Grid
|  | gridMouseDown | Dispatched when the mouse button is pressed over a Grid cell. | Grid
|  | gridMouseDrag | Dispatched after a gridMouseDown event if the mouse moves before the button is released. | Grid
|  | gridMouseUp | Dispatched when the mouse button is released over a Grid cell. | Grid
|  | gridRollOut | Dispatched when the mouse leaves a grid cell. | Grid
|  | gridRollOver | Dispatched when the mouse enters a grid cell. | Grid
|  | hide | Dispatched when an object's state changes from visible to invisible. | UIComponent
|  | initialize | Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent
|  | invalid | Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent
|  | mouseDownOutside | Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent
|  | mouseWheelOutside | Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent
|  | move | Dispatched when the object has moved. | UIComponent
|  | preinitialize | Dispatched at the beginning of the component initialization sequence. | UIComponent
|  | remove | Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent
|  | resize | Dispatched when the component is resized. | UIComponent
|  | show | Dispatched when an object's state changes from invisible to visible. | UIComponent
|  | stateChangeComplete | Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. | UIComponent
|  | stateChangeInterrupted | Dispatched when a component interrupts a transition to its current state in order to switch to a new state. | UIComponent
|  | toolTipCreate | Dispatched by the component when it is time to create a ToolTip. | UIComponent
|  | toolTipEnd | Dispatched by the component when its ToolTip has been hidden and is to be discarded soon. | UIComponent
|  | toolTipHide | Dispatched by the component when its ToolTip is about to be hidden. | UIComponent
|  | toolTipShow | Dispatched by the component when its ToolTip is about to be shown. | UIComponent
|  | toolTipShown | Dispatched by the component when its ToolTip has been shown. | UIComponent
|  | toolTipStart | Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent
|  | touchInteractionEnd | A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture. | UIComponent
|  | touchInteractionStart | A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture. | UIComponent
|  | touchInteractionStarting | A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture. | UIComponent
|  | updateComplete | Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent
|  | valid | Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent
|  | valueCommit | Dispatched when values are changed programmatically or by user interaction. | UIComponent

Styles
Hide Inherited Styles
Show Inherited Styles

| Style | Description | Defined By
--- | --- | --- | ---
|  | accentColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile Accent color used by component skins. | GroupBase
|  | alignmentBaseline | Type: String CSS Inheritance: yes Specifies the baseline to which the dominant baseline aligns. See also flashx.textLayout.formats.ITextLayoutFormat.alignmentBaseline | GroupBase
|  | alternatingItemColors | Type: Array Format: Color CSS Inheritance: yes Theme: spark, mobile The colors to use for the backgrounds of the items in the list. | GroupBase
|  | baseline | Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent
|  | baselineShift | Type: Object CSS Inheritance: yes Amount to shift the baseline. See also flashx.textLayout.formats.ITextLayoutFormat.baselineShift | GroupBase
|  | blockProgression | Type: String CSS Inheritance: yes Specifies a vertical or horizontal progression of line placement. See also flashx.textLayout.formats.ITextLayoutFormat.blockProgression | GroupBase
|  | bottom | Type: String CSS Inheritance: no The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent
|  | breakOpportunity | Type: String CSS Inheritance: yes Controls where lines are allowed to break when breaking wrapping text into multiple lines. See also flashx.textLayout.formats.ITextLayoutFormat.breakOpportunity | GroupBase
|  | cffHinting | Type: String CSS Inheritance: yes The type of CFF hinting used for this text. See also flashx.textLayout.formats.ITextLayoutFormat.cffHinting | GroupBase
|  | chromeColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile The main color for a component. | GroupBase
|  | clearFloats | Type: String CSS Inheritance: yes Controls how text wraps around a float. See also flashx.textLayout.formats.ITextLayoutFormat.clearFloats | GroupBase
|  | color | Type: uint Format: Color CSS Inheritance: yes Color of the text. See also flashx.textLayout.formats.ITextLayoutFormat.color spark.components.supportClasses.StyleableTextField.color spark.components.supportClasses.StyleableStageText.color | GroupBase
|  | columnBreakAfter | Type: String CSS Inheritance: yes Controls column break after the element. See also flashx.textLayout.formats.ITextLayoutFormat.columnBreakAfter | GroupBase
|  | columnBreakBefore | Type: String CSS Inheritance: yes Controls column break before the element. See also flashx.textLayout.formats.ITextLayoutFormat.columnBreakBefore | GroupBase
|  | containerBreakAfter | Type: String CSS Inheritance: yes Controls container break after the element. See also flashx.textLayout.formats.ITextLayoutFormat.containerBreakAfter | GroupBase
|  | containerBreakBefore | Type: String CSS Inheritance: yes Controls container break before the element. See also flashx.textLayout.formats.ITextLayoutFormat.containerBreakBefore | GroupBase
|  | contentBackgroundAlpha | Type: Number CSS Inheritance: yes Theme: spark, mobile The alpha of the content background for this component. | GroupBase
|  | contentBackgroundColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile The color of the content background for this component. | GroupBase
|  | digitCase | Type: String CSS Inheritance: yes The type of digit case used for this text. See also flashx.textLayout.formats.ITextLayoutFormat.digitCase | GroupBase
|  | digitWidth | Type: String CSS Inheritance: yes Type of digit width used for this text. See also flashx.textLayout.formats.ITextLayoutFormat.digitWidth | GroupBase
|  | direction | Type: String CSS Inheritance: yes Specifies the default bidirectional embedding level of the text. See also flashx.textLayout.formats.ITextLayoutFormat.direction | GroupBase
|  | disabledAlpha | Type: Number CSS Inheritance: no Theme: spark, mobile The alpha value when the container is disabled. | GroupBase
|  | dominantBaseline | Type: String CSS Inheritance: yes Specifies which element baseline snaps to the `alignmentBaseline` to determine the vertical position of the element on the line. See also flashx.textLayout.formats.ITextLayoutFormat.dominantBaseline | GroupBase
|  | downColor | Type: uint Format: Color CSS Inheritance: yes Theme: mobile Color of the background of an item renderer when it is being pressed down If `downColor` is set to `undefined`, `downColor` is not used. The default value for the Spark theme is `undefined`. | GroupBase
|  | errorColor | Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent
|  | firstBaselineOffset | Type: Object CSS Inheritance: yes Specifies the baseline position of the first line in the container. See also flashx.textLayout.formats.ITextLayoutFormat.firstBaselineOffset | GroupBase
|  | focusColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile Color of focus ring when the component is in focus. | GroupBase
|  | focusedTextSelectionColor | Type: uint Format: Color CSS Inheritance: yes The color of text when the component is enabled and has focus. | GroupBase
|  | focusSkin | Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent
|  | fontFamily | Type: String CSS Inheritance: yes The name of the font to use, or a comma-separated list of font names. See also flashx.textLayout.formats.ITextLayoutFormat.fontFamily spark.components.supportClasses.StyleableStageText.fontFamily spark.components.supportClasses.StyleableTextField.fontFamily | GroupBase
|  | fontLookup | Type: String CSS Inheritance: yes Font lookup to use. See also flashx.textLayout.formats.ITextLayoutFormat.fontLookup | GroupBase
|  | fontSize | Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. See also flashx.textLayout.formats.ITextLayoutFormat.fontSize spark.components.supportClasses.StyleableStageText.fontSize spark.components.supportClasses.StyleableTextField.fontSize | GroupBase
|  | fontStyle | Type: String CSS Inheritance: yes Determines whether the text is italic font. See also flashx.textLayout.formats.ITextLayoutFormat.fontStyle spark.components.supportClasses.StyleableStageText.fontStyle spark.components.supportClasses.StyleableTextField.fontStyle | GroupBase
|  | fontWeight | Type: String CSS Inheritance: yes Determines whether the text is boldface. See also flashx.textLayout.formats.ITextLayoutFormat.fontWeight spark.components.supportClasses.StyleableStageText.fontWeight spark.components.supportClasses.StyleableTextField.fontWeight | GroupBase
|  | horizontalCenter | Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent
|  | inactiveTextSelectionColor | Type: uint Format: Color CSS Inheritance: yes The color of text when the component is disabled. | GroupBase
|  | interactionMode | Type: String CSS Inheritance: yes The primary interaction mode for this component. See also mx.core.InteractionMode.MOUSE mx.core.InteractionMode.TOUCH | UIComponent
|  | justificationRule | Type: String CSS Inheritance: yes Rule used to justify text in a paragraph. See also flashx.textLayout.formats.ITextLayoutFormat.justificationRule | GroupBase
|  | justificationStyle | Type: String CSS Inheritance: yes The style used for justification of the paragraph. See also flashx.textLayout.formats.ITextLayoutFormat.justificationStyle | GroupBase
|  | kerning | Type: String CSS Inheritance: yes The style used for justification of the paragraph. See also flashx.textLayout.formats.ITextLayoutFormat.kerning | GroupBase
|  | layoutDirection | Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. See also MXFTEText.css mx.core.ILayoutDirectionElement mx.core.LayoutDirection | UIComponent
|  | leading | Type: Number Format: Length CSS Inheritance: yes Theme: mobile Additional vertical space between lines of text. See also spark.components.supportClasses.StyleableTextField.leading lineHeight | GroupBase
|  | leadingModel | Type: String CSS Inheritance: yes Specifies the leading model, which is a combination of leading basis and leading direction. See also flashx.textLayout.formats.ITextLayoutFormat.leadingModel | GroupBase
|  | left | Type: String CSS Inheritance: no The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent
|  | letterSpacing | Type: Number CSS Inheritance: yes Theme: mobile The number of additional pixels to appear between each character. See also spark.components.supportClasses.StyleableTextField.letterSpacing trackingLeft trackingRight | GroupBase
|  | ligatureLevel | Type: String CSS Inheritance: yes Controls which of the ligatures that are defined in the font may be used in the text. See also flashx.textLayout.formats.ITextLayoutFormat.ligatureLevel | GroupBase
|  | lineHeight | Type: Object CSS Inheritance: yes Leading controls for the text. See also flashx.textLayout.formats.ITextLayoutFormat.lineHeight leading | GroupBase
|  | lineThrough | Type: Boolean CSS Inheritance: yes If true, applies strikethrough, a line drawn through the middle of the text. See also flashx.textLayout.formats.ITextLayoutFormat.lineThrough | GroupBase
|  | listAutoPadding | Type: Number Format: length CSS Inheritance: yes This specifies an auto indent for the start edge of lists when the padding value of the list on that side is `auto`. See also flashx.textLayout.formats.ITextLayoutFormat.listAutoPadding | GroupBase
|  | listStylePosition | Type: String CSS Inheritance: yes This controls the placement of a list item marker relative to the list item. See also flashx.textLayout.formats.ITextLayoutFormat.listStylePosition | GroupBase
|  | listStyleType | Type: String CSS Inheritance: yes This controls the appearance of items in a list. See also flashx.textLayout.formats.ITextLayoutFormat.listStyleType | GroupBase
|  | locale | Type: String CSS Inheritance: yes The locale of the text. See also http://www.unicode.org/reports/tr35/ | GroupBase
|  | paragraphEndIndent | Type: Number Format: length CSS Inheritance: yes The amount to indent the paragraph's end edge. See also flashx.textLayout.formats.ITextLayoutFormat.paragraphEndIndent | GroupBase
|  | paragraphSpaceAfter | Type: Number Format: length CSS Inheritance: yes The amount of space to leave after the paragraph. See also flashx.textLayout.formats.ITextLayoutFormat.paragraphSpaceAfter | GroupBase
|  | paragraphSpaceBefore | Type: Number Format: length CSS Inheritance: yes The amount of space to leave before the paragraph. See also flashx.textLayout.formats.ITextLayoutFormat.paragraphSpaceBefore | GroupBase
|  | paragraphStartIndent | Type: Number Format: length CSS Inheritance: yes The amount to indent the paragraph's start edge. See also flashx.textLayout.formats.ITextLayoutFormat.paragraphStartIndent | GroupBase
|  | renderingMode | Type: String CSS Inheritance: yes The rendering mode used for this text which applies only to embedded fonts. See also flashx.textLayout.formats.ITextLayoutFormat.renderingMode | GroupBase
|  | right | Type: String CSS Inheritance: no The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent
|  | rollOverColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of the highlights when the mouse is over the component. | GroupBase
|  | showErrorSkin | Type: Boolean CSS Inheritance: yes Show the error border or skin when this component is invalid. | UIComponent
|  | showErrorTip | Type: Boolean CSS Inheritance: yes Show the error tip when this component is invalid and the user rolls over it. | UIComponent
|  | symbolColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile Color of any symbol of a component. | GroupBase
|  | tabStops | Type: String CSS Inheritance: yes Specifies the tab stops associated with the paragraph. See also flashx.textLayout.formats.ITextLayoutFormat.tabStops | GroupBase
|  | textAlign | Type: String CSS Inheritance: yes Alignment of text within a container. See also flashx.textLayout.formats.ITextLayoutFormat.textAlign spark.components.supportClasses.StyleableStageText.textAlign spark.components.supportClasses.StyleableTextField.textAlign | GroupBase
|  | textAlignLast | Type: String CSS Inheritance: yes Alignment of the last line in the paragraph relative to the container in justified text. See also flashx.textLayout.formats.ITextLayoutFormat.textAlignLast | GroupBase
|  | textAlpha | Type: Number CSS Inheritance: yes Alpha (transparency) value for the text. See also flashx.textLayout.formats.ITextLayoutFormat.textAlpha | GroupBase
|  | textDecoration | Type: String CSS Inheritance: yes Determines whether the text is underlined. See also flashx.textLayout.formats.ITextLayoutFormat.textDecoration spark.components.supportClasses.StyleableTextField.textDecoration | GroupBase
|  | textIndent | Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container. See also flashx.textLayout.formats.ITextLayoutFormat.textIndent spark.components.supportClasses.StyleableTextField.textIndent | GroupBase
|  | textJustify | Type: String CSS Inheritance: yes Specifies options for justifying text. See also flashx.textLayout.formats.ITextLayoutFormat.textJustify | GroupBase
|  | textRotation | Type: String CSS Inheritance: yes Determines the number of degrees to rotate this text. See also flashx.textLayout.formats.ITextLayoutFormat.textRotation | GroupBase
|  | textShadowAlpha | Type: Number CSS Inheritance: yes Theme: mobile Alpha of text shadows. | Group
|  | textShadowColor | Type: uint Format: Color CSS Inheritance: yes Theme: mobile Color of text shadows. | Group
|  | themeColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo Theme color of a component. | UIComponent
|  | top | Type: String CSS Inheritance: no The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent
|  | touchDelay | Type: Number Format: Time CSS Inheritance: yes When in touch interaction mode, the number of milliseconds to wait after the user interaction has occured before showing the component in a visually down state. | GroupBase
|  | trackingLeft | Type: Object CSS Inheritance: yes The amount of tracking (manual kerning) to be applied to the left of each character. See also flashx.textLayout.formats.ITextLayoutFormat.trackingLeft | GroupBase
|  | trackingRight | Type: Object CSS Inheritance: yes The amount of tracking (manual kerning) to be applied to the right of each character. See also flashx.textLayout.formats.ITextLayoutFormat.trackingRight | GroupBase
|  | typographicCase | Type: String CSS Inheritance: yes The type of typographic case used for this text. See also flashx.textLayout.formats.ITextLayoutFormat.typographicCase | GroupBase
|  | unfocusedTextSelectionColor | Type: uint Format: Color CSS Inheritance: yes The color of text when the component is enabled but does not have focus. | GroupBase
|  | verticalCenter | Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent
|  | whiteSpaceCollapse | Type: String CSS Inheritance: yes Collapses or preserves whitespace when importing text into a TextFlow. See also flashx.textLayout.formats.ITextLayoutFormat.whiteSpaceCollapse | GroupBase
|  | wordSpacing | Type: Object CSS Inheritance: yes Specifies the spacing between words to use during justification. See also flashx.textLayout.formats.ITextLayoutFormat.wordSpacing | GroupBase

Effects
Hide Inherited Effects
Show Inherited Effects

| Effect | Description | Defined By
--- | --- | --- | ---
|  | addedEffect | Triggering Event: added Played when the component is added as a child to a Container. | UIComponent
|  | creationCompleteEffect | Triggering Event: creationComplete Played when the component is created. | UIComponent
|  | focusInEffect | Triggering Event: focusIn Played when the component gains keyboard focus. | UIComponent
|  | focusOutEffect | Triggering Event: focusOut Played when the component loses keyboard focus. | UIComponent
|  | hideEffect | Triggering Event: hide Played when the component becomes invisible. | UIComponent
|  | mouseDownEffect | Triggering Event: mouseDown Played when the user presses the mouse button while over the component. | UIComponent
|  | mouseUpEffect | Triggering Event: mouseUp Played when the user releases the mouse button while over the component. | UIComponent
|  | moveEffect | Triggering Event: move Played when the component is moved. | UIComponent
|  | removedEffect | Triggering Event: removed Played when the component is removed from a Container. | UIComponent
|  | resizeEffect | Triggering Event: resize Played when the component is resized. | UIComponent
|  | rollOutEffect | Triggering Event: rollOut Played when the user rolls the mouse so it is no longer over the component. | UIComponent
|  | rollOverEffect | Triggering Event: rollOver Played when the user rolls the mouse over the component. | UIComponent
|  | showEffect | Triggering Event: show Played when the component becomes visible. | UIComponent

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | DEFAULT_MAX_HEIGHT : Number = 10000 [static] The default value for the maxHeight property. | UIComponent
|  | DEFAULT_MAX_WIDTH : Number = 10000 [static] The default value for the maxWidth property. | UIComponent
|  | DEFAULT_MEASURED_HEIGHT : Number = 22 [static] The default value for the measuredHeight property. | UIComponent
|  | DEFAULT_MEASURED_MIN_HEIGHT : Number = 22 [static] The default value for the measuredMinHeight property. | UIComponent
|  | DEFAULT_MEASURED_MIN_WIDTH : Number = 40 [static] The default value for the measuredMinWidth property. | UIComponent
|  | DEFAULT_MEASURED_WIDTH : Number = 160 [static] The default value for the measuredWidth property. | UIComponent

Property Detail

anchorColumnIndex | property

`anchorColumnIndex:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

The column index of the anchor for the next shift selection. The anchor is the item most recently selected. It defines the anchor item when selecting multiple items in the grid. When you select multiple items, the set of items extends from the anchor to the caret item.

Grid event handlers should use this property to record the location of the most recent unshifted mouse down or keyboard event that defines one end of the next potential shift selection. The caret index defines the other end.

The default value is `0`.

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

Implementation
`public function get anchorColumnIndex():int`
`public function set anchorColumnIndex(value:int):void`

See also

spark.components.Grid.caretRowIndex
spark.components.Grid.caretColumnIndex

anchorRowIndex | property |

`anchorRowIndex:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

The row index of the anchor for the next shift selection. The anchor is the item most recently selected. It defines the anchor item when selecting multiple items in the grid. When you select multiple items, the set of items extends from the anchor to the caret item.

Grid event handlers should use this property to record the location of the most recent unshifted mouse down or keyboard event that defines one end of the next potential shift selection. The caret index defines the other end.

The default value is `0`.

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

Implementation
`public function get anchorRowIndex():int`
`public function set anchorRowIndex(value:int):void`

See also

spark.components.Grid.caretRowIndex
spark.components.Grid.caretColumnIndex

caretColumnIndex | property |

`caretColumnIndex:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `showCaretIndicator` is `true`, the column index of the `caretIndicator`.

If `selectionMode` is `GridSelectionMode.SINGLE_ROW` or `GridSelectionMode.MULTIPLE_ROWS` then the indicator occupies the entire row and `caretColumnIndex` is ignored. If `selectionMode` is `GridSelectionMode.SINGLE_CELL` or `GridSelectionMode.MULTIPLE_CELLS`, then the `caretIndicator` occupies the specified cell.

Setting `caretColumnIndex` to -1 means that the column index is undefined and a cell caret is not shown.

The default value is `-1`.

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

Implementation
`public function get caretColumnIndex():int`
`public function set caretColumnIndex(value:int):void`

caretIndicator | property |

`caretIndicator:IFactory`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `selectionMode` is `GridSelectionMode.SINGLE_ROW` or `GridSelectionMode.MULTIPLE_ROWS`, a single visual element displayed for the caret row, If `selectionMode` is `GridSelectionMode.SINGLE_CELL` or `GridSelectionMode.MULTIPLE_CELLS`, the visual element displayed for the caret cell.

The default value is `null`.

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

Implementation
`public function get caretIndicator():IFactory`
`public function set caretIndicator(value:IFactory):void`

caretRowIndex | property |

`caretRowIndex:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `showCaretIndicator` is `true`, the row index of the `caretIndicator`. If `selectionMode` is `GridSelectionMode.SINGLE_ROW` or `GridSelectionMode.MULTIPLE_ROWS` then the indicator occupies the entire row and the `caretColumnIndex` property is ignored. If `selectionMode` is `GridSelectionMode.SINGLE_CELL` or `GridSelectionMode.MULTIPLE_CELLS`, then the `caretIndicator` occupies the specified cell.

Setting `caretRowIndex` to -1 means that the row index is undefined and the caret will not be shown.

The default value is `-1`.

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

Implementation
`public function get caretRowIndex():int`
`public function set caretRowIndex(value:int):void`

columns | property |

`columns:IList`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

The list of GridColumn objectss displayed by this grid. Each column selects different data provider item properties to display.

GridColumn objects can only appear in the `columns` for a single Grid control.

The default value is `null`.

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

Implementation
`public function get columns():IList`
`public function set columns(value:IList):void`

See also

spark.components.Grid.dataProvider

columnSeparator | property |

`columnSeparator:IFactory`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

A visual element displayed between each column.

The default value is `null`.

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

Implementation
`public function get columnSeparator():IFactory`
`public function set columnSeparator(value:IFactory):void`

dataGrid | property |

`dataGrid:DataGrid`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

The DataGrid control for which this Grid is used as the grid skin part.

The default value is `null`.

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

Implementation
`public function get dataGrid():DataGrid`
`public function set dataGrid(value:DataGrid):void`

dataProvider | property |

`dataProvider:IList`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

A list of data items that correspond to the rows in the grid. Each grid column is associated with a property of the data items to display that property in the grid cells.

The default value is `null`.

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

Implementation
`public function get dataProvider():IList`
`public function set dataProvider(value:IList):void`

See also

spark.components.Grid.columns

dataTipField | property |

`dataTipField:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

The name of the field in the data provider to display as the datatip. By default, if `showDataTips` is `true`, the associated grid control looks for a property named `label` on each data provider item and displays it. However, if the data provider does not contain a `label` property, you can set the `dataTipField` property to specify a different property name. For example, you could set the value to "FullName" when a user views a set of people's names included from a database.

`GridColumn.dataTipField` takes precedence over this property.

If this column or its grid specifies a value for the `dataTipFunction` property, then the `dataTipField` property is ignored.

The default value is `null`.

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

Implementation
`public function get dataTipField():String`
`public function set dataTipField(value:String):void`

dataTipFunction | property |

`dataTipFunction:Function`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Specifies a callback function to run on each item of the data provider to determine its data tip. This property is used by the `itemToDataTip` method.

By default, if `showDataTips` is `true`, the column looks for a property named `label` on each data provider item and displays it as its data tip. However, some data providers do not have a `label` property nor do they have another property that you can use for displaying data in the rows.

For example, you have a data provider that contains a lastName and firstName fields, but you want to display full names as the data tip. You can specify a function to the `dataTipFunction` property that returns a single String containing the value of both fields. You can also use the `dataTipFunction` property for handling formatting and localization.

The signature of the `dataTipFunction` function must match the following:

    dataTipFunction(item:Object, column:GridColumn):String

The `item` parameter is the data provider item for an entire row. The second parameter is this column object.

A typical function might concatenate an item's firstName and lastName properties, or do some custom formatting on a Date value property.

The default value is `null`.

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

Implementation
`public function get dataTipFunction():Function`
`public function set dataTipFunction(value:Function):void`

doubleClickMode | property |

`doubleClickMode:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.10

Runtime Versions : | Flash Player 11.1, AIR 3.4

The doubleClick mode of the control. Possible values are: `GridDoubleClickMode.CELL`, `GridDoubleClickMode.GRID`, `GridDoubleClickMode.ROW`,

Changing the doubleClickMode changes the double click criteria for firing the doubleClick event

The default value is `GridDoubleClickMode.ROW`.

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

Implementation
`public function get doubleClickMode():String`
`public function set doubleClickMode(value:String):void`

See also

spark.components.gridClasses.GridDoubleClickMode

gridView | property |

`gridView:IFactory`

Language Version : | ActionScript 3.0

Product Version : | Flex 5.0

Runtime Versions : | Flash Player 10, AIR 2.5

Used to initialize this grid's gridViews: centerGridView, leftGridView, topGridView, topLeftGridView. GridViews are created as needed, depending on the values of lockedRowCount and lockedColumnCount.

The default value is `null.`.

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

Implementation
`public function get gridView():IFactory`
`public function set gridView(value:IFactory):void`

horizontalScrollPosition | property |

`horizontalScrollPosition:Number`[override]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The x coordinate of the origin of the viewport in the component's coordinate system, where the default value is (0,0) corresponding to the upper-left corner of the component. If `clipAndEnableScrolling` is `true`, setting this property typically causes the viewport to be set to:

          new Rectangle(horizontalScrollPosition, verticalScrollPosition, width, height)

Implementations of this property must be Bindable and must generate events of type `propertyChange`.

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

Implementation
`public function get horizontalScrollPosition():Number`
`public function set horizontalScrollPosition(value:Number):void`

hoverColumnIndex | property |

`hoverColumnIndex:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `showHoverIndicator` is `true`, Specifies column index of the `hoverIndicator`. If `selectionMode` is `GridSelectionMode.SINGLE_ROW` or `GridSelectionMode.MULTIPLE_ROWS`, then the indicator occupies the entire row and `hoverColumnIndex` is ignored. If `selectionMode` is `GridSelectionMode.SINGLE_CELL` or `GridSelectionMode.MULTIPLE_CELLS` then the `hoverIndicator` occupies the specified cell.

Setting `hoverColumnIndex` to -1 (the default) means that the column index is undefined and a cell hover indicator is not displayed.

The default value is `-1`.

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

Implementation
`public function get hoverColumnIndex():int`
`public function set hoverColumnIndex(value:int):void`

hoverIndicator | property |

`hoverIndicator:IFactory`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `selectionMode` is `GridSelectionMode.SINGLE_ROW` or `GridSelectionMode.MULTIPLE_ROWS`. a single visual element displayed for the row under the mouse. If `selectionMode` is `GridSelectionMode.SINGLE_CELL` or `GridSelectionMode.MULTIPLE_CELLS`, the visual element for the cell.

The default value is `null`.

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

Implementation
`public function get hoverIndicator():IFactory`
`public function set hoverIndicator(value:IFactory):void`

hoverRowIndex | property |

`hoverRowIndex:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `showHoverIndicator` is `true`, specifies the column index of the `hoverIndicator`. If `selectionMode` is `GridSelectionMode.SINGLE_ROW` or `GridSelectionMode.MULTIPLE_ROWS`, then the indicator occupies the entire row and `hoverColumnIndex` is ignored. If `selectionMode` is `GridSelectionMode.SINGLE_CELL` or `GridSelectionMode.MULTIPLE_CELLS` then the `hoverIndicator` occupies the specified cell.

Setting `hoverRowIndex` to -1,the default, means that the row index is undefined and a hover indicator is not displayed.

The default value is `-1`.

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

Implementation
`public function get hoverRowIndex():int`
`public function set hoverRowIndex(value:int):void`

isFirstRow | property |

`isFirstRow:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4.10

Runtime Versions : | Flash Player 11.1, AIR 3.4

Returns if the selectedIndex is equal to the first row.

Implementation
`public function get isFirstRow():Boolean`

isLastRow | property |

`isLastRow:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4.10

Runtime Versions : | Flash Player 11.1, AIR 3.4

Returns if the selectedIndex is equal to the last row.

Implementation
`public function get isLastRow():Boolean`

itemRenderer | property |

`itemRenderer:IFactory`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

The item renderer that's used for columns that do not specify one.

The default value is `null`.

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

Implementation
`public function get itemRenderer():IFactory`
`public function set itemRenderer(value:IFactory):void`

lockedColumnCount | property |

`lockedColumnCount:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 5.0

Runtime Versions : | Flash Player 10, AIR 2.5

The first lockedColumnCount columns are "locked", i.e. they do not scroll horizontally. If lockedColumnCount is zero (the default) then changes to the horizontalScrollPosition affect all columns.

The locked columns are displayed in the topGridView and, if lockedRowCount is also greater than zero, the topLeftGridView. The locked columns are separated from the remaining columns by a lockedColumnSeparator.

The default value is `0`.

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

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

See also

spark.components.gridClasses.GridColumn.topGridView
spark.components.gridClasses.GridColumn.topLeftGridView
spark.components.gridClasses.GridColumn.lockedColumnSeparator

lockedColumnsSeparator | property |

`lockedColumnsSeparator:IFactory`

Language Version : | ActionScript 3.0

Product Version : | Flex 5.0

Runtime Versions : | Flash Player 10, AIR 2.5

A visual element displayed between the locked and unlocked columns. The factory value of this property is used to create the lockedColumnsSeparatorElement.

The default value is `null`.

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

Implementation
`public function get lockedColumnsSeparator():IFactory`
`public function set lockedColumnsSeparator(value:IFactory):void`

See also

spark.components.Grid.lockedRowsSeparatorElement

lockedRowCount | property |

`lockedRowCount:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 5.0

Runtime Versions : | Flash Player 10, AIR 2.5

The first lockedRowCount rows are "locked", i.e. they do not scroll vertically. If lockedRowCount is zero (the default) then changes to the verticalScrollPosition affect all rows.

The locked rows are displayed in the leftGridView and, if lockedColumnCount is also greater than zero, the topLeftGridView. The locked rows are separated from the remaining rows by a lockedRowSeparator.

The default value is `0`.

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

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

See also

spark.components.gridClasses.GridColumn.leftGridView
spark.components.gridClasses.GridColumn.topLeftGridView
spark.components.gridClasses.GridColumn.lockedRowSeparator

lockedRowsSeparator | property |

`lockedRowsSeparator:IFactory`

Language Version : | ActionScript 3.0

Product Version : | Flex 5.0

Runtime Versions : | Flash Player 10, AIR 2.5

A visual element displayed between the locked and unlocked rows. The factory value of this property is used to create the lockedRowsSeparatorElement.

The default value is `null`.

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

Implementation
`public function get lockedRowsSeparator():IFactory`
`public function set lockedRowsSeparator(value:IFactory):void`

See also

spark.components.Grid.lockedRowsSeparatorElement

preserveSelection | property |

`preserveSelection:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `true`, the selection is preserved when the data provider refreshes its collection. Because this refresh requires each item in the selection to be saved, this action is not desirable if the selection is large.

The default value is `true`.

Implementation
`public function get preserveSelection():Boolean`
`public function set preserveSelection(value:Boolean):void`

requestedColumnCount | property |

`requestedColumnCount:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

The measured width of this grid is large enough to display the first `requestedColumnCount` columns. If `requestedColumnCount` is -1, then the measured width is big enough for all of the columns.

If the actual size of the grid has been explicitly set, then this property has no effect.

The default value is `-1`.

Implementation
`public function get requestedColumnCount():int`
`public function set requestedColumnCount(value:int):void`

requestedMaxRowCount | property |

`requestedMaxRowCount:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

The measured height of the grid is large enough to display no more than `requestedMaxRowCount` rows.

This property has no effect if any of the following are true;

- `requestedRowCount` is set.
- The actual size of the grid has been explicitly set.

The default value is `10`.

Implementation
`public function get requestedMaxRowCount():int`
`public function set requestedMaxRowCount(value:int):void`

requestedMinColumnCount | property |

`requestedMinColumnCount:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

The measured width of this grid is large enough to display at least `requestedMinColumnCount` columns.

This property has no effect if any of the following are true;

- `requestedColumnCount` is set.
- The actual size of the grid has been explicitly set.
- The grid is inside a Scroller component.

The default value is `-1`.

Implementation
`public function get requestedMinColumnCount():int`
`public function set requestedMinColumnCount(value:int):void`

requestedMinRowCount | property |

`requestedMinRowCount:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

The measured height of this grid is large enough to display at least `requestedMinRowCount` rows.

This property has no effect if any of the following are true;

- `requestedRowCount` is set.
- The actual size of the grid has been explicitly set.

The default value is `-1`.

Implementation
`public function get requestedMinRowCount():int`
`public function set requestedMinRowCount(value:int):void`

requestedRowCount | property |

`requestedRowCount:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 2.5

The measured height of this grid is large enough to display the first `requestedRowCount` rows.

If `requestedRowCount` is -1, then the measured size will be big enough for all of the layout elements.

If the actual size of the grid has been explicitly set, then this property has no effect.

The default value is `-1`.

Implementation
`public function get requestedRowCount():int`
`public function set requestedRowCount(value:int):void`

requireSelection | property |

`requireSelection:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `true` and the `selectionMode` property is not `GridSelectionMode.NONE`, an item must always be selected in the grid.

The default value is `false`.

Implementation
`public function get requireSelection():Boolean`
`public function set requireSelection(value:Boolean):void`

resizableColumns | property |

`resizableColumns:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

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

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

Implementation
`public function get resizableColumns():Boolean`
`public function set resizableColumns(value:Boolean):void`

See also

spark.components.gridClasses.GridColumn

rowBackground | property |

`rowBackground:IFactory`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

A visual element that's displays the background for each row.

The default value is `null`.

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

Implementation
`public function get rowBackground():IFactory`
`public function set rowBackground(value:IFactory):void`

rowHeight | property |

`rowHeight:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `variableRowHeight` is `false`, then this property specifies the actual height of each row, in pixels.

If `variableRowHeight` is `true`, the value of this property is used as the estimated height for rows that haven't been scrolled into view yet, rather than the preferred height of renderers configured with the `typicalItem`. Similarly, when the Grid pads its display with empty rows, this property specifies the empty rows' height.

If `variableRowHeight` is `false`, the default value of this property is the maximum preferred height of the per-column renderers created for the `typicalItem`.

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

Implementation
`public function get rowHeight():Number`
`public function set rowHeight(value:Number):void`

rowSeparator | property |

`rowSeparator:IFactory`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

A visual element that's displayed in between each row.

The default value is `null`.

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

Implementation
`public function get rowSeparator():IFactory`
`public function set rowSeparator(value:IFactory):void`

selectedCell | property |

`selectedCell:CellPosition`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `selectionMode` is `GridSelectionMode.SINGLE_CELL` or `GridSelectionMode.MULTIPLE_CELLS`, returns the first selected cell starting at row 0 column 0 and progressing through each column in a row before moving to the next row.

When the user changes the selection by interacting with the control, the control dispatches the `selectionChange` event. When the user changes the selection programmatically, the control dispatches the `valueCommit` event.

This property is intended to be used to initialize or bind to the selection in MXML markup. The `setSelectedCell()` method should be used for programatic selection updates, for example when writing a keyboard or mouse event handler.

The default value is `null`.

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

Implementation
`public function get selectedCell():CellPosition`
`public function set selectedCell(value:CellPosition):void`

selectedCells | property |

`selectedCells:Vector.<CellPosition>`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `selectionMode` is `GridSelectionMode.SINGLE_CELL` or `GridSelectionMode.MULTIPLE_CELLS`, returns a Vector of CellPosition objects representing the positions of the selected cells in the grid.

When the user changes the selection by interacting with the control, the control dispatches the `selectionChange` event. When the user changes the selection programmatically, the control dispatches the `valueCommit` event.

This property is intended to be used to initialize or bind to the selection in MXML markup. The `setSelectedCell()` method should be used for programatic selection updates, for example when writing a keyboard or mouse event handler.

The default value is an empty `Vector.<CellPosition>`

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

Implementation
`public function get selectedCells():Vector.<CellPosition>`
`public function set selectedCells(value:Vector.<CellPosition>):void`

selectedIndex | property |

`selectedIndex:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `selectionMode` is `GridSelectionMode.SINGLE_ROW` or `GridSelectionMode.MULTIPLE_ROWS`, returns the rowIndex of the first selected row.

When the user changes the selection by interacting with the control, the control dispatches the `selectionChange` event. When the user changes the selection programmatically, the control dispatches the `valueCommit` event.

This property is intended to be used to initialize or bind to the selection in MXML markup. The `setSelectedCell()` method should be used for programatic selection updates, for example when writing a keyboard or mouse event handler.

The default value is `-1`.

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

Implementation
`public function get selectedIndex():int`
`public function set selectedIndex(value:int):void`

selectedIndices | property |

`selectedIndices:Vector.<int>`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `selectionMode` is `GridSelectionMode.SINGLE_ROW` or `GridSelectionMode.MULTIPLE_ROWS`, returns a Vector of the selected rows indices. For all other selection modes, this method has no effect.

When the user changes the selection by interacting with the control, the control dispatches the `selectionChange` event. When the user changes the selection programmatically, the control dispatches the `valueCommit` event.

This property is intended to be used to initialize or bind to the selection in MXML markup. The setSelectedCell() method should be used for programatic selection updates, for example when writing a keyboard or mouse event handler.

>

The default value is an empty `Vector.<int>`

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

Implementation
`public function get selectedIndices():Vector.<int>`
`public function set selectedIndices(value:Vector.<int>):void`

See also

spark.components.Grid.dataProvider

selectedItem | property |

`selectedItem:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `selectionMode` is `GridSelectionMode.SINGLE_ROW` or `GridSelectionMode.MULTIPLE_ROWS`, returns the item in the the data provider that is currently selected or `undefined` if no rows are selected.

When the user changes the selection by interacting with the control, the control dispatches the `selectionChange` event. When the user changes the selection programmatically, the control dispatches the `valueCommit` event.

This property is intended to be used to initialize or bind to the selection in MXML markup. The `setSelectedCell()` method should be used for programatic selection updates, for example when writing a keyboard or mouse event handler.

The default value is `null`.

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

Implementation
`public function get selectedItem():Object`
`public function set selectedItem(value:Object):void`

See also

spark.components.Grid.dataProvider

selectedItems | property |

`selectedItems:Vector.<Object>`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `selectionMode` is `GridSelectionMode.SINGLE_ROW` or `GridSelectionMode.MULTIPLE_ROWS`, returns a Vector of the dataProvider items that are currently selected.

When the user changes the selection by interacting with the control, the control dispatches the `selectionChange` event. When the user changes the selection programmatically, the control dispatches the `valueCommit` event.

This property is intended to be used to initialize or bind to the selection in MXML markup. The setSelectedCell() method should be used for programatic selection updates, for example when writing a keyboard or mouse event handler.

The default value is an empty `Vector.<Object>`

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

Implementation
`public function get selectedItems():Vector.<Object>`
`public function set selectedItems(value:Vector.<Object>):void`

See also

spark.components.Grid.dataProvider

selectionIndicator | property |

`selectionIndicator:IFactory`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `selectionMode` is `GridSelectionMode.SINGLE_ROW` or `GridSelectionMode.MULTIPLE_ROWS`, a visual element that's displayed for each selected row, If `selectionMode` is `GridSelectionMode.SINGLE_CELL` or `GridSelectionMode.MULTIPLE_CELLS`, a visual element displayed for each selected cell.

The default value is `null`.

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

Implementation
`public function get selectionIndicator():IFactory`
`public function set selectionIndicator(value:IFactory):void`

selectionLength | property |

`selectionLength:int` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `selectionMode` is `GridSelectionMode.SINGLE_ROW` or `GridSelectionMode.MULTIPLE_ROWS`, returns the number of selected rows. If `selectionMode` is `GridSelectionMode.SINGLE_CELLS` or `GridSelectionMode.MULTIPLE_CELLS`, returns the number of selected cells.

The default value is `0`.

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

Implementation
`public function get selectionLength():int`

selectionMode | property |

`selectionMode:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

The selection mode of the control. Possible values are: `GridSelectionMode.MULTIPLE_CELLS`, `GridSelectionMode.MULTIPLE_ROWS`, `GridSelectionMode.NONE`, `GridSelectionMode.SINGLE_CELL`, and `GridSelectionMode.SINGLE_ROW`.

Changing the selectionMode causes the current selection to be cleared and the caretRowIndex and caretColumnIndex to be set to -1.

The default value is `GridSelectionMode.SINGLE_ROW`.

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

Implementation
`public function get selectionMode():String`
`public function set selectionMode(value:String):void`

See also

spark.components.gridClasses.GridSelectionMode

showCaret | property |

`showCaret:Boolean`

Determines if the caret is visible. TBD: when is this property automatically set?

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

Implementation
`public function get showCaret():Boolean`
`public function set showCaret(value:Boolean):void`

showDataTips | property |

`showDataTips:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `true` then a dataTip is displayed for all visible cells. If `false`, the default, then a dataTip is only displayed if the column's `showDataTips` property is `true`.

The default value is `false`.

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

Implementation
`public function get showDataTips():Boolean`
`public function set showDataTips(value:Boolean):void`

typicalItem | property |

`typicalItem:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

The grid's layout ensures that columns whose width is not specified are wide enough to display an item renderer for this default data provider item. If a typical item is not specified, then the first data provider item is used.

Restriction: if the `typicalItem` is an IVisualItem, it must not also be a member of the data provider.

The default value is `null`.

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

Implementation
`public function get typicalItem():Object`
`public function set typicalItem(value:Object):void`

variableRowHeight | property |

`variableRowHeight:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `true`, each row's height is the maximum of preferred heights of the cells displayed so far.

If `false`, the height of each row is just the value of the `rowHeight` property. If `rowHeight` isn't specified, then the height of each row is defined by the `typicalItem` property.

The default value is `false`.

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

Implementation
`public function get variableRowHeight():Boolean`
`public function set variableRowHeight(value:Boolean):void`

verticalScrollPosition | property |

`verticalScrollPosition:Number`[override]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The y coordinate of the origin of the viewport in the component's coordinate system, where the default value is (0,0) corresponding to the upper-left corner of the component. If `clipAndEnableScrolling` is `true`, setting this property typically causes the viewport to be set to:

          new Rectangle(horizontalScrollPosition, verticalScrollPosition, width, height)

Implementations of this property must be Bindable and must generate events of type `propertyChange`.

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

Implementation
`public function get verticalScrollPosition():Number`
`public function set verticalScrollPosition(value:Number):void`
Constructor Detail

Grid | () | Constructor

`public function Grid()`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Constructor.

Method Detail

addSelectedCell | () | method

`public function addSelectedCell(rowIndex:int, columnIndex:int):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `selectionMode` is `GridSelectionMode.SINGLE_CELL` or `GridSelectionMode.MULTIPLE_CELLS`, adds the cell to the selection and sets the caret position to the cell. For all other selection modes, this method has no effect.

The `rowIndex` is the index in the data provider of the item containing the selected cell. The `columnIndex` is the index in `columns` of the column containing the selected cell.

Parameters

| `rowIndex:int` — The 0-based row index of the cell.
| `columnIndex:int` — The 0-based column index of the cell.

Returns

| `Boolean` — `true` if no errors. `false` if `rowIndex` or `columnIndex` is invalid, or the `selectionMode` is invalid.

See also

spark.components.Grid.caretColumnIndex
spark.components.Grid.caretRowIndex
spark.components.Grid.columns
spark.components.Grid.dataProvider

addSelectedIndex | () | method |

`public function addSelectedIndex(rowIndex:int):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `selectionMode` is `GridSelectionMode.MULTIPLE_ROWS`, adds this row to the selection and sets the caret position to this row. For all other selection modes, this method has no effect.

The `rowIndex` is the index in the data provider of the item containing the selected cell.

Parameters

| `rowIndex:int` — The 0-based row index of the cell.

Returns

| `Boolean` — `true` if no errors. `false` if `index` is invalid or the `selectionMode` is invalid.

See also

spark.components.Grid.caretColumnIndex
spark.components.Grid.caretRowIndex
spark.components.Grid.dataProvider

clearSelection | () | method |

`public function clearSelection():Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Removes all of the selected rows and cells, if `selectionMode` is not `GridSelectionMode.NONE`. Removes the caret and sets the anchor to the initial item.

Returns

| `Boolean` — `true` if the selection changed. `false` if there was nothing previously selected.

ensureCellIsVisible | () | method |

`public function ensureCellIsVisible(rowIndex:int = -1, columnIndex:int = -1):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If necessary, set the `verticalScrollPosition` and `horizontalScrollPosition` properties so that the specified cell is completely visible. If `rowIndex` is -1 and `columnIndex` is specified, then just adjust the `horizontalScrollPosition` so that the specified column is visible. If `columnIndex` is -1 and `rowIndex` is specified, then just adjust the `verticalScrollPosition` so that the specified row is visible.

Parameters

| `rowIndex:int` (default = `-1`)`` — The 0-based row index of the item renderer's cell, or -1 to specify a column.
| `columnIndex:int` (default = `-1`)`` — The 0-based column index of the item renderer's cell, or -1 to specify a row.

findRowIndex | () | method |

`public function findRowIndex(field:String, value:String, startingIndex:int = 0, patternType:String):int`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.10

Runtime Versions : | Flash Player 11.1, AIR 3.4

This will search through a dataprovider checking the given field and for the given value and return the index for the match. It can start the find from a given startingIndex;

Parameters

| `field:String`
| `value:String`
| `startingIndex:int` (default = `0`)``
| `patternType:String` (default = `NaN`)``

Returns

| `int`

findRowIndices | () | method |

`public function findRowIndices(field:String, values:Array, patternType:String):Array`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.10

Runtime Versions : | Flash Player 11.1, AIR 3.4

This will search through a dataprovider checking the given field and for the given values and return an array of indices that matched.

Parameters

| `field:String`
| `values:Array`
| `patternType:String` (default = `NaN`)``

Returns

| `Array`

getCellAt | () | method |

`public function getCellAt(x:Number, y:Number):CellPosition`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Return the row and column indices of the cell that overlaps the pixel at the specified grid coordinate. If no such cell exists, null is returned.

The example function below uses this method to compute the value of the `dataField` for a grid cell.

          function getCellData(x:Number, y:Number):Object
          {
              var cell:CellPosition = getCellAt(x, y);
              if (!cell)
                  return null;
              var GridColumn:column = grid.columns.getItemAt(cell.columnIndex);
              return grid.dataProvider.getItemAt(cell.rowIndex)[column.dataField];
          }

Parameters

| `x:Number` — The pixel's x coordinate relative to the grid.
| `y:Number` — The pixel's y coordinate relative to the grid.

Returns

| `CellPosition` — The cell position, or null.

getCellBounds | () | method |

`public function getCellBounds(rowIndex:int, columnIndex:int):Rectangle`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Returns the current pixel bounds of the specified cell, or null if no such cell exists. Cell bounds are reported in grid coordinates.

If all of the columns for the the specfied row and all of the rows preceeding it have not yet been scrolled into view, the returned bounds may only be an approximation, based on all of the columns' `typicalItem`s.

Parameters

| `rowIndex:int` — The 0-based index of the row.
| `columnIndex:int` — The 0-based index of the column.

Returns

| `Rectangle` — A `Rectangle` that represents the cell's pixel bounds, or null.

getCellsAt | () | method |

`public function getCellsAt(x:Number, y:Number, w:Number, h:Number):Vector.<CellPosition>`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Returns a vector of CellPosition objects whose `rowIndex` and `columnIndex` properties specify the row and column indices of the cells that overlap the specified grid region. If no such cells exist, an empty vector is returned.

Parameters

| `x:Number` — The x coordinate of the pixel at the origin of the region, relative to the grid.
| `y:Number` — The x coordinate of the pixel at the origin of the region, relative to the grid.
| `w:Number` — The width of the region, in pixels.
| `h:Number` — The height of the region, in pixels.

Returns

| `Vector.<CellPosition>` — A vector of objects like `Vector.<Object>([{rowIndex:0, columnIndex:0}, ...])`.

getCellX | () | method |

`public function getCellX(rowIndex:int, columnIndex:int):Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Return the X coordinate of the specified cell's origin. If the cell's entire bounds aren't needed, this method is more efficient than `getCellBounds().x`.

If all of the columns for the the specfied row and all of the rows preceeding it have not yet been scrolled into view, the returned value may only be an approximation, based on all of the columns' `typicalItem`s.

Parameters

| `rowIndex:int` — The 0-based index of the row.
| `columnIndex:int` — The 0-based index of the column.

Returns

| `Number` — The x coordindate of the specified cell's origin.

getCellY | () | method |

`public function getCellY(rowIndex:int, columnIndex:int):Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Return the Y coordinate of the specified cell's origin. If the cell's entire bounds aren't needed, this method is more efficient than `getCellBounds().y`.

If all of the columns for the the specfied row and all of the rows preceeding it have not yet been scrolled into view, the returned value may only be an approximation, based on all of the columns' `typicalItem`s.

Parameters

| `rowIndex:int` — The 0-based index of the row.
| `columnIndex:int` — The 0-based index of the column.

Returns

| `Number` — The y coordindate of the specified cell's origin.

getColumnBounds | () | method |

`public function getColumnBounds(columnIndex:int):Rectangle`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Returns the current pixel bounds of the specified column, or null if no such column exists. Column bounds are reported in grid coordinates.

If all of the cells in the specified column have not yet been scrolled into view, the returned bounds may only be an approximation, based on the column's `typicalItem`.

Parameters

| `columnIndex:int` — The 0-based index of the column.

Returns

| `Rectangle` — A `Rectangle` that represents the column's pixel bounds, or null.

getColumnIndexAt | () | method |

`public function getColumnIndexAt(x:Number, y:Number):int`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Returns the column index corresponding to the specified grid coordinates, or -1 if the coordinates are out of bounds.

If all of the columns or rows for the grid have not yet been scrolled into view, the returned index may only be an approximation, based on all of the columns' `typicalItem`s.

Parameters

| `x:Number` — The pixel's x coordinate relative to the grid.
| `y:Number` — The pixel's y coordinate relative to the grid.

Returns

| `int` — The index of the column, or -1 if the coordinates are out of bounds.

getColumnWidth | () | method |

`public function getColumnWidth(columnIndex:int):Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Return the width of the specified column. If the cell's entire bounds aren't needed, this method is more efficient than `getColumnBounds().width`.

If the specified column's width property isn't defined, then the returned value may only be an approximation. The actual column width is only computed after the column has been scrolled into view.

Parameters

| `columnIndex:int` — The 0-based index of the column.

Returns

| `Number` — The width of the specified column.

getItemRendererAt | () | method |

`public function getItemRendererAt(rowIndex:int, columnIndex:int):IGridItemRenderer`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If the requested item renderer is visible, returns a reference to the item renderer currently displayed at the specified cell. Note that once the returned item renderer is no longer visible it may be recycled and its properties reset.

If the requested item renderer is not visible. then each time this method is called, a new item renderer is created. The new item renderer is not visible

If the specified column does not have an explicit width, then the width of this cell is based on the `typicalItem`. If a `typicalItem` was not specified or has not been measured yet, then the item renderer's width defaults to `150`.

If the grid property `variableRowHeight` is `true` (the default) and an overall row height hasn't been cached for the specified row, then the item renderer's height is based on the `typicalItem`. If the `typicalItem` was not specified or has not been measured yet, then the item renderer's height defaults to its preferred height.

Parameters

| `rowIndex:int` — The 0-based row index of the item renderer's cell.
| `columnIndex:int` — The 0-based column index of the item renderer's cell.

Returns

| `IGridItemRenderer` — The item renderer or null if the cell location is invalid.

getRowBounds | () | method |

`public function getRowBounds(rowIndex:int):Rectangle`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Returns the current pixel bounds of the specified row, or null if no such row exists. Row bounds are reported in grid coordinates.

If all of the columns for the the specfied row and all of the rows preceeding it have not yet been scrolled into view, the returned bounds may only be an approximation, based on all of the columns' `typicalItem`s.

Parameters

| `rowIndex:int` — The 0-based index of the row.

Returns

| `Rectangle` — A `Rectangle` that represents the row's pixel bounds, or null.

getRowIndexAt | () | method |

`public function getRowIndexAt(x:Number, y:Number):int`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Returns the row index corresponding to the specified grid coordinates, or -1 if the coordinates are out of bounds.

If all of the columns or rows for the grid have not yet been scrolled into view, the returned index may only be an approximation, based on all of the columns' `typicalItem`s.

Parameters

| `x:Number` — The x coordinate.
| `y:Number` — The y coordinate.

Returns

| `int` — The index of the row corresponding to the specified coordinates.

getVisibleColumnIndices | () | method |

`public function getVisibleColumnIndices():Vector.<int>`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Return the indices of the currently visible columns. Note that the item renderers for the first and last columns may only be partially visible. The returned vector's contents are in the order they're displayed.

The following example function uses this method to compute a vector of visible GridColumn objects.

          function getVisibleColumns():Vector.<GridColumn>
          {
              var visibleColumns = new Vector.<GridColumn>;
              for each (var columnIndex:int in grid.getVisibleColumnIndices())
                  visibleColumns.push(grid.columns.getItemAt(columnIndex));
              return visibleColumns;
          }

Returns

| `Vector.<int>` — A vector of the visible column indices.

getVisibleRowIndices | () | method |

`public function getVisibleRowIndices():Vector.<int>`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Return the data provider indices and padding indices of the currently visible rows. Indices which are greater than or equal to the `dataProvider` length represent padding rows. Note that the item renderers for the first and last rows may only be partially visible. The returned vector's contents are in the order they're displayed.

Returns

| `Vector.<int>` — A vector of the visible row indices.

invalidateCell | () | method |

`public function invalidateCell(rowIndex:int, columnIndex:int):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If the specified cell is visible, it is redisplayed. If `variableRowHeight=true`, then doing so may cause the height of the corresponding row to change.

If columnIndex is -1, then the entire row is invalidated. Similarly if `rowIndex is -1`, then the entire column is invalidated.

This method should be called when there is a change to any aspect of the data provider item at `rowIndex` that might have some impact on the way the specified cell is displayed. Calling this method is similar to calling the `dataProvider.itemUpdated()` method, which advises the Grid that all rows displaying the specified item should be redisplayed. Using this method can be relatively efficient, since it narrows the scope of the change to a single cell.

Parameters

| `rowIndex:int` — The 0-based row index of the cell that changed, or -1.
| `columnIndex:int` — The 0-based column index of the cell that changed or -1.

invalidateTypicalItemRenderer | () | method |

`public function invalidateTypicalItemRenderer():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 1.5

Clears cached column width data that had been based on the `typicalItem` property, and requests a new layout pass. Call this method if some aspect of the `typicalItem` has changed that should be reflected by the Grid's layout.

This method is called automatically if the `typicalItem` is changed directly. That means if the property is set to a new value that is not "==" to current value.

isCellVisible | () | method |

`public function isCellVisible(rowIndex:int = -1, columnIndex:int = -1):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Returns `true` if the specified cell is at least partially visible. If `columnIndex == -1`, then return `true` if the specified row is at least partially visible. If `rowIndex == -1`, then return `true` if the specified column is at least partially visible. If both `columnIndex` and `rowIndex` are -1, then return `false`.

Parameters

| `rowIndex:int` (default = `-1`)`` — The 0-based row index of the item renderer's cell.
| `columnIndex:int` (default = `-1`)`` — The 0-based column index of the item renderer's cell.

Returns

| `Boolean` — True if the specified cell (or row if columnIndex == -1) is at least partially visible

moveIndexFindRow | () | method |

`public function moveIndexFindRow(field:String, value:String, startingIndex:int = 0, patternType:String):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.10

Runtime Versions : | Flash Player 11.1, AIR 3.4

This will search through a dataprovider checking the given field and will set the selectedIndex to a matching value. It can start the search from the startingIndex;

Parameters

| `field:String`
| `value:String`
| `startingIndex:int` (default = `0`)``
| `patternType:String` (default = `NaN`)``

Returns

| `Boolean`

moveIndexFirstRow | () | method |

`public function moveIndexFirstRow():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.10

Runtime Versions : | Flash Player 11.1, AIR 3.4

Changes the selectedIndex to the first row of the dataProvider.

moveIndexLastRow | () | method |

`public function moveIndexLastRow():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.10

Runtime Versions : | Flash Player 11.1, AIR 3.4

Changes the selectedIndex to the last row of the dataProvider.

moveIndexNextRow | () | method |

`public function moveIndexNextRow():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.10

Runtime Versions : | Flash Player 11.1, AIR 3.4

Changes the selectedIndex to the next row of the dataProvider. If there isn't a current selectedIndex, it silently returns. If the selectedIndex is on the first row, it does not wrap around. However the `isFirstRow` property returns true.

moveIndexPreviousRow | () | method |

`public function moveIndexPreviousRow():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.10

Runtime Versions : | Flash Player 11.1, AIR 3.4

Changes the selectedIndex to the previous row of the dataProvider. If there isn't a current selectedIndex, it silently returns. If the selectedIndex is on the last row, it does not wrap around. However the `isLastRow` property returns true.

removeSelectedCell | () | method |

`public function removeSelectedCell(rowIndex:int, columnIndex:int):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `selectionMode` is `GridSelectionMode.SINGLE_CELL` or `GridSelectionMode.MULTIPLE_CELLS`, removes the cell from the selection and sets the caret position to the cell. For all other selection modes, this method has no effect.

The `rowIndex` is the index in the data provider of the item containing the selected cell. The `columnIndex` is the index in `columns` of the column containing the selected cell.

Parameters

| `rowIndex:int` — The 0-based row index of the cell.
| `columnIndex:int` — The 0-based column index of the cell.

Returns

| `Boolean` — `true` if no errors. `false` if `rowIndex` or `columnIndex` is invalid or the `selectionMode` is invalid.

See also

spark.components.Grid.caretColumnIndex
spark.components.Grid.caretRowIndex
spark.components.Grid.columns
spark.components.Grid.dataProvider

removeSelectedIndex | () | method |

`public function removeSelectedIndex(rowIndex:int):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `selectionMode` is `GridSelectionMode.SINGLE_ROW` or `GridSelectionMode.MULTIPLE_ROWS`, removes this row from the selection and sets the caret position to this row. For all other selection modes, this method has no effect.

The `rowIndex` is the index in the data provider of the item containing the selected cell.

Parameters

| `rowIndex:int` — The 0-based row index of the cell.

Returns

| `Boolean` — `true` if no errors. `false` if `index` is invalid or the `selectionMode` is invalid.

See also

spark.components.Grid.caretColumnIndex
spark.components.Grid.caretRowIndex
spark.components.Grid.dataProvider

selectAll | () | method |

`public function selectAll():Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `selectionMode` is `GridSelectionMode.MULTIPLE_ROWS`, selects all rows and removes the caret or if `selectionMode` is `GridSelectionMode.MULTIPLE_CELLS` selects all cells and removes the caret. For all other selection modes, this method has no effect.

If items are added to the `dataProvider` or `columns` are added after this method is called, the new rows or cells in the new column will be selected.

This implicit "selectAll" mode ends when any of the following occur:

- selection is cleared using `clearSelection`
- selection reset using one of `setSelectedCell`, `setSelectedCells`, `setSelectedIndex`, `selectIndices`
- `dataProvider` is refreshed and `preserveSelection` is false
- `dataProvider` is reset
- `columns` is refreshed, `preserveSelection` is `false` and `selectionMode` is `GridSelectionMode.MULTIPLE_CELLS`
- `columns` is reset and `selectionMode` is `GridSelectionMode.MULTIPLE_CELLS`

Returns

| `Boolean` — `true` if the selection changed.

See also

spark.components.Grid.clearSelection
spark.components.Grid.selectIndices
spark.components.Grid.setSelectedCell
spark.components.Grid.setSelectedCells
spark.components.Grid.setSelectedIndex

selectCellRegion | () | method |

`public function selectCellRegion(rowIndex:int, columnIndex:int, rowCount:uint, columnCount:uint):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `selectionMode` is `GridSelectionMode.MULTIPLE_CELLS`, sets the selection to all the cells in the cell region and the caret position to the last cell in the cell region. For all other selection modes, this method has no effect.

The `rowIndex` is the index in the data provider of the item containing the origin of the cell region. The `columnIndex` is the index in `columns` of the column containing the origin of the cell region.

This method has no effect if the cell region is not wholly contained within the grid.

Parameters

| `rowIndex:int` — The 0-based row index of the origin of the cell region.
| `columnIndex:int` — The 0-based column index of the origin of the cell region.
| `rowCount:uint` — Number of rows, starting at `rowIndex` to include in the cell region.
| `columnCount:uint` — Number of columns, starting at `columnIndex` to include in the cell region.

Returns

| `Boolean` — `true` if no errors. `false` if the cell region is invalid or the `selectionMode` is invalid.

See also

spark.components.Grid.caretColumnIndex
spark.components.Grid.caretRowIndex
spark.components.Grid.columns
spark.components.Grid.dataProvider

selectIndices | () | method |

`public function selectIndices(rowIndex:int, rowCount:int):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `selectionMode` is `GridSelectionMode.MULTIPLE_ROWS`, sets the selection to the specfied rows and the caret position to `endRowIndex`. For all other selection modes, this method has no effect.

Each index represents an item in the data provider to include in the selection.

Parameters

| `rowIndex:int` — 0-based row index of the first row in the selection.
| `rowCount:int` — Number of rows in the selection.

Returns

| `Boolean` — `true` if no errors. `false` if any of the indices are invalid, if `startRowIndex` is not less than or equal to `endRowIndex`, or the `selectionMode` is invalid.

See also

spark.components.Grid.dataProvider

selectionContainsCell | () | method |

`public function selectionContainsCell(rowIndex:int, columnIndex:int):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `selectionMode` is `GridSelectionMode.SINGLE_CELL` or `GridSelectionMode.MULTIPLE_CELLS`, returns `true` if the cell is in the current selection.

The `rowIndex` must be between 0 and the length of the data provider. The `columnIndex` must be between 0 and the length of `columns`.

Parameters

| `rowIndex:int` — The 0-based row index of the cell.
| `columnIndex:int` — The 0-based column index of the cell.

Returns

| `Boolean` — `true` if the current selection contains the cell.

See also

spark.components.Grid.columns
spark.components.Grid.dataProvider

selectionContainsCellRegion | () | method |

`public function selectionContainsCellRegion(rowIndex:int, columnIndex:int, rowCount:int, columnCount:int):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `selectionMode` is `GridSelectionMode.MULTIPLE_CELLS`, returns `true` if the cells in the cell region are in the current selection.

The `rowIndex` must be between 0 and the length of the data provider. The `columnIndex` must be between 0 and the length of `columns`.

Parameters

| `rowIndex:int` — The 0-based row index of the cell.
| `columnIndex:int` — The 0-based column index of the cell.
| `rowCount:int` — Number of rows, starting at `rowIndex` to include in the cell region.
| `columnCount:int` — Number of columns, starting at `columnIndex` to include in the cell region.

Returns

| `Boolean` — `true` if the current selection contains all the cells in the cell region.

See also

spark.components.Grid.columns
spark.components.Grid.dataProvider

selectionContainsIndex | () | method |

`public function selectionContainsIndex(rowIndex:int):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `selectionMode` is `GridSelectionMode.SINGLE_ROW` or `GridSelectionMode.MULTIPLE_ROWS`, returns `true` if the row at `index` is in the current selection.

The `rowIndex` is the index in the data provider of the item containing the selected cell.

Parameters

| `rowIndex:int` — The 0-based row index of the row.

Returns

| `Boolean` — `true` if the selection contains the row.

See also

spark.components.Grid.dataProvider

selectionContainsIndices | () | method |

`public function selectionContainsIndices(rowIndices:Vector.<int>):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `selectionMode` is `GridSelectionMode.MULTIPLE_ROWS`, returns `true` if the rows in `indices` are in the current selection.

Parameters

| `rowIndices:Vector.<int>` — Vector of 0-based row indices to include in selection.

Returns

| `Boolean` — `true` if the current selection contains these rows.

See also

spark.components.Grid.dataProvider

setSelectedCell | () | method |

`public function setSelectedCell(rowIndex:int, columnIndex:int):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `selectionMode` is `GridSelectionMode.SINGLE_CELL` or `GridSelectionMode.MULTIPLE_CELLS`, sets the selection and the caret position to this cell. For all other selection modes, this method has no effect.

The `rowIndex` is the index in the data provider of the item containing the selected cell. The `columnIndex` is the index in `columns` of the column containing the selected cell.

Parameters

| `rowIndex:int` — The 0-based row index of the cell.
| `columnIndex:int` — The 0-based column index of the cell.

Returns

| `Boolean` — `true` if no errors. `false` if `rowIndex` or `columnIndex` is invalid or the `selectionMode` is invalid.

See also

spark.components.Grid.caretColumnIndex
spark.components.Grid.caretRowIndex
spark.components.Grid.columns
spark.components.Grid.dataProvider

setSelectedIndex | () | method |

`public function setSelectedIndex(rowIndex:int):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

If `selectionMode` is `GridSelectionMode.SINGLE_ROW` or `GridSelectionMode.MULTIPLE_ROWS`, sets the selection and the caret position to this row. For all other selection modes, this method has no effect.

The `rowIndex` is the index in the data provider of the item containing the selected cell.

Parameters

| `rowIndex:int` — The 0-based row index of the cell.

Returns

| `Boolean` — `true` if if no errors. `false` if `index` is invalid, or the `selectionMode` is invalid.

See also

spark.components.Grid.caretColumnIndex
spark.components.Grid.caretRowIndex
spark.components.Grid.dataProvider
Event Detail

caretChange | Event

Event Object Type: `spark.events.GridCaretEvent`
GridCaretEvent.type property = `spark.events.GridCaretEvent.CARET_CHANGE`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Dispatched after the caret changes.

The `GridSelectionEvent.CARET_CHANGE` constant defines the value of the `type` property of the event object for a `caretChange` event, which indicates that the current caret position has just been changed.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`newColumnIndex` | The zero-based column index of the caret position after it was changed. It is -1 if the `selectionMode` is row-based.
`newRowIndex` | The zero-based row index of the caret position after it was changed.
`oldColumnIndex` | The zero-based column index of the caret position before it was changed. It is -1 if the `selectionMode` is row-based.
`oldRowIndex` | The zero-based row index of the caret position before it was changed.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`type` | GirdCaretEvent.CARET_CHANGE

gridClick | Event |

Event Object Type: `spark.events.GridEvent`
GridEvent.type property = `spark.events.GridEvent.GRID_CLICK`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Dispatched when the mouse is clicked over a cell

The value of the `type` property for a `gridClick` GridEvent.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`column` | The column where the event occurred, or null if the event did not occur over a column.
`columnIndex` | The index of the column where the event occurred, or -1 if the event did not occur over a grid column.
`grid` | The Grid associated with this event.
`item` | The data provider item for this row, or null if the event did not occur over a grid row.
`itemRenderer` | The The item renderer that displayed this cell, or null if the event did not occur over a visible cell.
`rowIndex` | The index of the row where the event occurred, or -1 if the event did not occur over a grid row.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`type` | GirdEvent.GRID_CLICK

gridDoubleClick | Event |

Event Object Type: `spark.events.GridEvent`
GridEvent.type property = `spark.events.GridEvent.GRID_DOUBLE_CLICK`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Dispatched when the mouse is double-clicked over a cell

The value of the `type` property for a `gridDoubleClick` GridEvent.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`column` | The column where the event occurred, or null if the event did not occur over a column.
`columnIndex` | The index of the column where the event occurred, or -1 if the event did not occur over a grid column.
`grid` | The Grid associated with this event.
`item` | The data provider item for this row, or null if the event did not occur over a grid row.
`itemRenderer` | The The item renderer that displayed this cell, or null if the event did not occur over a visible cell.
`rowIndex` | The index of the row where the event occurred, or -1 if the event did not occur over a grid row.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`type` | GirdEvent.GRID_DOUBLE_CLICK

gridMouseDown | Event |

Event Object Type: `spark.events.GridEvent`
GridEvent.type property = `spark.events.GridEvent.GRID_MOUSE_DOWN`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Dispatched when the mouse button is pressed over a Grid cell.

The value of the `type` property for a `gridMouseDown` GridEvent.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`column` | The column where the event occurred, or null if the event did not occur over a column.
`columnIndex` | The index of the column where the event occurred, or -1 if the event did not occur over a grid column.
`grid` | The Grid associated with this event.
`item` | The data provider item for this row, or null if the event did not occur over a grid row.
`itemRenderer` | The The item renderer that displayed this cell, or null if the event did not occur over a visible cell.
`rowIndex` | The index of the row where the event occurred, or -1 if the event did not occur over a grid row.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`type` | GirdEvent.GRID_MOUSE_DOWN

gridMouseDrag | Event |

Event Object Type: `spark.events.GridEvent`
GridEvent.type property = `spark.events.GridEvent.GRID_MOUSE_DRAG`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Dispatched after a `gridMouseDown` event if the mouse moves before the button is released.

The value of the `type` property for a `gridMouseDrag` GridEvent. This event is only dispatched when a listener has handled a `mouseDown` event, and then only while the mouse moves with the button held down.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`column` | The column where the event occurred, or null if the event did not occur over a column.
`columnIndex` | The index of the column where the event occurred, or -1 if the event did not occur over a grid column.
`grid` | The Grid associated with this event.
`item` | The data provider item for this row, or null if the event did not occur over a grid row.
`itemRenderer` | The The item renderer that displayed this cell, or null if the event did not occur over a visible cell.
`rowIndex` | The index of the row where the event occurred, or -1 if the event did not occur over a grid row.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`type` | GirdEvent.GRID_MOUSE_DRAG

gridMouseUp | Event |

Event Object Type: `spark.events.GridEvent`
GridEvent.type property = `spark.events.GridEvent.GRID_MOUSE_UP`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Dispatched when the mouse button is released over a Grid cell. During a drag operation, it is also dispatched after a `gridMouseDown` event when the mouse button is released, even if the mouse is no longer in the Grid.

The value of the `type` property for a `gridMouseUp` GridEvent.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`column` | The column where the event occurred, or null if the event did not occur over a column.
`columnIndex` | The index of the column where the event occurred, or -1 if the event did not occur over a grid column.
`grid` | The Grid associated with this event.
`item` | The data provider item for this row, or null if the event did not occur over a grid row.
`itemRenderer` | The The item renderer that displayed this cell, or null if the event did not occur over a visible cell.
`rowIndex` | The index of the row where the event occurred, or -1 if the event did not occur over a grid row.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`type` | GirdEvent.GRID_MOUSE_UP

gridRollOut | Event |

Event Object Type: `spark.events.GridEvent`
GridEvent.type property = `spark.events.GridEvent.GRID_ROLL_OUT`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Dispatched when the mouse leaves a grid cell.

The value of the `type` property for a `gridRollOut` GridEvent.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`column` | The column where the event occurred, or null if the event did not occur over a column.
`columnIndex` | The index of the column where the event occurred, or -1 if the event did not occur over a grid column.
`grid` | The Grid associated with this event.
`item` | The data provider item for this row, or null if the event did not occur over a grid row.
`itemRenderer` | The The item renderer that displayed this cell, or null if the event did not occur over a visible cell.
`rowIndex` | The index of the row where the event occurred, or -1 if the event did not occur over a grid row.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`type` | GirdEvent.GRID_ROLL_OUT

gridRollOver | Event |

Event Object Type: `spark.events.GridEvent`
GridEvent.type property = `spark.events.GridEvent.GRID_ROLL_OVER`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Dispatched when the mouse enters a grid cell.

The value of the `type` property for a `gridRollOver` GridEvent.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`column` | The column where the event occurred, or null if the event did not occur over a column.
`columnIndex` | The index of the column where the event occurred, or -1 if the event did not occur over a grid column.
`grid` | The Grid associated with this event.
`item` | The data provider item for this row, or null if the event did not occur over a grid row.
`itemRenderer` | The The item renderer that displayed this cell, or null if the event did not occur over a visible cell.
`rowIndex` | The index of the row where the event occurred, or -1 if the event did not occur over a grid row.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`type` | GirdEvent.GRID_ROLL_OVER

Wed Nov 15 2017, 09:50 AM +01:00