(Preview)
| Package | spark.events |
| Class | public class GridCaretEvent |
| Inheritance | GridCaretEvent  Event Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
Related API Elements
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | bubbles : Boolean [read-only]
Indicates whether an event is a bubbling event. | Event | |
| cancelable : Boolean [read-only]
Indicates whether the behavior associated with the event can be prevented. | Event | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| currentTarget : Object [read-only]
The object that is actively processing the Event object with an event listener. | Event | |
| eventPhase : uint [read-only]
The current phase in the event flow. | Event | |
| 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 | ||
| target : Object [read-only]
The event target. | Event | |
| type : String [read-only]
The type of event. | Event | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
GridCaretEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, oldRowIndex:int = -1, oldColumnIndex:int = -1, newRowIndex:int = -1, newColumnIndex:int = -1)
Constructor. | GridCaretEvent | ||
|
Duplicates an instance of an Event subclass. | Event | |
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns a string containing all the properties of the Event object. | Event | |
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined 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
newColumnIndex | property |
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.
Related API Elements
newRowIndex | property |
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.
Related API Elements
oldColumnIndex | property |
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.
Related API Elements
oldRowIndex | property |
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.
Related API Elements
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.
Parameterstype:String — The event type; indicates the action that caused the event.
| |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = false) | |
oldRowIndex:int (default = -1)selectionMode is either
SelectionMode.SINGLE_ROW or
SelectionMode.MULTIPLE_ROWS, this is -1.
| |
oldColumnIndex:int (default = -1) | |
newRowIndex:int (default = -1)selectionMode is either
SelectionMode.SINGLE_ROW or
SelectionMode.MULTIPLE_ROWS, this is -1.
| |
newColumnIndex:int (default = -1) |
Related API Elements
Constant Detail
CARET_CHANGE | Constant |
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:
| 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 |
Wed Nov 21 2018, 06:34 AM -08:00