| Package | spark.components |
| Class | public class Grid |
| Inheritance | Grid  Group GroupBase UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IDataGridElement |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
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 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.
Show MXML Syntax
Hide MXML SyntaxThe <s:Grid> tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
<s:Grid
Properties
/>
Default MXML PropertymxmlContent
More examples
Passing data to a DataGrid control
Configuring columns
Sorting the columns of the Spark DataGrid control
Hiding and displaying columns
Handling events in a Spark DataGrid control
Selecting cells and rows in the Spark DataGrid control
Handling selection events
Handle single cell and single row selection in the spark DataGrid control
Handle multiple cell and multiple row selection in the Spark DataGrid control
Creating item renderers and item editors for the Spark DataGrid control
Creating an item renderer for a Spark DataGrid
Creating an item editor for a Spark DataGrid
Create a custom sort for the Spark DataGrid control
Learn more
The Spark Grid control
Working with the caret in the Spark DataGrid control
Keyboard and mouse shortcuts with item editors for the Spark DataGrid
Spark DataGrid control keyboard shortcuts
Related API Elements
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | |
| alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | |
| 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 | |
| blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | |
| bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | |
| cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | DisplayObject | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | |
| 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 displayted 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 | ||
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| 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 | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | |
| currentState : String
The current view state of the component. | UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers. | UIComponent | |
| 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 | |
| dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | |
| 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 | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | |
| focusPane : Sprite
The focus pane associated with this object. | UIComponent | |
| focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | |
| graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | |
| 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 | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| horizontalScrollPosition : Number
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. | GroupBase | |
| 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 | |
| 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 | |
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | |
| 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 | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | |
| 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 | |
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| mxmlContent : Array [write-only]
The visual content children for this Group. | Group | |
| name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | |
| nestLevel : int
Depth of this object in the containment hierarchy. | UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | UIComponent | |
| numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | |
| numElements : int [read-only]
The number of visual elements in this container. | GroupBase | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | |
| 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 : mx.geom:TransformOffsets
Defines a set of adjustments that can be applied to the object's
transform in a way that is invisible to its parent's layout. | UIComponent | |
| 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 | |
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| 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 | |
| root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | |
| rotation : Number [override]
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | UIComponent | |
| rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationZ : Number [override]
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent | |
| 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 | ||
| scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| 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 | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | |
| 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 | ||
| 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 | |
| softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed. | InteractiveObject | |
| soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | |
| stage : Stage [read-only]
The Stage of the display object. | DisplayObject | |
| states : Array
The view states that are defined for this component. | UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | |
| styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | |
| styleName : Object
The class style used by this component. | UIComponent | |
| styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors. | UIComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | |
| tabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus
via the TAB key
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor. | UIComponent | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | |
| textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| toolTip : String
Text to display in the ToolTip. | UIComponent | |
| top : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| transform : flash.geom:Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | |
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | |
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| 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 is 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 | |
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls
over a sprite in which the buttonMode property is set to true. | Sprite | |
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| 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
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. | GroupBase | |
| 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]
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | UIComponent | |
| Method | Defined By | ||
|---|---|---|---|
Grid()
Constructor. | Grid | ||
|
Adds a visual element to this container. | Group | |
|
Adds a visual element to this container. | Group | |
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
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 | ||
If selectionMode
is GridSelectionMode.MULTIPLE_ROWS, adds this row to
the selection and sets the caret position to this row. | Grid | ||
|
Adds a non-visual style client to this component instance. | UIComponent | |
|
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | |
|
Queues a function to be called later. | UIComponent | |
Removes all of the selected rows and cells, if selectionMode
is not GridSelectionMode.NONE. | Grid | ||
|
Deletes a style property from this component instance. | UIComponent | |
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | |
|
Determines whether the specified IVisualElement is a
child of the container instance or the instance
itself. | GroupBase | |
|
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
|
Converts a Point object from content to local coordinates. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| [override]
Dispatches an event into the event flow. | UIComponent | |
|
Shows or hides the focus indicator around this component. | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | |
|
Called by the effect instance when it stops playing on the component. | UIComponent | |
|
Called by the effect instance when it starts playing on the component. | UIComponent | |
|
Ends all currently playing effects on the component. | UIComponent | |
If necessary, set the verticalScrollPosition and
horizontalScrollPosition properties so that the
specified cell is completely visible. | Grid | ||
|
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
|
Called after printing is complete. | UIComponent | |
|
Provides the automation object at the specified index. | UIComponent | |
|
Provides the automation object list . | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
Return the row and column indices of the cell that overlaps the pixel at the
specified grid coordinate. | Grid | ||
Returns the current pixel bounds of the specified cell, or null if no such cell exists. | Grid | ||
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 | ||
Return the X coordinate of the specified cell's origin. | Grid | ||
Return the Y coordinate of the specified cell's origin. | Grid | ||
|
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
|
Finds the type selectors for this UIComponent instance. | UIComponent | |
Returns the current pixel bounds of the specified column, or null if no such column exists. | Grid | ||
Returns the column index corresponding to the specified coordinates,
or -1 if the coordinates are out of bounds. | Grid | ||
Return the width of the specified column. | Grid | ||
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
|
Returns the visual element at the specified index. | GroupBase | |
|
Returns the index position of a visual element. | GroupBase | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
Gets the object that currently has focus. | UIComponent | |
|
Returns the change to the horizontal scroll position to handle
different scrolling options. | GroupBase | |
If the requested item renderer is visible, returns a reference to
the item renderer currently displayed at the specified cell. | Grid | ||
|
Returns the element's layout height. | UIComponent | |
|
Returns the element's layout width. | UIComponent | |
|
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
|
Returns the layout transform Matrix3D for this element. | UIComponent | |
|
Returns the element's maximum height. | UIComponent | |
|
Returns the element's maximum width. | UIComponent | |
|
Returns the element's minimum height. | UIComponent | |
|
Returns the element's minimum width. | UIComponent | |
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Returns the element's preferred height. | UIComponent | |
|
Returns the element's preferred width. | UIComponent | |
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | |
|
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
Returns the current pixel bounds of the specified row, or null if no such row exists. | Grid | ||
Returns the row index corresponding to the specified coordinates,
or -1 if the coordinates are out of bounds. | Grid | ||
|
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
|
Returns the change to the vertical scroll position to handle
different scrolling options. | GroupBase | |
|
Layouts that honor the useVirtualLayout flag will use this
method at updateDisplayList() time to get layout elements that are "in view",
i.e. | GroupBase | |
Return the indices of the currently visible columns. | Grid | ||
Return the data provider indices and padding indices of the
currently visible rows. | Grid | ||
|
Converts a Point object from global to content coordinates. | UIComponent | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
|
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | |
|
Returns true if currentCSSState is not null. | UIComponent | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
|
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
Initializes the internal structure of this component. | UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
If the specified cell is visible, it is redisplayed. | Grid | ||
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
Notify the host component that an element has changed and needs to be redrawn. | Group | |
|
Notify the host component that an element changed and needs to validate properties. | Group | |
|
Notify the host that an element layer has changed. | Group | |
|
Notify the host component that an element size has changed. | Group | |
|
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
|
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
Clears cached column width data that had been based on the
typicalItem property, and requests a new layout pass. | Grid | ||
Returns true if the specified cell is at least partially visible. | Grid | ||
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | |
|
Converts a Point object from local to content coordinates. | UIComponent | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Returns true if cssState matches currentCSSState. | UIComponent | |
|
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
|
Measures the specified HTML text, which can contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Measures the specified text, assuming that it is displayed
in a single-line UITextField (or UIFTETextField) using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Moves the component to a specified position within its parent. | UIComponent | |
|
Propagates style changes to the children. | UIComponent | |
|
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
|
Prepares an IFlexDisplayObject for printing. | UIComponent | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
|
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
|
Removes all visual elements from the container. | Group | |
|
Removes one or more child DisplayObject instances from the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes the specified visual element from the child list of
this container. | Group | |
|
Removes a visual element from the specified index position
in the container. | Group | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
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 | ||
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 | ||
|
Removes a non-visual style client from this component instance. | UIComponent | |
|
Replays the specified event. | UIComponent | |
|
Raises a virtual keyboard. | InteractiveObject | |
|
Resolves a child by using the id provided. | UIComponent | |
| [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
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 | ||
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 | ||
If selectionMode is GridSelectionMode.MULTIPLE_ROWS,
sets the selection to the specfied rows and the caret position to
endRowIndex. | Grid | ||
If selectionMode is GridSelectionMode.SINGLE_CELL
or GridSelectionMode.MULTIPLE_CELLS, returns true
if the cell is in the current selection. | Grid | ||
If selectionMode is
GridSelectionMode.MULTIPLE_CELLS, returns true
if the cells in the cell region are in the current selection. | Grid | ||
If selectionMode is GridSelectionMode.SINGLE_ROW
or GridSelectionMode.MULTIPLE_ROWS, returns true
if the row at index is in the current selection. | Grid | ||
If selectionMode is
GridSelectionMode.MULTIPLE_ROWS, returns true
if the rows in indices are in the current selection. | Grid | ||
|
Sizes the object. | UIComponent | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
|
Sets the contentWidth and contentHeight
properties. | GroupBase | |
|
Set the current state. | UIComponent | |
|
Changes the position of an existing visual element in the visual container. | Group | |
|
Sets the focus to this component. | UIComponent | |
|
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
|
Sets the layout size of the element. | UIComponent | |
|
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
If selectionMode
is GridSelectionMode.SINGLE_CELL or
GridSelectionMode.MULTIPLE_CELLS, sets the selection
and the caret position to this cell. | Grid | ||
If selectionMode
is GridSelectionMode.SINGLE_ROW or
GridSelectionMode.MULTIPLE_ROWS, sets the selection and
the caret position to this row. | Grid | ||
|
Sets a style property on this component instance. | UIComponent | |
|
Called when the visible property changes. | UIComponent | |
|
Lets the user drag the specified sprite. | Sprite | |
|
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | |
|
Ends the startDrag() method. | Sprite | |
|
Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite | |
|
Detects changes to style properties. | UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Swaps the index of the two specified visual elements. | Group | |
|
Swaps the visual elements at the two specified index
positions in the container. | Group | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | |
|
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | |
|
Validates the position and size of children and draws other
visuals. | UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
|
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
|
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
Returns the primitive value of the specified object. | Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. | UIComponent | ||
| Dispatched when a display object is added to the display list. | DisplayObject | ||
| Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained. | DisplayObject | ||
| Dispatched after the caret changes. | Grid | |||
| Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu. | InteractiveObject | ||
| Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application. | InteractiveObject | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu. | InteractiveObject | ||
| Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | ||
| Dispatched after the view state has changed. | UIComponent | ||
| Dispatched after the currentState property changes, but before the view state changes. | UIComponent | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu. | InteractiveObject | ||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true. | InteractiveObject | ||
| Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent | ||
| Dispatched by the drop target when the user releases the mouse over it. | UIComponent | ||
| Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | ||
| Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | ||
| Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | ||
| Dispatched by the drag initiator when starting a drag operation. | UIComponent | ||
| Dispatched after an effect ends. | UIComponent | ||
| Dispatched just before an effect starts. | UIComponent | ||
| Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent | ||
| Dispatched when a visual element is added to the content holder. | Group | ||
| Dispatched when a visual element is removed from the content holder. | Group | ||
| [broadcast event] Dispatched when the playhead is entering a new frame. | DisplayObject | ||
| Dispatched after the component has entered a view state. | UIComponent | ||
| [broadcast event] Dispatched when the playhead is exiting the current frame. | DisplayObject | ||
| Dispatched just before the component exits a view state. | UIComponent | ||
| Dispatched after a display object gains focus. | InteractiveObject | ||
| Dispatched after a display object loses focus. | InteractiveObject | ||
| [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run. | DisplayObject | ||
| Dispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a finger from left to right over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the mouse is clicked over a cell | Grid | |||
| Dispatched when the mouse is double-clicked over a cell | Grid | |||
| Dispatched when the mouse button is pressed over a Grid cell. | Grid | |||
| Dispatched after a gridMouseDown event if the mouse moves before the button is released. | Grid | |||
| Dispatched when the mouse button is released over a Grid cell. | Grid | |||
| Dispatched when the mouse leaves a grid cell. | Grid | |||
| Dispatched when the mouse enters a grid cell. | Grid | |||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| This event is dispatched to any client app that supports inline input with an IME | InteractiveObject | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched when the user presses a key. | InteractiveObject | ||
| Dispatched when the user attempts to change focus by using keyboard navigation. | InteractiveObject | ||
| Dispatched when the user releases a key. | InteractiveObject | ||
| Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the middle pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| Dispatched when the user attempts to change focus by using a pointer device. | InteractiveObject | ||
| Dispatched when a user moves the pointing device while it is over an InteractiveObject. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a mouse wheel is spun over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | ||
| Dispatched when the object has moved. | UIComponent | ||
| Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture. | InteractiveObject | ||
| Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop(). | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture enters its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture leaves its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary. | InteractiveObject | ||
| Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu. | InteractiveObject | ||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
| Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold. | InteractiveObject | ||
| Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus away from this InteractiveObject and any of its children while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus over this InteractiveObject from outside the object's tree of descendents in the display list (while remaining within the proximity detection threshold of the screen). | InteractiveObject | ||
| Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent | ||
| Dispatched when a display object is about to be removed from the display list. | DisplayObject | ||
| Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained. | DisplayObject | ||
| [broadcast event] Dispatched when the display list is about to be updated and rendered. | DisplayObject | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu. | InteractiveObject | ||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched immediately after the soft keyboard is raised. | InteractiveObject | ||
| Dispatched immediately before the soft keyboard is raised. | InteractiveObject | ||
| Dispatched immediately after the soft keyboard is lowered. | InteractiveObject | ||
| Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. | UIComponent | ||
| Dispatched when a component interrupts a transition to its current state in order to switch to a new state. | UIComponent | ||
| Dispatched when the value of the object's tabChildren flag changes. | InteractiveObject | ||
| Dispatched when the object's tabEnabled flag changes. | InteractiveObject | ||
| Dispatched when the value of the object's tabIndex property changes. | InteractiveObject | ||
| Dispatched when a user enters one or more characters of text. | InteractiveObject | ||
| Dispatched by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and is to be discarded soon. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be shown. | UIComponent | ||
| Dispatched by the component when its ToolTip has been shown. | UIComponent | ||
| Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent | ||
| Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture. | UIComponent | ||
| A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture. | UIComponent | ||
| A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture. | UIComponent | ||
| Dispatched when the user moves the point of contact with a touch-enabled device (such as drags a finger across a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | ||
| Dispatched when values are changed programmatically or by user interaction. | UIComponent | ||
Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.
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. When this property is modified, it dispatches the anchorColumnIndexChanged event.
Implementation
public function get anchorColumnIndex():int public function set anchorColumnIndex(value:int):voidRelated API Elements
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. When this property is modified, it dispatches the anchorRowIndexChanged event.
Implementation
public function get anchorRowIndex():int public function set anchorRowIndex(value:int):voidRelated API Elements
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. When this property is modified, it dispatches the caretColumnIndexChanged event.
Implementation
public function get caretColumnIndex():int public function set caretColumnIndex(value:int):voidcaretIndicator | 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 displayted for the caret cell.
The default value is null.
This property can be used as the source for data binding. When this property is modified, it dispatches the caretIndicatorChanged event.
Implementation
public function get caretIndicator():IFactory public function set caretIndicator(value:IFactory):voidcaretRowIndex | 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. When this property is modified, it dispatches the caretRowIndexChanged event.
Implementation
public function get caretRowIndex():int public function set caretRowIndex(value:int):voidcolumns | 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. When this property is modified, it dispatches the columnsChanged event.
Implementation
public function get columns():IList public function set columns(value:IList):voidRelated API Elements
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. When this property is modified, it dispatches the columnSeparatorChanged event.
Implementation
public function get columnSeparator():IFactory public function set columnSeparator(value:IFactory):voiddataGrid | 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. When this property is modified, it dispatches the dataGridChanged event.
Implementation
public function get dataGrid():DataGrid public function set dataGrid(value:DataGrid):voiddataProvider | 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. When this property is modified, it dispatches the dataProviderChanged event.
Implementation
public function get dataProvider():IList public function set dataProvider(value:IList):voidRelated API Elements
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. When this property is modified, it dispatches the dataTipFieldChanged event.
Implementation
public function get dataTipField():String public function set dataTipField(value:String):voiddataTipFunction | 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):StringThe
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. When this property is modified, it dispatches the dataTipFunctionChanged event.
Implementation
public function get dataTipFunction():Function public function set dataTipFunction(value:Function):voidhoverColumnIndex | 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. When this property is modified, it dispatches the hoverColumnIndexChanged event.
Implementation
public function get hoverColumnIndex():int public function set hoverColumnIndex(value:int):voidhoverIndicator | 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. When this property is modified, it dispatches the hoverIndicatorChanged event.
Implementation
public function get hoverIndicator():IFactory public function set hoverIndicator(value:IFactory):voidhoverRowIndex | 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. When this property is modified, it dispatches the hoverRowIndexChanged event.
Implementation
public function get hoverRowIndex():int public function set hoverRowIndex(value:int):voiditemRenderer | 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. When this property is modified, it dispatches the itemRendererChanged event.
Implementation
public function get itemRenderer():IFactory public function set itemRenderer(value:IFactory):voidpreserveSelection | 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):voidrequestedColumnCount | 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):voidrequestedMaxRowCount | 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;
requestedRowCountis 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):voidrequestedMinColumnCount | 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;
requestedColumnCountis 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):voidrequestedMinRowCount | 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;
requestedRowCountis 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):voidrequestedRowCount | 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):voidrequireSelection | 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):voidresizableColumns | 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. When this property is modified, it dispatches the resizableColumnsChanged event.
Implementation
public function get resizableColumns():Boolean public function set resizableColumns(value:Boolean):voidRelated API Elements
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. When this property is modified, it dispatches the rowBackgroundChanged event.
Implementation
public function get rowBackground():IFactory public function set rowBackground(value:IFactory):voidrowHeight | 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. When this property is modified, it dispatches the rowHeightChanged event.
Implementation
public function get rowHeight():Number public function set rowHeight(value:Number):voidrowSeparator | 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. When this property is modified, it dispatches the rowSeparatorChanged event.
Implementation
public function get rowSeparator():IFactory public function set rowSeparator(value:IFactory):voidselectedCell | 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 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. When this property is modified, it dispatches the valueCommit event.
Implementation
public function get selectedCell():CellPosition public function set selectedCell(value:CellPosition):voidselectedCells | 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 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. When this property is modified, it dispatches the valueCommit event.
Implementation
public function get selectedCells():Vector.<CellPosition> public function set selectedCells(value:Vector.<CellPosition>):voidselectedIndex | 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 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. When this property is modified, it dispatches the valueCommit event.
Implementation
public function get selectedIndex():int public function set selectedIndex(value:int):voidselectedIndices | 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 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. When this property is modified, it dispatches the valueCommit event.
Implementation
public function get selectedIndices():Vector.<int> public function set selectedIndices(value:Vector.<int>):voidRelated API Elements
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 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. When this property is modified, it dispatches the valueCommit event.
Implementation
public function get selectedItem():Object public function set selectedItem(value:Object):voidRelated API Elements
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 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. When this property is modified, it dispatches the valueCommit event.
Implementation
public function get selectedItems():Vector.<Object> public function set selectedItems(value:Vector.<Object>):voidRelated API Elements
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. When this property is modified, it dispatches the selectionIndicatorChanged event.
Implementation
public function get selectionIndicator():IFactory public function set selectionIndicator(value:IFactory):voidselectionLength | 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. When this property is modified, it dispatches the valueCommit event.
Implementation
public function get selectionLength():intselectionMode | 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. When this property is modified, it dispatches the selectionModeChanged event.
Implementation
public function get selectionMode():String public function set selectionMode(value:String):voidRelated API Elements
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. When this property is modified, it dispatches the showDataTipsChanged event.
Implementation
public function get showDataTips():Boolean public function set showDataTips(value:Boolean):voidtypicalItem | 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 is 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. When this property is modified, it dispatches the typicalItemChanged event.
Implementation
public function get typicalItem():Object public function set typicalItem(value:Object):voidvariableRowHeight | 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. When this property is modified, it dispatches the variableRowHeightChanged event.
Implementation
public function get variableRowHeight():Boolean public function set variableRowHeight(value:Boolean):voidGrid | () | Constructor |
public function Grid()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
Constructor.
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.
|
Boolean — true if no errors.
false if rowIndex
or columnIndex is invalid, or the selectionMode
is invalid.
|
Related API Elements
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.
|
Boolean — true if no errors.
false if index is invalid or
the selectionMode is invalid.
|
Related API Elements
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.
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) | |
columnIndex:int (default = -1) |
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.
|
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' typicalItems.
Parameters
rowIndex:int — The 0-based index of the row.
| |
columnIndex:int — The 0-based index of the column.
|
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.
|
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' typicalItems.
Parameters
rowIndex:int — The 0-based index of the row.
| |
columnIndex:int — The 0-based index of the column.
|
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' typicalItems.
Parameters
rowIndex:int — The 0-based index of the row.
| |
columnIndex:int — The 0-based index of the column.
|
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.
|
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 coordinates, or -1 if the coordinates are out of bounds. The coordinates are resolved with respect to the grid.
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' typicalItems.
Parameters
x:Number — The pixel's x coordinate relative to the grid.
| |
y:Number — The pixel's y coordinate relative to the grid.
|
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.
|
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.
|
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' typicalItems.
Parameters
rowIndex:int — The 0-based index of the row.
|
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 coordinates, or -1 if the coordinates are out of bounds. The coordinates are resolved with respect to the grid.
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' typicalItems.
Parameters
x:Number — The x coordinate.
| |
y:Number — The y coordinate.
|
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;
}
ReturnsVector.<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.
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) | |
columnIndex:int (default = -1) |
Boolean — True if the specified cell (or row if columnIndex == -1) is at least partially visible
|
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.
|
Boolean — true if no errors.
false if rowIndex
or columnIndex is invalid or the selectionMode
is invalid.
|
Related API Elements
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.
|
Boolean — true if no errors.
false if index is invalid or
the selectionMode is invalid.
|
Related API Elements
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 dataProvideris refreshed andpreserveSelectionis falsedataProvideris resetcolumnsis refreshed,preserveSelectionisfalseandselectionModeisGridSelectionMode.MULTIPLE_CELLScolumnsis reset andselectionModeisGridSelectionMode.MULTIPLE_CELLS
Boolean — true if the selection changed.
|
Related API Elements
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.
|
Boolean — true if no errors.
false if the cell region is invalid or
the selectionMode is invalid.
|
Related API Elements
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.
|
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.
|
Related API Elements
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.
|
Boolean — true if the current selection contains the cell.
|
Related API Elements
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.
|
Boolean — true if the current selection contains all
the cells in the cell region.
|
Related API Elements
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.
|
Boolean — true if the selection contains the row.
|
Related API Elements
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.
|
Boolean — true if the current selection contains these rows.
|
Related API Elements
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.
|
Boolean — true if if no errors.
false if rowIndex
or columnIndex is invalid or the selectionMode
is invalid.
|
Related API Elements
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.
|
Boolean — true if if no errors.
false if index is invalid, or
the selectionMode is invalid.
|
Related API Elements
caretChange | Event |
spark.events.GridCaretEventproperty GridCaretEvent.type =
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.
TheGridSelectionEvent.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 |
spark.events.GridEventproperty GridEvent.type =
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 thetype 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 |
spark.events.GridEventproperty GridEvent.type =
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 thetype 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 |
spark.events.GridEventproperty GridEvent.type =
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 thetype 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 |
spark.events.GridEventproperty GridEvent.type =
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.
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 |
spark.events.GridEventproperty GridEvent.type =
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.
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 |
spark.events.GridEventproperty GridEvent.type =
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 thetype 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 |
spark.events.GridEventproperty GridEvent.type =
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 thetype 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 |
Mon Nov 28 2011, 06:48 AM -08:00