AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    A.ButtonExt Class

    Defined in: alloy-ui/src/aui-button/js/aui-button-core.js:18
    Module: aui-button

    A base class for ButtonExt.

    Constructor

    A.ButtonExt

    (
    • config
    )

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:18

    Parameters:

    • config Object

      Object literal specifying widget configuration properties.

    Methods

    _afterIconAlignChange

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:186

    Fires after iconAlign attribute change.

    Parameters:

    _afterIconChange

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:197

    Fires after icon attribute change.

    Parameters:

    _domTypeValidator

    (
    • type
    )
    protected

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:208

    Checks if the domType attribute has a valid value.

    Parameters:

    • type String

    _setEarlyButtonDomType

    (
    • type
    )
    protected

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:229

    Sets button type on bounding box template before constructor is invoked. The type is set before widget creates the bounding box node.

    Parameters:

    • type String

    _uiSetIcon

    (
    • val
    )
    protected

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:242

    Adds class name for button icon.

    Parameters:

    • val String

    _uiSetIconAlign

    (
    • val
    )
    protected

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:256

    Adds alignment for button icon.

    Parameters:

    • val String

    getTypedButtonTemplate

    (
    • template
    • type
    )
    String static

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:124

    Updates the HTML markup specified as the template argument with the passed type.

    Parameters:

    • template String
    • type String

    Returns:

    String:

    The parsed template containing the DOM type, e.g. <button {type} /> generates <button type="button" />.

    initializer

    () protected

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:145

    Construction logic executed during ButtonExt instantiation. Lifecycle.

    renderButtonExtUI

    () protected

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:160

    Includes default button classes if necessary. Fires after renderUI method.

    setButtonRole

    () protected

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:219

    Sets the role attribute on the bounding box to 'button';

    syncButtonExtUI

    ()

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:176

    Updates icon CSS class.

    Properties

    ATTRS

    Object static

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

    Defines the default attribute configuration for the ButtonExt.

    HTML_PARSER

    Object static

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:112

    Defines how attribute values are to be parsed from markup contained in ButtonExt.

    Attributes

    cssClass

    String

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:41

    CSS class to be automatically added to the boundingBox.

    discardDefaultButtonCssClasses

    Boolean

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:52

    Defines if the button will discard the default button classes.

    Default: false

    domType

    String

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:65

    Defines the HTML type attribute of element e.g. <input type="button">.

    icon

    String

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:77

    Contains a CSS class of the icon to use. A list of icons can be found here.

    iconAlign

    String

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:99

    Sets position of icon.

    Default: 'left'

    iconElement

    Defined in alloy-ui/src/aui-button/js/aui-button-core.js:86

    Defines markup template for icon, passed in as a node e.g. Y.Node.create('<span></span>').

    Default: 'A.Node.create("<span></span>")'