student-ar-fl-events-DataGridEvent.ax [swf] flex
The @ax-student-ar-fl-events-DataGridEvent class defines events that are associated with the DataGrid component. These include the following events: <ul> <li><code>@ax-student-ar-fl-events-DataGridEvent.COLUMN_STRETCH</code>: dispatched after a user resizes a column horizontally.</li> <li><code>@ax-student-ar-fl-events-DataGridEvent.HEADER_RELEASE</code>: dispatched after the user presses and releases the mouse on a column header.</li> <li><code>@ax-student-ar-fl-events-DataGridEvent.ITEM_EDIT_BEGIN</code>: dispatched when an item is ready to be edited.</li> <li><code>@ax-student-ar-fl-events-DataGridEvent.ITEM_EDIT_BEGINNING</code>: dispatched after the user is prepared to edit an item; this is indicated, for example, by the user releasing the mouse button when the mouse is over the item.</li> <li><code>@ax-student-ar-fl-events-DataGridEvent.ITEM_EDIT_END</code>: dispatched when an edit session is ending.</li> <li><code>@ax-student-ar-fl-events-DataGridEvent.ITEM_FOCUS_IN</code>: dispatched after an item receives focus.</li> <li><code>@ax-student-ar-fl-events-DataGridEvent.ITEM_FOCUS_OUT</code>: dispatched after an item loses focus.</li> </ul>
see: fl.controls.DataGrid
see: @fileReason @includeExample examples/@fileExample.as @langversion 3.0 @playerversion Flash 9.0.28.0
The <code>@ax-student-ar-fl-events-DataGridEvent.COLUMN_STRETCH</code> constant defines the value of the <code>type</code> property of a <code>columnStretch</code> event object. <p>This event has the following properties:</p> <table class="innertable" width="100%"> <tr><th>Property</th><th>Value</th></tr> <tr><td><code>bubbles</code></td><td><code>false</code></td></tr> <tr><td><code>cancelable</code></td><td><code>false</code>; there is no default behavior to cancel.</td></tr> <tr><td><code>columnIndex</code></td><td>The zero-based index of the header column in the <code>columns</code> array of the DataGrid object.</td></tr> <tr><td><code>currentTarget</code></td><td>The object that is actively processing the event object with an event listener. </td></tr> <tr><td><code>dataField</code></td><td>The name of the field or property in the data associated with the column of the item.</td></tr> <tr><td><code>itemRenderer</code></td><td>The header renderer for the column that was stretched.</td></tr> <tr><td><code>reason</code></td><td><code>null</code></td></tr> <tr><td><code>rowIndex</code></td><td>The zero-based index of the item in the data provider.</td></tr> <tr><td><code>target</code></td><td>The object that dispatched the event. The target is not always the object listening for the event. Use the <code>currentTarget</code> property to access the object that is listening for the event.</td></tr> </table> @includeExample ../controls/examples/DataGrid.columnStretch.1.as -noswf @eventType columnStretch @langversion 3.0 @playerversion Flash 9.0.28.0
The <code>@ax-student-ar-fl-events-DataGridEvent.HEADER_RELEASE</code> constant defines the value of the <code>type</code> property of a <code>headerRelease</code> event object. <p>This event has the following properties:</p> <table class="innertable" width="100%"> <tr><th>Property</th><th>Value</th></tr> <tr><td><code>bubbles</code></td><td><code>false</code></td></tr> <tr><td><code>cancelable</code></td><td><code>false</code>; there is no default behavior to cancel.</td></tr> <tr><td><code>columnIndex</code></td><td>The zero-based index of the header column in the <code>columns</code> array of the DataGrid object.</td></tr> <tr><td><code>currentTarget</code></td><td>The object that is actively processing the event object with an event listener. </td></tr> <tr><td><code>dataField</code></td><td>The name of the field or property in the data associated with the column of the item.</td></tr> <tr><td><code>itemRenderer</code></td><td>The header renderer that was clicked.</td></tr> <tr><td><code>reason</code></td><td><code>null</code></td></tr> <tr><td><code>rowIndex</code></td><td><code>-1</code></td></tr> <tr><td><code>target</code></td><td>The object that dispatched the event. The target is not always the object listening for the event. Use the <code>currentTarget</code> property to access the object that is listening for the event.</td></tr> </table> @includeExample ../controls/examples/DataGrid.headerRelease.1.as -noswf @eventType headerRelease @langversion 3.0 @playerversion Flash 9.0.28.0
The <code>@ax-student-ar-fl-events-DataGridEvent.ITEM__EDIT_BEGINNING</code> constant defines the value of the <code>type</code> property of an <code>itemEditBeginning</code> event object. <p>This event has the following properties:</p> <table class="innertable" width="100%"> <tr><th>Property</th><th>Value</th></tr> <tr><td><code>bubbles</code></td><td><code>false</code></td></tr> <tr><td><code>cancelable</code></td><td><code>false</code>; there is no default behavior to cancel.</td></tr> <tr><td><code>columnIndex</code></td><td>The zero-based index of the header column in the <code>columns</code> array of the DataGrid object.</td></tr> <tr><td><code>currentTarget</code></td><td>The object that is actively processing the event object with an event listener. </td></tr> <tr><td><code>dataField</code></td><td>The name of the field or property in the data associated with the column of the item.</td></tr> <tr><td><code>itemRenderer</code></td><td>The item renderer for the item to be edited.</td></tr> <tr><td><code>reason</code></td><td><code>null</code></td></tr> <tr><td><code>rowIndex</code></td><td>The zero-based index of the item in the data provider.</td></tr> <tr><td><code>target</code></td><td>The object that dispatched the event. The target is not always the object listening for the event. Use the <code>currentTarget</code> property to access the object that is listening for the event.</td></tr> </table> @eventType itemEditBeginning
see: #ITEM_EDIT_BEGIN
see: #ITEM_EDIT_END @langversion 3.0 @playerversion Flash 9.0.28.0
The <code>@ax-student-ar-fl-events-DataGridEvent.ITEM_EDIT_BEGIN</code> constant defines the value of the <code>type</code> property of an <code>itemEditBegin</code> event object. <p>This event has the following properties:</p> <table class="innertable" width="100%"> <tr><th>Property</th><th>Value</th></tr> <tr><td><code>bubbles</code></td><td><code>false</code></td></tr> <tr><td><code>cancelable</code></td><td><code>false</code>; there is no default behavior to cancel.</td></tr> <tr><td><code>columnIndex</code></td><td>The zero-based index of the header column in the <code>columns</code> array of the DataGrid object.</td></tr> <tr><td><code>currentTarget</code></td><td>The object that is actively processing the event object with an event listener. </td></tr> <tr><td><code>dataField</code></td><td><code>null</code></td></tr> <tr><td><code>itemRenderer</code></td><td>The item renderer for the item to be edited.</td></tr> <tr><td><code>reason</code></td><td><code>null</code></td></tr> <tr><td><code>rowIndex</code></td><td>The zero-based index of the item in the data provider.</td></tr> <tr><td><code>target</code></td><td>The object that dispatched the event. The target is not always the object listening for the event. Use the <code>currentTarget</code> property to access the object that is listening for the event.</td></tr> </table> @eventType itemEditBegin
see: #ITEM_EDIT_BEGINNING
see: #ITEM_EDIT_END @langversion 3.0 @playerversion Flash 9.0.28.0
The <code>@ax-student-ar-fl-events-DataGridEvent.ITEM_EDIT_END</code> constant defines the value of the <code>type</code> property of an <code>itemEditEnd</code> event object. <p>This event has the following properties:</p> <table class="innertable" width="100%"> <tr><th>Property</th><th>Value</th></tr> <tr><td><code>bubbles</code></td><td><code>false</code></td></tr> <tr><td><code>cancelable</code></td><td><code>false</code>; there is no default behavior to cancel.</td></tr> <tr><td><code>columnIndex</code></td><td>The zero-based index of the header column in the <code>columns</code> array of the DataGrid object.</td></tr> <tr><td><code>currentTarget</code></td><td>The object that is actively processing the event object with an event listener. </td></tr> <tr><td><code>dataField</code></td><td>The name of the field or property in the data associated with the column of the item.</td></tr> <tr><td><code>itemRenderer</code></td><td>The item renderer for the item to be edited.</td></tr> <tr><td><code>reason</code></td><td>A constant defining the reason for the event. The value must be a member of the <code>@fileReason</code> class.</td></tr> <tr><td><code>rowIndex</code></td><td>The zero-based index of the item in the data provider.</td></tr> <tr><td><code>target</code></td><td>The object that dispatched the event. The target is not always the object listening for the event. Use the <code>currentTarget</code> property to access the object that is listening for the event.</td></tr> </table> @eventType itemEditEnd
see: #ITEM_EDIT_BEGIN
see: #ITEM_EDIT_BEGINNING @langversion 3.0 @playerversion Flash 9.0.28.0
The <code>@ax-student-ar-fl-events-DataGridEvent.ITEM_FOCUS_IN</code> constant defines the value of the <code>type</code> property of a <code>itemFocusIn</code> event object. <p>This event has the following properties:</p> <table class="innertable" width="100%"> <tr><th>Property</th><th>Value</th></tr> <tr><td><code>bubbles</code></td><td><code>false</code></td></tr> <tr><td><code>cancelable</code></td><td><code>false</code>; there is no default behavior to cancel.</td></tr> <tr><td><code>columnIndex</code></td><td>The zero-based index of the header column in the <code>columns</code> array of the DataGrid object.</td></tr> <tr><td><code>currentTarget</code></td><td>The object that is actively processing the event object with an event listener. </td></tr> <tr><td><code>dataField</code></td><td><code>null</code></td></tr> <tr><td><code>itemRenderer</code></td><td>The item renderer for the item to be edited.</td></tr> <tr><td><code>reason</code></td><td><code>null</code></td></tr> <tr><td><code>rowIndex</code></td><td>The zero-based index of the item in the data provider.</td></tr> <tr><td><code>target</code></td><td>The object that dispatched the event. The target is not always the object listening for the event. Use the <code>currentTarget</code> property to access the object that is listening for the event.</td></tr> </table> @eventType itemFocusIn
see: #ITEM_FOCUS_OUT @langversion 3.0 @playerversion Flash 9.0.28.0
The <code>@ax-student-ar-fl-events-DataGridEvent.ITEM_FOCUS_OUT</code> constant defines the value of the <code>type</code> property of an <code>itemFocusOut</code> event object. <p>This event has the following properties:</p> <table class="innertable" width="100%"> <tr><th>Property</th><th>Value</th></tr> <tr><td><code>bubbles</code></td><td><code>false</code></td></tr> <tr><td><code>cancelable</code></td><td><code>false</code>; there is no default behavior to cancel.</td></tr> <tr><td><code>columnIndex</code></td><td>The zero-based index of the header column in the <code>columns</code> array of the DataGrid object.</td></tr> <tr><td><code>currentTarget</code></td><td>The object that is actively processing the event object with an event listener. </td></tr> <tr><td><code>dataField</code></td><td><code>null</code></td></tr> <tr><td><code>itemRenderer</code></td><td>The item renderer for the item to be edited.</td></tr> <tr><td><code>reason</code></td><td><code>null</code></td></tr> <tr><td><code>rowIndex</code></td><td>The zero-based index of the item in the data provider.</td></tr> <tr><td><code>target</code></td><td>The object that dispatched the event. The target is not always the object listening for the event. Use the <code>currentTarget</code> property to access the object that is listening for the event.</td></tr> </table> @eventType itemFocusOut
see: #ITEM_FOCUS_IN @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
Gets the item renderer for the item that is being edited or the header renderer that is being clicked or resized. @langversion 3.0 @playerversion Flash 9.0.28.0
Gets or sets the name of the field or property in the data associated with the column. @langversion 3.0 @playerversion Flash 9.0.28.0
@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0
Gets the reason the <code>itemEditEnd</code> event was dispatched. This property is only valid for events of type <code>@ax-student-ar-fl-events-DataGridEvent.ITEM_EDIT_END</code>. <p>The possible values are defined in the @fileReason class.</p>
see: fl.controls.DataGrid#event:itemEditEnd
see: @fileReason @langversion 3.0 @playerversion Flash 9.0.28.0
Creates a new @ax-student-ar-fl-events-DataGridEvent object with the specified parameters.
parameter: type The event type; this value indicates the action that caused the event.
parameter: bubbles Indicates whether the event can bubble up the display list hierarchy.
parameter: cancelable Indicates whether the behavior associated with the event can be prevented.
parameter: columnIndex The zero-based index of the column that contains the renderer.
parameter: rowIndex The zero-based index of the row that contains the renderer.
parameter: itemRenderer The item renderer for the item that is being edited or the header render that is being clicked or stretched.
parameter: dataField The name of the field or property in the data associated with the column.
parameter: reason The reason theitemEditEnd
event was dispatched.
see: @fileReason @langversion 3.0 @playerversion Flash 9.0.28.0
Returns a string that contains all the properties of the @ax-student-ar-fl-events-DataGridEvent object. The string is in the following format: <p>[<code>@ax-student-ar-fl-events-DataGridEvent type=<em>value</em> bubbles=<em>value</em> cancelable=<em>value</em> columnIndex=<em>value</em> rowIndex=<em>value</em> itemRenderer=<em>value</em> dataField=<em>value</em> reason=<em>value</em></code>]</p>
returns: A string that contains all the properties of the @ax-student-ar-fl-events-DataGridEvent object. @langversion 3.0 @playerversion Flash 9.0.28.0
Creates a copy of the @ax-student-ar-fl-events-DataGridEvent object and sets the value of each property to match the original.
returns: A new @ax-student-ar-fl-events-DataGridEvent object with parameter values that match those of the original. @langversion 3.0 @playerversion Flash 9.0.28.0
(C) Æliens 27/08/2009
You may not copy or print any of this material without explicit permission of the author or the publisher. In case of other copyright issues, contact the author.