| { "type": "interface", |
| "qname": "spark.components.gridClasses.IGridItemEditor", |
| "baseInterfaceNames": [ |
| "mx.core.IDataRenderer", |
| "mx.core.IVisualElement", |
| "mx.managers.IFocusManagerComponent", |
| "mx.core.IIMESupport"] |
| , |
| "description": "The IGridItemEditor interface defines the interface that item editors for the Spark DataGrid and Spark Grid controls must implement. The DataGrid and Grid controls are referred to as the item renderer owner, or as the host component of the item editor. <p>All of the item editor's properties are set by the owner during the start of the editor session. The <code>data</code> property is the last property set. When the <code>data</code> property is set, an item editor should set the value of the editor's controls. Next, the editor's <code>prepare()</code> method is called. IGridItemEditor implementations should override the <code>prepare()</code> method to make any final adjustments to its properties or any aspect of its visual elements. When the editor is closing, the <code>discard()</code> method is called.</p> <p>When the editor is closed, the input value can be saved or canceled. If saving, the <code>save()</code> function is called by the editor to write new values to the data provider element corresponding to the row of the edited cell. </p>", |
| "tags": [ |
| { "tagName": "see", |
| "values": ["spark.components.DataGrid", "spark.components.Grid"]}, |
| { "tagName": "playerversion", |
| "values": ["Flash 10", "AIR 2.5"]}, |
| { "tagName": "productversion", |
| "values": ["Flex 4.5"]}, |
| { "tagName": "langversion", |
| "values": ["3.0"]} ], |
| "members": [ |
| { "type": "accessor", |
| "access": "read-only", |
| "return": "spark.components.DataGrid", |
| "qname": "dataGrid", |
| "namespace": "public", |
| "bindable": [], |
| "details": [], |
| "deprecated": {}, |
| "description": "The control that owns this item editor.", |
| "tags": [ |
| { "tagName": "playerversion", |
| "values": ["Flash 10", "AIR 2.5"]}, |
| { "tagName": "productversion", |
| "values": ["Flex 4.5"]}, |
| { "tagName": "langversion", |
| "values": ["3.0"]} ]}, |
| { "type": "accessor", |
| "access": "read-write", |
| "return": "spark.components.gridClasses.GridColumn", |
| "qname": "column", |
| "namespace": "public", |
| "bindable": [], |
| "details": [], |
| "deprecated": {}, |
| "description": "The column of the cell being edited.", |
| "tags": [ |
| { "tagName": "playerversion", |
| "values": ["Flash 10", "AIR 2.5"]}, |
| { "tagName": "productversion", |
| "values": ["Flex 4.5"]}, |
| { "tagName": "langversion", |
| "values": ["3.0"]} ]}, |
| { "type": "accessor", |
| "access": "read-only", |
| "return": "int", |
| "qname": "columnIndex", |
| "namespace": "public", |
| "bindable": [], |
| "details": [], |
| "deprecated": {}, |
| "description": "The zero-based index of the column being edited.", |
| "tags": [ |
| { "tagName": "playerversion", |
| "values": ["Flash 10", "AIR 2.5"]}, |
| { "tagName": "productversion", |
| "values": ["Flex 4.5"]}, |
| { "tagName": "langversion", |
| "values": ["3.0"]} ]}, |
| { "type": "accessor", |
| "access": "read-write", |
| "return": "int", |
| "qname": "rowIndex", |
| "namespace": "public", |
| "bindable": [], |
| "details": [], |
| "deprecated": {}, |
| "description": "The zero-based index of the row of the cell being edited.", |
| "tags": [ |
| { "tagName": "playerversion", |
| "values": ["Flash 10", "AIR 2.5"]}, |
| { "tagName": "productversion", |
| "values": ["Flex 4.5"]}, |
| { "tagName": "langversion", |
| "values": ["3.0"]} ]}, |
| { "type": "method", |
| "qname": "prepare", |
| "namespace": "public", |
| "bindable": [], |
| "details": [], |
| "deprecated": {}, |
| "description": "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. <p>Do not call this method directly. It should only be called by the control hosting the item editor.</p>", |
| "tags": [ |
| { "tagName": "playerversion", |
| "values": ["Flash 10", "AIR 2.5"]}, |
| { "tagName": "productversion", |
| "values": ["Flex 4.5"]}, |
| { "tagName": "langversion", |
| "values": ["3.0"]} ], |
| "return": "void", |
| "params": []} |
| , |
| { "type": "method", |
| "qname": "discard", |
| "namespace": "public", |
| "bindable": [], |
| "details": [], |
| "deprecated": {}, |
| "description": "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 <code>prepare()</code> method. <p>Do not call this method directly. It should only be called by the control hosting the item editor.</p>", |
| "tags": [ |
| { "tagName": "playerversion", |
| "values": ["Flash 10", "AIR 2.5"]}, |
| { "tagName": "productversion", |
| "values": ["Flex 4.5"]}, |
| { "tagName": "langversion", |
| "values": ["3.0"]} ], |
| "return": "void", |
| "params": []} |
| , |
| { "type": "method", |
| "qname": "save", |
| "namespace": "public", |
| "bindable": [], |
| "details": [], |
| "deprecated": {}, |
| "description": "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 <code>GridItemEditor.validate()</code> 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. <p>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 <code>endItemEditorSession()</code> method of the item renderer owner.</p> and <code>false</code> if not.", |
| "tags": [ |
| { "tagName": "see", |
| "values": ["spark.components.DataGrid"]}, |
| { "tagName": "playerversion", |
| "values": ["Flash 10", "AIR 2.5"]}, |
| { "tagName": "productversion", |
| "values": ["Flex 4.5"]}, |
| { "tagName": "return", |
| "values": ["<code>true</code> if the save operation succeeded,"]}, |
| { "tagName": "langversion", |
| "values": ["3.0"]} ], |
| "return": "Boolean", |
| "params": []} |
| , |
| { "type": "method", |
| "qname": "cancel", |
| "namespace": "public", |
| "bindable": [], |
| "details": [], |
| "deprecated": {}, |
| "description": "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 <code>false</code> . <p>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 <code>endItemEditorSession()</code> method with the <code>cancel</code> parameter set to <code>true</code>.</p> Return <code>false</code> to prevent the editor from closing.", |
| "tags": [ |
| { "tagName": "see", |
| "values": ["spark.components.DataGrid"]}, |
| { "tagName": "playerversion", |
| "values": ["Flash 10", "AIR 2.5"]}, |
| { "tagName": "productversion", |
| "values": ["Flex 4.5"]}, |
| { "tagName": "return", |
| "values": ["<code>true</code> to close the editor without saving its data."]}, |
| { "tagName": "langversion", |
| "values": ["3.0"]} ], |
| "return": "Boolean", |
| "params": []} |
| ] |
| } |
