AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    A.WidgetToolbars Class

    Defined in: alloy-ui/src/aui-widget/js/aui-widget-toolbars.js:9
    Module: aui-widget-toolbars

    A base class for Widget Toolbars.

    Constructor

    Methods

    _syncPrimaryButtonUI

    () protected

    Defined in alloy-ui/src/aui-widget/js/aui-widget-toolbars.js:164

    Sync the primary button on the UI.

    _syncUIToolbars

    () protected

    Defined in alloy-ui/src/aui-widget/js/aui-widget-toolbars.js:181

    Sync A.Toolbar instances on the UI.

    _uiSetToolbars

    () protected

    Defined in alloy-ui/src/aui-widget/js/aui-widget-toolbars.js:193

    Set A.Toolbar instances.

    addToolbar

    (
    • toolbar
    • section
    )
    A.Toolbar

    Defined in alloy-ui/src/aui-widget/js/aui-widget-toolbars.js:84

    Includes a A.Toolbar instance into the widget.

    Parameters:

    • toolbar Object
    • section Object

    Returns:

    A.Toolbar:

    getToolbar

    (
    • section
    )
    A.Toolbar

    Defined in alloy-ui/src/aui-widget/js/aui-widget-toolbars.js:121

    Gets the A.Toolbar instance based on its section.

    Parameters:

    • section Object

    Returns:

    A.Toolbar:

    getToolbarSection

    (
    • section
    )
    String

    Defined in alloy-ui/src/aui-widget/js/aui-widget-toolbars.js:134

    Gets the toolbar's section. If no argument is passed, returns the StdMod.FOOTER.

    Parameters:

    • section Object

    Returns:

    String:

    initializer

    () protected

    Defined in alloy-ui/src/aui-widget/js/aui-widget-toolbars.js:67

    Construction logic executed during WidgetToolbars instantiation. Lifecycle.

    removeToolbar

    (
    • section
    )

    Defined in alloy-ui/src/aui-widget/js/aui-widget-toolbars.js:147

    Destroys the A.Toolbar instance based on its section.

    Parameters:

    • section Object

    Properties

    ATTRS

    Object static

    Defined in alloy-ui/src/aui-widget/js/aui-widget-toolbars.js:17

    Static property used to define the default attribute configuration.

    Attributes

    toolbarCssClass

    Object

    Defined in alloy-ui/src/aui-widget/js/aui-widget-toolbars.js:49

    Collection of toolbar's header, body, and footer CSS classes.

    toolbarPosition

    Object

    Defined in alloy-ui/src/aui-widget/js/aui-widget-toolbars.js:35

    Collection of toolbar's header, body, and footer positions.

    toolbars

    Object

    Defined in alloy-ui/src/aui-widget/js/aui-widget-toolbars.js:26

    Collection of A.Toolbar instances.

    Default: {}