| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!-- saved from url=(0014)about:internet --><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><link rel="stylesheet" href="../../style.css" type="text/css" media="screen"><link rel="stylesheet" href="../../print.css" type="text/css" media="print"><link rel="stylesheet" href="../../override.css" type="text/css"><meta name="keywords" content="GridCaretEvent,spark.events.GridCaretEvent,ADD_CELL,ADD_ROW,CARET_CHANGE,CARET_CHANGE,CHANGE,CHANGE,CHANGING,CHANGING,CHECKED,CHOOSE,CLEAR_SELECTION,CLOSE,CLOSE,ELEMENT_ADD,ELEMENT_REMOVE,GRID_CLICK,GRID_DOUBLE_CLICK,GRID_ITEM_EDITOR_SESSION_CANCEL,GRID_ITEM_EDITOR_SESSION_SAVE,GRID_ITEM_EDITOR_SESSION_START,GRID_ITEM_EDITOR_SESSION_STARTING,GRID_MOUSE_DOWN,GRID_MOUSE_DRAG,GRID_MOUSE_UP,GRID_ROLL_OUT,GRID_ROLL_OVER,HOVER,INVALIDATE_LOADER,ITEM_ROLL_OUT,ITEM_ROLL_OVER,NO_COLOR,OPEN,OPEN,REMOVE_CELL,REMOVE_ROW,REMOVING,RENDERER_ADD,RENDERER_REMOVE,SELECTED,SELECTION_CHANGE,SELECTION_CHANGING,SELECT_ALL,SEPARATOR_CLICK,SEPARATOR_DOUBLE_CLICK,SEPARATOR_MOUSE_DOWN,SEPARATOR_MOUSE_DRAG,SEPARATOR_MOUSE_UP,SEPARATOR_ROLL_OUT,SEPARATOR_ROLL_OVER,SET_CELL,SET_CELL_REGION,SET_ROW,SET_ROWS,SORT_CHANGE,SORT_CHANGE,SORT_CHANGING,THUMB_DRAG,THUMB_PRESS,THUMB_RELEASE,VIEW_ACTIVATE,VIEW_DEACTIVATE,WINDOW_MOVE,WINDOW_MOVE_END,WINDOW_MOVE_START,WINDOW_MOVING,action,afterBounds,beforeBounds,color,colorObject,column,column,columnIndex,columnIndex,columnIndex,columnIndices,commit,content,data,data,element,grid,index,index,item,item,item,itemIndex,itemRenderer,itemRenderer,kind,menu,newColumnIndex,newIndex,newRowIndex,newSortFields,oldColumnIndex,oldIndex,oldRowIndex,oldSortFields,operation,renderer,rowIndex,rowIndex,selectionChange,triggerEvent"><title>spark.events.GridCaretEvent</title></head><body><script language="javascript" type="text/javascript" src="../../asdoc.js"></script><script language="javascript" type="text/javascript" src="../../help.js"></script><script language="javascript" type="text/javascript" src="../../cookies.js"></script><script language="javascript" type="text/javascript"><!-- |
| asdocTitle = 'GridCaretEvent - ApacheFlex API Reference'; |
| var baseRef = '../../'; |
| window.onload = configPage; |
| --></script> |
| <script type="text/javascript"> |
| scrollToNameAnchor(); |
| </script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">Apache Flex 4.16.1 API Reference </td><td class="titleTableTopNav" align="right"><a href="../../package-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Packages</a> | <a href="../../class-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Classes</a> | <a href="../../all-index-A.html" onclick="loadClassListFrame('../../index-list.html')">Index</a> | <a id="framesLink1" href="../../index.html?spark/events/GridCaretEvent.html&spark/events/class-list.html">Frames</a><a id="noFramesLink1" style="display:none" href="" onclick="parent.location=document.location"> No Frames </a></td><td class="titleTableLogo" align="right" rowspan="3"><img src="../../images/logo.jpg" class="logoImage" alt="AdobeLogo" title="AdobeLogo"></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">GridCaretEvent</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a> | <a href="#constantSummary">Constants</a></td></tr><tr class="titleTableRow3"><td colspan="3"> </td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve"> |
| <!-- |
| |
| if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("GridCaretEvent"); titleBar_setSubNav(true,true,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);} |
| --> |
| </script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">spark.events</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class GridCaretEvent</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">GridCaretEvent <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> flash.events.Event</td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 2.5</td></tr></table><p></p><p></p><p></p><p></p> |
| The GridCaretEvent class represents events that are dispatched when |
| the caret changes in a Spark DataGrid control as the result of |
| user interaction. |
| <p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="../../spark/components/DataGrid.html" target="">spark.components.DataGrid</a><br/><a href="../../spark/components/Grid.html" target="">spark.components.Grid</a><br/><a href="../../spark/components/gridClasses/GridSelectionMode.html" target="">spark.components.gridClasses.GridSelectionMode</a></div><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProperty"><tr><th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#newColumnIndex" class="signatureLink">newColumnIndex</a> : int<div class="summaryTableDescription"> |
| The zero-based index of the column of the |
| caret position after it was changed.</div></td><td class="summaryTableOwnerCol">GridCaretEvent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#newRowIndex" class="signatureLink">newRowIndex</a> : int<div class="summaryTableDescription"> |
| The zero-based index of the row of the |
| caret position after it was changed.</div></td><td class="summaryTableOwnerCol">GridCaretEvent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#oldColumnIndex" class="signatureLink">oldColumnIndex</a> : int<div class="summaryTableDescription"> |
| The zero-based index of the column of the |
| caret position before it was changed.</div></td><td class="summaryTableOwnerCol">GridCaretEvent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#oldRowIndex" class="signatureLink">oldRowIndex</a> : int<div class="summaryTableDescription"> |
| The zero-based index of the row of the |
| caret position before it was changed.</div></td><td class="summaryTableOwnerCol">GridCaretEvent</td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#GridCaretEvent()" class="signatureLink">GridCaretEvent</a>(type:String, bubbles:Boolean = false, cancelable:Boolean = false, oldRowIndex:int = -1, oldColumnIndex:int = -1, newRowIndex:int = -1, newColumnIndex:int = -1)</div><div class="summaryTableDescription"> |
| Constructor.</div></td><td class="summaryTableOwnerCol">GridCaretEvent</td></tr></table></div><a name="constantSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Constants</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableConstant"><tr><th> </th><th colspan="2">Constant</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#CARET_CHANGE" class="signatureLink">CARET_CHANGE</a> : String = caretChange<div class="summaryTableDescription">[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.</div></td><td class="summaryTableOwnerCol">GridCaretEvent</td></tr></table></div><script language="javascript" type="text/javascript"><!-- |
| showHideInherited(); |
| --></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</div><a name="propertyDetail"></a><a name="newColumnIndex"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">newColumnIndex</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>public var newColumnIndex:int</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 2.5</td></tr></table><p></p><p></p><p> |
| The zero-based index of the column of the |
| caret position after it was changed. |
| |
| <p>If the <code>selectionMode</code> is <code>SelectionMode.SINGLE_ROW</code> or |
| <code>SelectionMode.MULTIPLE_ROWS</code> this will be -1 to indicate |
| it is not being used.</p> |
| |
| </p><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../spark/components/DataGrid.html#columns" target="">spark.components.DataGrid.columns</a><br/><a href="../../spark/components/Grid.html#columns" target="">spark.components.Grid.columns</a></div></div><a name="propertyDetail"></a><a name="newRowIndex"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">newRowIndex</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var newRowIndex:int</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 2.5</td></tr></table><p></p><p></p><p> |
| The zero-based index of the row of the |
| caret position after it was changed. |
| |
| </p><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../spark/components/DataGrid.html#dataProvider" target="">spark.components.DataGrid.dataProvider</a><br/><a href="../../spark/components/Grid.html#dataProvider" target="">spark.components.Grid.dataProvider</a></div></div><a name="propertyDetail"></a><a name="oldColumnIndex"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">oldColumnIndex</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var oldColumnIndex:int</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 2.5</td></tr></table><p></p><p></p><p> |
| The zero-based index of the column of the |
| caret position before it was changed. |
| |
| <p>If the <code>selectionMode</code> is <code>SelectionMode.SINGLE_ROW</code> or |
| <code>SelectionMode.MULTIPLE_ROWS</code>, this valueis -1 to indicate |
| it is not being used.</p> |
| |
| </p><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../spark/components/DataGrid.html#columns" target="">spark.components.DataGrid.columns</a><br/><a href="../../spark/components/Grid.html#columns" target="">spark.components.Grid.columns</a></div></div><a name="propertyDetail"></a><a name="oldRowIndex"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">oldRowIndex</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var oldRowIndex:int</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 2.5</td></tr></table><p></p><p></p><p> |
| The zero-based index of the row of the |
| caret position before it was changed. |
| |
| </p><p> The default value is <code>-1</code>.</p><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../spark/components/DataGrid.html#dataProvider" target="">spark.components.DataGrid.dataProvider</a><br/><a href="../../spark/components/Grid.html#dataProvider" target="">spark.components.Grid.dataProvider</a></div></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="GridCaretEvent()"></a><a name="GridCaretEvent(String,Boolean,Boolean,int,int,int,int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">GridCaretEvent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function GridCaretEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, oldRowIndex:int = -1, oldColumnIndex:int = -1, newRowIndex:int = -1, newColumnIndex:int = -1)</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 2.5</td></tr></table><p></p><p> |
| Constructor. |
| </p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">type</span>:String</code> — The event type; indicates the action that caused the event. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">bubbles</span>:Boolean</code> (default = <code>false</code>)<code></code> — Specifies whether the event can bubble |
| up the display list hierarchy. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">cancelable</span>:Boolean</code> (default = <code>false</code>)<code></code> — Specifies whether the behavior |
| associated with the event can be prevented. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">oldRowIndex</span>:int</code> (default = <code>-1</code>)<code></code> — The zero-based column index of the caret position |
| before the change. If the <code>selectionMode</code> is either |
| <code>SelectionMode.SINGLE_ROW</code> or |
| <code>SelectionMode.MULTIPLE_ROWS</code>, this is -1. |
| |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">oldColumnIndex</span>:int</code> (default = <code>-1</code>)<code></code> — The zero-based row index of the caret position before |
| the change. |
| |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">newRowIndex</span>:int</code> (default = <code>-1</code>)<code></code> — The zero-based column index of the caret position |
| after the change. If the <code>selectionMode</code> is either |
| <code>SelectionMode.SINGLE_ROW</code> or |
| <code>SelectionMode.MULTIPLE_ROWS</code>, this is -1. |
| |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">newColumnIndex</span>:int</code> (default = <code>-1</code>)<code></code> — The zero-based row index of the caret position after |
| the change. |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../spark/components/DataGrid.html#columns" target="">spark.components.DataGrid.columns</a><br/><a href="../../spark/components/DataGrid.html#dataProvider" target="">spark.components.DataGrid.dataProvider</a></div></div><div class="detailSectionHeader">Constant Detail</div><a name="constantDetail"></a><a name="CARET_CHANGE"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">CARET_CHANGE</td><td class="detailHeaderType">Constant</td></tr></table><div class="detailBody"><code>public static const CARET_CHANGE:String = caretChange</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 2.5</td></tr></table><p></p><p></p><p> |
| The <code>GridSelectionEvent.CARET_CHANGE</code> constant defines |
| the value of the <code>type</code> property of the event object for a |
| <code>caretChange</code> event, which indicates that the current |
| caret position has just been changed. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>newColumnIndex</code></td><td>The zero-based column |
| index of the caret position after it was changed. It is -1 if |
| the <code>selectionMode</code> is row-based.</td></tr><tr><td><code>newRowIndex</code></td><td>The zero-based row index |
| of the caret position after it was changed.</td></tr><tr><td><code>oldColumnIndex</code></td><td>The zero-based column |
| index of the caret position before it was changed. It is -1 if |
| the <code>selectionMode</code> is row-based.</td></tr><tr><td><code>oldRowIndex</code></td><td>The zero-based row index |
| of the caret position before it was changed.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr><tr><td><code>type</code></td><td>GirdCaretEvent.CARET_CHANGE</td></tr></table> |
| |
| </p></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>The Apache Software Foundation</footer><br/>Wed Nov 15 2017, 09:50 AM +01:00 </center></div></body></html><!--The Apache Software Foundation<br/>Wed Nov 15 2017, 09:50 AM +01:00 --> |
