AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    A.FormBuilderField Class

    Defined in: alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:40
    Module: aui-form-builder-field
    Parent Module: aui-form-builder

    A base class for A.FormBuilderField.

    Constructor

    A.FormBuilderField

    (
    • config
    )

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:40

    Parameters:

    • config Object

      Object literal specifying widget configuration properties.

    Methods

    _booleanFormatter

    (
    • o
    )
    protected

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:758

    Transforms a Boolean value into "yes" or "no" string.

    Parameters:

    • o Object

    _getFieldNode

    () protected

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:772

    Returns the node for the current field.

    _getToolbarItems

    () Array

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:789

    Gets a list of toolbar items.

    Returns:

    Array:

    _handleDeleteEvent

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:860

    Popups a dialog to confirm deletion. If "yes", destroys the instance.

    Parameters:

    • event Object

    _handleDuplicateEvent

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:828

    Checks if the field isn't unique. If not, duplicates the instance.

    Parameters:

    • event Object

    _handleEditEvent

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:845

    Handles the edit event.

    Parameters:

    • event Object

    _setId

    (
    • val
    )
    protected

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:878

    Set the id attribute on the UI.

    Parameters:

    • val Object

    _uiSetAcceptChildren

    (
    • val
    )
    protected

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:889

    Set the acceptChildren attribute on the UI.

    Parameters:

    • val Object

    _uiSetDisabled

    (
    • val
    )
    protected

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:926

    Set the disabled attribute on the UI.

    Parameters:

    • val Object

    _uiSetFields

    (
    • val
    )
    protected

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:944

    Set the fields on the UI using the plotFields method from A.FormBuilder.

    Parameters:

    • val Object

    _uiSetLabel

    (
    • val
    )
    protected

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:959

    Set the label content on the UI.

    Parameters:

    • val Object

    _uiSetName

    (
    • val
    )
    protected

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:973

    Set the name attribute on the UI.

    Parameters:

    • val Object

    _uiSetPredefinedValue

    (
    • val
    )
    protected

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:986

    Set the predefinedValue attribute on the UI.

    Parameters:

    • val Object

    _uiSetRequired

    (
    • val
    )
    protected

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:999

    Set the required attribute on the UI.

    Parameters:

    • val Object

    _uiSetSelected

    (
    • val
    )
    protected

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:913

    Set the selected attribute on the UI.

    Parameters:

    • val Object

    _uiSetShowLabel

    (
    • val
    )
    protected

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:1016

    Set the showLabel attribute on the UI.

    Parameters:

    • val Object

    _uiSetTip

    (
    • val
    )
    protected

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:1030

    Set the tip attribute on the UI.

    Parameters:

    • val Object

    _uiSetUnique

    (
    • val
    )
    protected

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:1055

    Set the unique attribute on the UI.

    Parameters:

    • val Object

    buildFieldId

    (
    • id
    )
    String private

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:456

    Creates the field id.

    Parameters:

    • id Object

    Returns:

    String:

    buildFieldName

    (
    • type
    )
    String private

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:468

    Creates the field name.

    Parameters:

    • type Object

    Returns:

    String:

    createField

    (
    • val
    )
    Object

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:574

    Creates the field using the createField method from A.FormBuilder.

    Parameters:

    • val Object

    Returns:

    Object:

    destructor

    () protected

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:537

    Destructor lifecycle implementation for the A.FormBuilderField class.

    getAttributesForCloning

    () Object

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:617

    Gets all necessary attributes for cloning this field.

    Returns:

    Object:

    getHTML

    () String

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:593

    Gets the field markup.

    To developer: Implement this

    Returns:

    String:

    getNode

    () Node

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:605

    Creates a Node from the HTML string.

    Returns:

    Node:

    getProperties

    () Array

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:643

    Gets properties from the property model.

    Returns:

    Array:

    getPropertyModel

    () Array

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:686

    Returns a list of property models. Each property model is made of a name, attribute, editor, and formatter.

    Returns:

    Array:

    initializer

    () protected

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:497

    Construction logic executed during A.FormBuilderField instantiation. Lifecycle.

    renderUI

    () protected

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:512

    Render the A.FormBuilderField component instance. Lifecycle.

    Properties

    ATTRS

    Object static

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:59

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

    AUGMENTS

    Array static

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:447

    Static property used to define the augmented classes.

    HTML_PARSER

    Object static

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:480

    Object hash, defining how attribute values have to be parsed from markup.

    NAME

    String static

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:50

    Static property provides a string to identify the class.

    UI_ATTRS

    Array static

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:435

    Static property used to define the UI attributes.

    Attributes

    acceptChildren

    Boolean

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:69

    If true children are accepted.

    Default: true

    builder

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:80

    The A.FormBuilder instance.

    Default: null

    controlsToolbar

    Object

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:90

    Collection of toolbar controls.

    dataType

    String

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:108

    Indicates which is the type of data for the input field.

    Default: 'string'

    disabled

    Boolean

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:119

    Checks if the input field is disabled or not.

    Default: false

    dropZoneNode

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:371

    Node used to generate the drop zone.

    hiddenAttributes

    Array

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:141

    List of hidden attributes.

    Default: []

    label

    String

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:162

    The label of the input field.

    Default: ''

    localizationMap

    Object

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:173

    Collection for content localization.

    Default: {}

    parent

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:198

    Container for the field parent.

    Default: null

    predefinedValue

    String

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:208

    Specifies a predefined value for the input field.

    Default: ''

    readOnly

    Boolean

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:219

    Checks if an input field is read-only. In other words, it cannot be modified.

    Default: false

    readOnlyAttributes

    Array

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:232

    List of read-only input fields.

    Default: []

    required

    Boolean

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:244

    Checks if an input field is required. In other words, it needs content to be valid.

    Default: false

    requiredFlagNode

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:402

    Node used to generate the required flag.

    selected

    Boolean

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:130

    Checks if the input field is selected or not.

    Default: false

    showLabel

    Boolean

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:257

    If true the label is showed.

    Default: true

    strings

    Object

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:269

    Collection of strings used to label elements of the UI.

    template

    String

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:314

    Reusable block of markup used to generate the field.

    Default: ''

    templateNode

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:413

    Node used to generate a template.

    tip

    String

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:325

    Hint to help the user to fill the input field.

    Default: ''

    type

    String

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:336

    Defines the type of field.

    Default: ''

    unique

    Boolean

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:347

    Checks if the input field is unique or not.

    Default: false

    zIndex

    Number

    Defined in alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-field-deprecated.js:359

    Stack order of the field. An element with greater stack order is always in front of an element with a lower stack order.

    Default: 100