AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    A.DataTableSelection Class

    Defined in: alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:17
    Module: aui-datatable-selection
    Parent Module: aui-datatable

    A base class for DataTableSelection.

    Constructor

    A.DataTableSelection

    (
    • config
    )

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:17

    Parameters:

    • config Object

      Object literal specifying widget configuration properties.

    Methods

    _afterActiveCoordChange

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:213

    Focus the active cell on datatable sorting.

    Parameters:

    _bindSelectionUI

    () protected

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:229

    Bind the selection UI.

    _getActiveCell

    () protected

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:248

    Return the active cell.

    _getActiveRow

    () protected

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:267

    Return the active row.

    _onSelectionKey

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:356

    Fires on key event with the listened selection keys.

    Parameters:

    _onSelectionMouseDown

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:285

    Fires on mousedown event.

    Parameters:

    _onSelectionMouseEnter

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:307

    Fires on mouseenter event.

    Parameters:

    _onSelectionMouseUp

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:331

    Fires on mouseup event.

    Parameters:

    _parseRange

    (
    • val
    )
    Array protected

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:405

    Parse selection coordinates range.

    Parameters:

    • val Array

    Returns:

    Array:

    coords

    _setColumns

    () protected

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:511

    DataTable columns configuration breaks on n-depth cloning complex objects See http://yuilibrary.com/projects/yui3/ticket/2532597

    _setSelection

    (
    • val
    )
    Object protected

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:429

    Set selection.

    Parameters:

    • val Object

    Returns:

    Object:

    Selected cells and rows.

    captureSelection

    (
    • coords
    )
    Object

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:132

    Return the selected cells and within the coordinates coords.

    Parameters:

    • coords Object

      Cell coordinates.

    Returns:

    Object:

    Selected cells and rows.

    destroy

    () protected

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:119

    Destructor lifecycle implementation for the A.DataTableSelection class. Detaches _selectionKeyHandler event listener.

    getActiveColumn

    () Object

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:173

    Gets the active column based off the activeCell attribute.

    Returns:

    Object:

    Active column.

    getActiveRecord

    () Object

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:185

    Gets the active record based odd the activeRow attribute.

    Returns:

    Object:

    Active record.

    getColumn

    (
    • seed
    )
    Object

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:460

    Calculate and return the column based on the passed seed.

    Parameters:

    Returns:

    Object:

    Column.

    getCoord

    (
    • seed
    )
    Array

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:197

    Gets the cell coordinates of the passed seed.

    Parameters:

    Returns:

    Array:

    Cell coordinates.

    getRow

    (
    • seed
    )
    Object

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:482

    Return the row based on the passed seed.

    Add support to get a row by seed on DataTable getRow See http://yuilibrary.com/projects/yui3/ticket/2532605

    Parameters:

    Returns:

    Object:

    Row.

    initializer

    () protected

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:97

    Construction logic executed during A.DataTableSelection instantiation. Lifecycle.

    Properties

    ATTRS

    Object static

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:27

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

    Attributes

    activeCell

    Node

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:37

    Defines the active cell of the A.DataTableSelection.

    activeCoord

    Array

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:47

    Defines and stores the active cell coordinates, [row, cell], of the A.DataTableSelection.

    Default: [-1, -1]

    activeRow

    Node

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:59

    Defines the active row of the A.DataTableSelection.

    selection

    Object

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:69

    Defines the selected cells and rows of the A.DataTableSelection.

    tabIndex

    Number

    Defined in alloy-ui/src/aui-datatable/js/aui-datatable-selection.js:79

    Defines and stores the tabIndex of the activeCell.

    Default: 0