AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    A.DataTable.CellEditorSupport Class

    Defined in: alloy-ui/src/aui-datatable/js/aui-datatable-cell-editor-support.js:8
    Module: aui-datatable

    An extension for A.DataTable to support Cell Editing.

    Constructor

    A.DataTable.CellEditorSupport

    (
    • config
    )

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-cell-editor-support.js:8

    Parameters:

    • config Object

      Object literal specifying widget configuration properties.

    Methods

    _afterCellEditorSupportRender

    () protected

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-cell-editor-support.js:109

    Fires after the A.CellEditorSupport has rendered, and calls _syncModelsReadOnlyUI.

    _afterSelectionKey

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-cell-editor-support.js:124

    Fires after '_onSelectionKey'. Opens editor of 'activeCell' on key press.

    Parameters:

    _onEditCell

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-cell-editor-support.js:140

    render() and show() the A.BaseCellEditor, of the active table cell.

    Called when active table cell is clicked (default).

    Parameters:

    • event EventFacade

      The event defined in attribute editEvent.

    _onEditorCancel

    () protected

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-cell-editor-support.js:175

    Invoked when the editor fires the 'cancel' event.

    _onEditorSave

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-cell-editor-support.js:187

    Invoked when the editor fires the 'save' event.

    Parameters:

    _onEditorVisibleChange

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-cell-editor-support.js:207

    Calls _syncFocus if the A.BaseCellEditor input has a new value.

    Called on the visibleChange event.

    Parameters:

    _refocusActiveCell

    () protected

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-cell-editor-support.js:224

    Places keyboard focus onto the last active cell.

    _syncModelReadOnlyUI

    (
    • model
    )
    protected

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-cell-editor-support.js:239

    Toggles the row's read-only class. Toggle determined by the readOnly attribute of the Model.

    Parameters:

    _syncModelsReadOnlyUI

    () protected

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-cell-editor-support.js:254

    Calls _syncModelReadOnlyUI for each Model in the data attribute.

    getCellEditor

    () BaseCellEditor deprecated static

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-cell-editor-support.js:271

    Deprecated: Use `getEditor` instead.

    Forwards method call to getEditor.

    Returns:

    BaseCellEditor:

    See getEditor

    getRecordColumnValue

    (
    • record
    • column
    )
    String deprecated

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-cell-editor-support.js:283

    Syntactic sugar for record.get(column.key).

    Parameters:

    • record Model
    • column Object

      Column configuration.

    Returns:

    String:

    Record column key.

    initializer

    () protected

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-cell-editor-support.js:63

    Construction logic executed during A.CellEditorSupport instantiation. Lifecycle.

    Properties

    ATTRS

    Object static

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-cell-editor-support.js:37

    Static property used to define the default attribute configuration for the A.CellEditorSupport.

    EDITOR_ZINDEX

    Number static

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-cell-editor-support.js:27

    Number which provides a z-index style value for the A.BaseCellEditor.

    Default: 9999

    NAME

    String static

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-cell-editor-support.js:18

    Static property provides a string to identify the class.

    Attributes

    editEvent

    String

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-cell-editor-support.js:47

    Defines the event which displays the A.BaseCellEditor.

    Default: 'click'