AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    TableSortable Class

    Defined in: alloy-ui/src/aui-aria/js/aui-aria-table-sortable.js:10
    Module: aui-aria-table-sortable
    Parent Module: aui-aria

    An extension for A.Plugin.Aria that creates and synchronizes a screen-reader-friendly caption element for the table that has sortable headers.

    Constructor

    TableSortable

    (
    • config
    )

    Defined in alloy-ui/src/aui-aria/js/aui-aria-table-sortable.js:10

    Parameters:

    • config Object

      Object literal specifying widget configuration properties.

    Methods

    _afterCaptionVisibleChange

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-aria/js/aui-aria-table-sortable.js:195

    Handles captionVisible events.

    Parameters:

    _afterSort

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-aria/js/aui-aria-table-sortable.js:208

    Handles sort events from the host.

    Parameters:

    _getCaption

    () protected

    Defined in alloy-ui/src/aui-aria/js/aui-aria-table-sortable.js:226

    Returns a reference to the captionNode, and accomplishes necessary setup to prepare the element for screen readers.

    _toggleScreenReaderClass

    () protected

    Defined in alloy-ui/src/aui-aria/js/aui-aria-table-sortable.js:249

    Toggles the screen reader CSS class.

    initializer

    () protected

    Defined in alloy-ui/src/aui-aria/js/aui-aria-table-sortable.js:158

    Construction logic executed during TableSortable instantiation. Lifecycle.

    syncCaption

    (
    • columnName
    • ascending
    )

    Defined in alloy-ui/src/aui-aria/js/aui-aria-table-sortable.js:171

    Synchronizes the captionNode's text for screen readers with the sorted column and its sort direction.

    Parameters:

    • columnName String
    • ascending Boolean

    Properties

    ATTRS

    Object static

    Defined in alloy-ui/src/aui-aria/js/aui-aria-table-sortable.js:23

    Configuration for TableSortable.

    W3C_ATTRIBUTES

    Object static

    Provided by the aui-alert module.

    Defined in alloy-ui/src/aui-aria/js/aui-aria-attributes.js:1

    Static property used to define W3C's Supported States and Properties.

    W3C_ROLES

    Object static

    Provided by the aui-alert module.

    Defined in alloy-ui/src/aui-aria/js/aui-aria-roles.js:1

    Static property used to define [W3C's Roles Model](http://www.w3.org/TR/wai- aria/roles).

    Attributes

    captionCss

    String

    Defined in alloy-ui/src/aui-aria/js/aui-aria-table-sortable.js:32

    The CSS class to be added to the caption element.

    Default: ''

    captionLive

    String

    Defined in alloy-ui/src/aui-aria/js/aui-aria-table-sortable.js:44

    The value of the 'aria-live' attribute.

    Default: ''

    captionNode

    Node

    Defined in alloy-ui/src/aui-aria/js/aui-aria-table-sortable.js:56

    The caption node in the table.

    captionRole

    String

    Defined in alloy-ui/src/aui-aria/js/aui-aria-table-sortable.js:80

    The role for the caption element.

    Default: 'alert'

    captionVisible

    Boolean

    Defined in alloy-ui/src/aui-aria/js/aui-aria-table-sortable.js:92

    If the caption element is visible

    Default: false

    screenReaderClass

    String

    Defined in alloy-ui/src/aui-aria/js/aui-aria-table-sortable.js:104

    The class to used to hide the caption element but leave readable for screen readers.

    Default: 'sr-only'

    stringsSortable

    Object

    Defined in alloy-ui/src/aui-aria/js/aui-aria-table-sortable.js:117

    Object containing strings stating how the table is sorted.

    Default: { asc: 'ascending', desc: 'descending', sorted: 'sorted', sortedBy: 'sorted by', notSorted: 'not sorted' }

    tableNode

    Node

    Defined in alloy-ui/src/aui-aria/js/aui-aria-table-sortable.js:140

    The table node containing the columns to be sorted.