| { "type": "class", | |
| "qname": "spark.components.gridClasses.DataGridEditor", | |
| "baseClassname": "" | |
| , | |
| "description": "The DataGridEditor contains all the logic and event handling needed to manage the life cycle of an item editor. A DataGridEditor is owned by a specified DataGrid. The owning DataGrid is responsible for calling initialize() to enable editing and uninitialize() when editing is no longer needed.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 2.5"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 4.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "members": [ | |
| { "type": "method", | |
| "qname": "spark.components.gridClasses.DataGridEditor", | |
| "namespace": "", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Constructor", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["dataGrid The owner of this editor."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 2.5"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 4.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "", | |
| "params": [{ "name": "dataGrid", "type": "spark.components.DataGrid"}]} | |
| , | |
| { "type": "accessor", | |
| "access": "read-only", | |
| "return": "spark.components.DataGrid", | |
| "qname": "dataGrid", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Reference to the <code>DataGrid</code> that created the 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-only", | |
| "return": "spark.components.Grid", | |
| "qname": "grid", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Convenience property to get the <code>Grid</code> associated with the parent <code>DataGrid</code>.", | |
| "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": "Object", | |
| "qname": "editedItemPosition", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The column and row index of the item renderer for the data provider item being edited, if any. <p>This Object has two fields, <code>columnIndex</code> and <code>rowIndex</code>, the zero-based column and row indexes of the item. For example: {columnIndex:2, rowIndex:3}</p> <p>Setting this property scrolls the item into view and dispatches the <code>itemEditBegin</code> event to open an item editor on the specified item renderer.</p>", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["null"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "itemEditorInstance", | |
| "return": "spark.components.gridClasses.IGridItemEditor", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "A reference to the currently active instance of the item editor, if it exists. <p>To access the item editor instance and the new item value when an item is being edited, you use the <code>itemEditorInstance</code> property. The <code>itemEditorInstance</code> property is not valid until after the event listener for the <code>itemEditBegin</code> event executes. Therefore, you typically only access the <code>itemEditorInstance</code> property from within the event listener for the <code>itemEditEnd</code> event.</p> <p>The <code>DataGridColumn.itemEditor</code> property defines the class of the item editor and, therefore, the data type of the item editor instance.</p> <p>You do not set this property in MXML.</p>", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]}, | |
| { "tagName": "royalesuppresspublicvarwarning", | |
| "values": []} ]}, | |
| { "type": "accessor", | |
| "access": "read-only", | |
| "return": "mx.core.IVisualElement", | |
| "qname": "editedItemRenderer", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "A reference to the item renderer in the DataGrid control whose item is currently being edited. <p>From within an event listener for the <code>itemEditBegin</code> and <code>itemEditEnd</code> events, you can access the current value of the item being edited using the <code>editedItemRenderer.data</code> property.</p>", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-only", | |
| "return": "int", | |
| "qname": "editorColumnIndex", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The zero-based column index of the cell that is being edited. The value is -1 if no cell is being edited.", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["-1"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 4.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-only", | |
| "return": "int", | |
| "qname": "editorRowIndex", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The zero-based row index of the cell that is being edited. The value is -1 if no cell is being edited.", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["-1"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 4.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "method", | |
| "qname": "initialize", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Called by the <code>DataGrid</code> after construction to initialize the editor. No item editors can be created until after this method is called.", | |
| "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": "uninitialize", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The method is called to disable item editing on the <code>DataGrid</code>.", | |
| "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": "startItemEditorSession", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Start editing a cell for a specified row and column index. Dispatches a <code>GridItemEditorEvent.GRID_ITEM_EDITOR_SESSION_STARTING </code> event.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["rowIndex The zero-based row index of the cell to edit.", "columnIndex The zero-based column index of the cell to edit."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 2.5"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 4.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "Boolean", | |
| "params": [{ "name": "rowIndex", "type": "int"}, | |
| { "name": "columnIndex", "type": "int"}]} | |
| , | |
| { "type": "method", | |
| "qname": "endItemEditorSession", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Closes the currently active editor and optionally saves the editor's value by calling the item editor's save() method. If the cancel parameter is true, then the editor's cancel() method is called instead. otherwise it's saved.", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["spark.components.IGridItemEditor"]}, | |
| { "tagName": "param", | |
| "values": ["cancel if true then the data in the editor is discarded,"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 2.0"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 4.5"]}, | |
| { "tagName": "return", | |
| "values": ["true if the data in the editor was saved, false otherwise."]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "Boolean", | |
| "params": [{ "name": "cancel", "type": "Boolean"}]} | |
| , | |
| { "type": "method", | |
| "qname": "grid_gridMouseWheelHandler", | |
| "namespace": "protected", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Grid MouseWheel event handler. Used to end the itemeditor when scrolling on the grid. Default action is to save the edited contents.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 11.8", "AIR 3.8"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 4.11"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": [{ "name": "event", "type": "mx.events.MouseEvent"}]} | |
| ] | |
| } |