AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    A.FormBuilderFieldToolbar Class

    Extends: A.Base
    Defined in: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-toolbar.js:17
    Module: aui-form-builder-field-toolbar
    Parent Module: aui-form-builder

    A base class for A.FormBuilderFieldToolbar.

    Constructor

    A.FormBuilderFieldToolbar

    (
    • config
    )

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-toolbar.js:17

    Parameters:

    • config Object

      Object literal specifying widget configuration properties.

    Methods

    _afterItemsChange

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-toolbar.js:132

    Fired after the items attribute is changed.

    _getFieldFromEvent

    (
    • event
    )
    A.FormBuilderFieldBase protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-toolbar.js:142

    Gets the form builder field from the event's target node.

    Parameters:

    Returns:

    A.FormBuilderFieldBase:

    _getItemFromEvent

    (
    • event
    )
    Object protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-toolbar.js:154

    Gets the item object that represents the event's target node.

    Parameters:

    Returns:

    Object:

    _onFieldClick

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-toolbar.js:168

    Fired when a field is clicked.

    Parameters:

    _onFieldMouseEnter

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-toolbar.js:182

    Fires when mouse enters on field.

    Parameters:

    _onFieldMouseLeave

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-toolbar.js:197

    Fires when mouse leaves the field.

    _onItemClick

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-toolbar.js:207

    Fired when one of the toolbar items is clicked.

    Parameters:

    _onToggleClick

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-toolbar.js:225

    Fired when the toolbar's toggle is clicked.

    _uiSetItems

    (
    • items
    )
    protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-toolbar.js:235

    Updates the UI according to the value of the items attribute.

    Parameters:

    • items Array

    addForField

    (
    • field
    )

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-toolbar.js:79

    Adds the toolbar for the given field.

    Parameters:

    destructor

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-toolbar.js:68

    Destructor lifecycle implementation for the A.FormBuilderFieldToolbar class. Lifecycle.

    getItem

    (
    • selector
    )
    Node

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-toolbar.js:102

    Finds one toolbar's item using the selector.

    Parameters:

    • selector String

    Returns:

    Node:

    initializer

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-toolbar.js:34

    Construction logic executed during the A.FormBuilderFieldToolbar instantiation. Lifecycle.

    remove

    ()

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-toolbar.js:122

    Removes the toolbar from the DOM.

    Properties

    ATTRS

    Object static

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-toolbar.js:255

    Static property used to define the default attribute configuration for the A.FormBuilderFieldToolbar.

    Attributes

    disabled

    Boolean

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-toolbar.js:264

    Attribute that prevents users interact with the toolbar

    formBuilder

    A.FormBuilder

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-toolbar.js:275

    The form builder instance that this toolbar will be used with.

    items

    Array

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-toolbar.js:285

    The items that should show up in the field toolbar. Each item should be represented by an object with the following keys: handler - (Optional) If present, the name of a function from the form builder to be called when this item is clicked. iconClass: The icon css class that should be used by this item.

    Default: []