AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    A.ToggleButton Class

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

    A base class for ToggleButton.

    Constructor

    A.ToggleButton

    (
    • config
    )

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

    Parameters:

    • config Object

      Object literal specifying widget configuration properties.

    Methods

    _afterCssClassChange

    (
    • event
    )
    protected

    Inherited from A.WidgetCssClass: alloy-ui/src/aui-widget/js/aui-widget-cssclass.js:60

    Fires after the value of the cssClass attribute change.

    Parameters:

    _afterIconAlignChange

    (
    • event
    )
    protected

    Inherited from A.ButtonExt: alloy-ui/src/aui-button/js/aui-button-core.js:186

    <p>Fires after <code>iconAlign</code> attribute change.</p>

    Parameters:

    _afterIconChange

    (
    • event
    )
    protected

    Inherited from A.ButtonExt: alloy-ui/src/aui-button/js/aui-button-core.js:197

    <p>Fires after <code>icon</code> attribute change.</p>

    Parameters:

    _domTypeValidator

    (
    • type
    )
    protected

    Inherited from A.ButtonExt: alloy-ui/src/aui-button/js/aui-button-core.js:208

    <p>Checks if the domType attribute has a valid value.</p>

    Parameters:

    • type String

    _setEarlyButtonDomType

    (
    • type
    )
    protected

    Inherited from A.ButtonExt: alloy-ui/src/aui-button/js/aui-button-core.js:229

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

    Parameters:

    • type String

    _uiSetCssClass

    (
    • newVal
    • prevVal
    )
    protected

    Inherited from A.WidgetCssClass: alloy-ui/src/aui-widget/js/aui-widget-cssclass.js:83

    Applies the CSS classes to the boundingBox and contentBox.

    Parameters:

    • newVal String
    • prevVal String

    _uiSetIcon

    (
    • val
    )
    protected

    Inherited from A.ButtonExt: alloy-ui/src/aui-button/js/aui-button-core.js:242

    <p>Adds class name for button icon.</p>

    Parameters:

    • val String

    _uiSetIconAlign

    (
    • val
    )
    protected

    Inherited from A.ButtonExt: alloy-ui/src/aui-button/js/aui-button-core.js:256

    <p>Adds alignment for button icon.</p>

    Parameters:

    • val String

    initializer

    () protected

    Inherited from A.WidgetCssClass but overwritten in alloy-ui/src/aui-button/js/aui-button-core.js:145

    <p>Construction logic executed during <code>ButtonExt</code> instantiation. Lifecycle.</p>

    renderButtonExtUI

    () protected

    Inherited from A.ButtonExt: alloy-ui/src/aui-button/js/aui-button-core.js:160

    <p>Includes default button classes if necessary. Fires after <code>renderUI</code> method.</p>

    setButtonRole

    () protected

    Inherited from A.ButtonExt: alloy-ui/src/aui-button/js/aui-button-core.js:219

    <p>Sets the role attribute on the bounding box to 'button';</p>

    syncButtonExtUI

    ()

    Inherited from A.ButtonExt: alloy-ui/src/aui-button/js/aui-button-core.js:176

    <p>Updates icon CSS class.</p>

    Attributes

    cssClass

    String

    Inherited from A.WidgetCssClass but overwritten in alloy-ui/src/aui-button/js/aui-button-core.js:41

    <p>CSS class to be automatically added to the <code>boundingBox</code>.</p>

    discardDefaultButtonCssClasses

    Boolean

    Inherited from A.ButtonExt: alloy-ui/src/aui-button/js/aui-button-core.js:52

    <p>Defines if the button will discard the default button classes.</p>

    Default: false

    domType

    String

    Inherited from A.ButtonExt: alloy-ui/src/aui-button/js/aui-button-core.js:65

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

    icon

    String

    Inherited from A.ButtonExt: alloy-ui/src/aui-button/js/aui-button-core.js:77

    <p>Contains a CSS class of the icon to use. A list of icons can be found <a href="http://liferay.github.io/alloy-bootstrap/base-css.html#icons">here</a>.</p>

    iconAlign

    String

    Inherited from A.ButtonExt: alloy-ui/src/aui-button/js/aui-button-core.js:99

    <p>Sets position of icon.</p>

    Default: 'left'

    iconElement

    Inherited from A.ButtonExt: alloy-ui/src/aui-button/js/aui-button-core.js:86

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

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