| Package | spark.components.gridClasses |
| Interface | public interface IGridItemEditor extends IDataRenderer, IVisualElement, IFocusManagerComponent, IIMESupport, ILayoutElement, ILayoutDirectionElement, flash.events.IEventDispatcher |
| Implementors | GridItemEditor |
| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.5 |
All of the item editor's properties are set by the owner during
the start of the editor session.
The data property is the last property set.
When the data property is set, an item editor should
set the value of the editor's controls.
Next, the editor's prepare() method is called.
IGridItemEditor implementations should override the prepare() method
to make any final adjustments to its properties or any aspect of its visual elements.
When the editor is closing, the discard() method is called.
When the editor is closed, the input value can be saved or canceled.
If saving, the save() function is called by the editor
to write new values to the data provider element corresponding to the
row of the edited cell.
See also
| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number | IVisualElement | |
| baseline : Object
The vertical distance in pixels from the anchor target to
the control's baseline position. | ILayoutElement | |
| baselinePosition : Number [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | ILayoutElement | |
| bottom : Object
The vertical distance in pixels from the bottom edge of the component to the
anchor target's bottom edge. | ILayoutElement | |
| column : GridColumn
The column of the cell being edited. | IGridItemEditor | ||
| columnIndex : int [read-only]
The zero-based index of the column being edited. | IGridItemEditor | ||
| data : Object
The data to render or edit. | IDataRenderer | |
| dataGrid : DataGrid [read-only]
The control that owns this item editor. | IGridItemEditor | ||
| depth : Number
Determines the order in which items inside of containers
are rendered. | IVisualElement | |
| designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | IVisualElement | |
| enableIME : Boolean [read-only]
Specifies whether the IME should be enabled when
this component has focus. | IIMESupport | |
| focusEnabled : Boolean
A flag that indicates whether the component can receive focus when selected. | IFocusManagerComponent | |
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | IFocusManagerComponent | |
| hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | ILayoutElement | |
| height : Number | IVisualElement | |
| horizontalCenter : Object
The horizontal distance in pixels from the center of the component to the
center of the anchor target's content area. | ILayoutElement | |
| imeMode : String
The IME mode of the component. | IIMESupport | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | ILayoutElement | |
| is3D : Boolean [read-only]
Contains true when the element is in 3D. | IVisualElement | |
| layoutDirection : String
Specifies the desired layout direction for an element: one of LayoutDirection.LTR
(left to right), LayoutDirection.RTL (right to left), or null (inherit). | ILayoutDirectionElement | |
| left : Object
The horizontal distance in pixels from the left edge of the component to the
anchor target's left edge. | ILayoutElement | |
| mouseFocusEnabled : Boolean [read-only]
A flag that indicates whether the component can receive focus
when selected with the mouse. | IFocusManagerComponent | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | IVisualElement | |
| parent : DisplayObjectContainer [read-only]
The parent container or component for this component. | IVisualElement | |
| percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | ILayoutElement | |
| percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | ILayoutElement | |
| postLayoutTransformOffsets : 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. | IVisualElement | |
| right : Object
The horizontal distance in pixels from the right edge of the component to the
anchor target's right edge. | ILayoutElement | |
| rowIndex : int
The zero-based index of the row of the cell being edited. | IGridItemEditor | ||
| tabFocusEnabled : Boolean [read-only]
A flag that indicates whether pressing the Tab key eventually
moves focus to this component. | IFocusManagerComponent | |
| tabIndex : int
If tabFocusEnabled, the order in which the component receives focus. | IFocusManagerComponent | |
| top : Object
The vertical distance in pixels from the top edge of the component to the
anchor target's top edge. | ILayoutElement | |
| verticalCenter : Object
The vertical distance in pixels from the center of the component to the
center of the anchor target's content area. | ILayoutElement | |
| visible : Boolean
Controls the visibility of this visual element. | IVisualElement | |
| width : Number | IVisualElement | |
| x : Number | IVisualElement | |
| y : Number | IVisualElement | |
| Method | Defined By | ||
|---|---|---|---|
cancel():Boolean
Called by the DataGrid when an open editor is being closed without
saving the data in the editor. | IGridItemEditor | ||
discard():void
Called just before the editor is closed. | IGridItemEditor | ||
| drawFocus(isFocused:Boolean):void
Called by the FocusManager when the component receives focus. | IFocusManagerComponent | |
| getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size. | ILayoutElement | |
| getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size. | ILayoutElement | |
| getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height. | ILayoutElement | |
| getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width. | ILayoutElement | |
| getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen. | ILayoutElement | |
| getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen. | ILayoutElement | |
| getLayoutMatrix():Matrix
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | ILayoutElement | |
| getLayoutMatrix3D():Matrix3D
Returns the layout transform Matrix3D for this element. | ILayoutElement | |
| getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height. | ILayoutElement | |
| getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width. | ILayoutElement | |
| getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height. | ILayoutElement | |
| getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width. | ILayoutElement | |
| getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height. | ILayoutElement | |
| getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width. | ILayoutElement | |
| invalidateLayoutDirection():void
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | ILayoutDirectionElement | |
prepare():void
Called after the editor has been created and sized but before the
editor is visible. | IGridItemEditor | ||
save():Boolean
Saves the value in the editor to the data provider of the
item renderer's owner. | IGridItemEditor | ||
| setFocus():void
Called by the FocusManager when the component receives focus. | IFocusManagerComponent | |
| setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen. | ILayoutElement | |
| setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element. | ILayoutElement | |
| setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | ILayoutElement | |
| setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | ILayoutElement | |
| 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. | ILayoutElement | |
| column | property |
Hide Inherited Public Properties
Show Inherited Public Propertiescolumn:GridColumn| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.5 |
The column of the cell being edited.
public function get column():GridColumn public function set column(value:GridColumn):void| columnIndex | property |
columnIndex:int [read-only] | 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 being edited.
public function get columnIndex():int| dataGrid | property |
dataGrid:DataGrid [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.5 |
The control that owns this item editor.
public function get dataGrid():DataGrid| rowIndex | property |
rowIndex: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 cell being edited.
public function get rowIndex():int public function set rowIndex(value:int):void| cancel | () | method |
public function cancel():Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.5 |
Called by the DataGrid when an open editor is being closed without
saving the data in the editor. Closing the editor may be
prevented by returning false
.
Do not call this method directly.
It should only be called by the control hosting the item editor.
To close the editor without saving its data, call the
endItemEditorSession() method with the cancel
parameter set to true.
Boolean — true to close the editor without saving its data.
Return false to prevent the editor from closing.
|
See also
| discard | () | method |
public function discard():void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.5 |
Called just before the editor is closed.
Use this method to perform any final cleanup,
such as cleaning up anything that was set in the
prepare() method.
Do not call this method directly. It should only be called by the control hosting the item editor.
| prepare | () | method |
public function prepare():void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.5 |
Called after the editor has been created and sized but before the editor is visible. Use this method to adjust the appearance of the editor, add event listeners, or perform any other initializations before it becomes visible.
Do not call this method directly. It should only be called by the control hosting the item editor.
| save | () | method |
public function save():Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.5 |
Saves the value in the editor to the data provider of the
item renderer's owner.
This method updates the data provider element corresponding to the
row of the edited cell.
This function calls GridItemEditor.validate() to verify
the data may be saved.
If the data is not valid, then the data is not saved
and the editor is not closed.
Do not call this method directly.
It should only be called by the control hosting the item editor.
To save and close the editor, call the endItemEditorSession()
method of the item renderer owner.
Boolean — true if the save operation succeeded,
and false if not.
|
See also