AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    A.ButtonSwitch Class

    Extends: A.Widget
    Defined in: alloy-ui/src/aui-button/js/aui-button-switch.js:21
    Module: aui-button-switch

    The base class for Button Switch.

    Constructor

    A.ButtonSwitch

    (
    • config
    )

    Defined in alloy-ui/src/aui-button/js/aui-button-switch.js:21

    Parameters:

    • config Object

      Object literal specifying widget configuration properties.

    Methods

    _afterActivatedChange

    () protected

    Defined in alloy-ui/src/aui-button/js/aui-button-switch.js:64

    Fires after activated attribute changes.

    _afterInnerLabelLeftChange

    () protected

    Defined in alloy-ui/src/aui-button/js/aui-button-switch.js:74

    Fires after innerLabelLeft attribute changes.

    _afterInnerLabelRightChange

    () protected

    Defined in alloy-ui/src/aui-button/js/aui-button-switch.js:84

    Fires after innerLabelRight attribute changes.

    _getInnerCircle

    () Node protected

    Defined in alloy-ui/src/aui-button/js/aui-button-switch.js:94

    Returns the switch button instance.

    Returns:

    Node:

    _onButtonSwitchClick

    () protected

    Defined in alloy-ui/src/aui-button/js/aui-button-switch.js:110

    Fires when Button Switch is clicked.

    _onButtonSwitchInteraction

    () protected

    Defined in alloy-ui/src/aui-button/js/aui-button-switch.js:120

    Fires after user interacts.

    _onButtonSwitchKey

    () protected

    Defined in alloy-ui/src/aui-button/js/aui-button-switch.js:130

    Fires when a pres space or enter key.

    _setInnerCirclePosition

    (
    • activated
    )
    protected

    Defined in alloy-ui/src/aui-button/js/aui-button-switch.js:180

    Updates Inner Circle position with CSS classes.

    Parameters:

    • activated Boolean

    _uiSetActivate

    () protected

    Defined in alloy-ui/src/aui-button/js/aui-button-switch.js:140

    Updates the ui according to the value of the activated attribute.

    _uiSetInnerLabelLeft

    (
    • label
    )
    protected

    Defined in alloy-ui/src/aui-button/js/aui-button-switch.js:203

    Updates the ui according to the value of the innerLabelLeft attribute.

    Parameters:

    • label String

    _uiSetInnerLabelRight

    (
    • label
    )
    protected

    Defined in alloy-ui/src/aui-button/js/aui-button-switch.js:214

    Updates the ui according to the value of the innerLabelRight attribute.

    Parameters:

    • label String

    bindUI

    () protected

    Defined in alloy-ui/src/aui-button/js/aui-button-switch.js:32

    Bind the events on the ButtonSwitch UI. Lifecycle.

    renderUI

    () protected

    Defined in alloy-ui/src/aui-button/js/aui-button-switch.js:48

    Renders the ButtonSwitch component instance. Lifecycle.

    Properties

    ATTRS

    Object static

    Defined in alloy-ui/src/aui-button/js/aui-button-switch.js:226

    Static property used to define the default attribute configuration for the ButtonSwitch.

    Attributes

    activated

    Boolean

    Defined in alloy-ui/src/aui-button/js/aui-button-switch.js:236

    Determines if ButtonSwitch is active or not.

    content

    Node

    Defined in alloy-ui/src/aui-button/js/aui-button-switch.js:246

    Node containing the contents of this field.

    innerLabelLeft

    String

    Defined in alloy-ui/src/aui-button/js/aui-button-switch.js:262

    The label to be used on button left side.

    innerLabelRight

    String

    Defined in alloy-ui/src/aui-button/js/aui-button-switch.js:273

    The label to be used on button right side.