Packagespark.events
Classpublic class GridCaretEvent
InheritanceGridCaretEvent Inheritance flash.events.Event

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

The GridCaretEvent class represents events that are dispatched when the caret changes in a Spark DataGrid control as the result of user interaction.

See also

spark.components.DataGrid
spark.components.Grid
spark.components.gridClasses.GridSelectionMode

Public Properties
 PropertyDefined By
  newColumnIndex : int
The zero-based index of the column of the caret position after it was changed.
GridCaretEvent
  newRowIndex : int
The zero-based index of the row of the caret position after it was changed.
GridCaretEvent
  oldColumnIndex : int
The zero-based index of the column of the caret position before it was changed.
GridCaretEvent
  oldRowIndex : int
The zero-based index of the row of the caret position before it was changed.
GridCaretEvent
Public Methods
 MethodDefined By
  
GridCaretEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, oldRowIndex:int = -1, oldColumnIndex:int = -1, newRowIndex:int = -1, newColumnIndex:int = -1)
Constructor.
GridCaretEvent
Public Constants
 ConstantDefined By
  CARET_CHANGE : String = caretChange
[static] The GridSelectionEvent.CARET_CHANGE constant defines the value of the type property of the event object for a caretChange event, which indicates that the current caret position has just been changed.
GridCaretEvent
Property Detail
newColumnIndexproperty
public var newColumnIndex:int

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

The zero-based index of the column of the caret position after it was changed.

If the selectionMode is SelectionMode.SINGLE_ROW or SelectionMode.MULTIPLE_ROWS this will be -1 to indicate it is not being used.

See also

spark.components.DataGrid.columns
spark.components.Grid.columns
newRowIndexproperty 
public var newRowIndex:int

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

The zero-based index of the row of the caret position after it was changed.

See also

spark.components.DataGrid.dataProvider
spark.components.Grid.dataProvider
oldColumnIndexproperty 
public var oldColumnIndex:int

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

The zero-based index of the column of the caret position before it was changed.

If the selectionMode is SelectionMode.SINGLE_ROW or SelectionMode.MULTIPLE_ROWS, this valueis -1 to indicate it is not being used.

See also

spark.components.DataGrid.columns
spark.components.Grid.columns
oldRowIndexproperty 
public var oldRowIndex:int

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

The zero-based index of the row of the caret position before it was changed.

The default value is -1.

See also

spark.components.DataGrid.dataProvider
spark.components.Grid.dataProvider
Constructor Detail
GridCaretEvent()Constructor
public function GridCaretEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, oldRowIndex:int = -1, oldColumnIndex:int = -1, newRowIndex:int = -1, newColumnIndex:int = -1)

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

Constructor.

Parameters
type:String — The event type; indicates the action that caused the event.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Specifies whether the behavior associated with the event can be prevented.
 
oldRowIndex:int (default = -1) — The zero-based column index of the caret position before the change. If the selectionMode is either SelectionMode.SINGLE_ROW or SelectionMode.MULTIPLE_ROWS, this is -1.
 
oldColumnIndex:int (default = -1) — The zero-based row index of the caret position before the change.
 
newRowIndex:int (default = -1) — The zero-based column index of the caret position after the change. If the selectionMode is either SelectionMode.SINGLE_ROW or SelectionMode.MULTIPLE_ROWS, this is -1.
 
newColumnIndex:int (default = -1) — The zero-based row index of the caret position after the change.

See also

spark.components.DataGrid.columns
spark.components.DataGrid.dataProvider
Constant Detail
CARET_CHANGEConstant
public static const CARET_CHANGE:String = caretChange

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

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

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
newColumnIndexThe zero-based column index of the caret position after it was changed. It is -1 if the selectionMode is row-based.
newRowIndexThe zero-based row index of the caret position after it was changed.
oldColumnIndexThe zero-based column index of the caret position before it was changed. It is -1 if the selectionMode is row-based.
oldRowIndexThe zero-based row index of the caret position before it was changed.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeGirdCaretEvent.CARET_CHANGE




The Apache Software Foundation

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