AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    A.FormField Class

    Extends: A.Base
    Defined in: alloy-ui/src/aui-form-field/js/aui-form-field.js:14
    Module: aui-form-field

    A base class for A.FormField. All form fields should extend from this.

    Constructor

    A.FormField

    (
    • config
    )

    Defined in alloy-ui/src/aui-form-field/js/aui-form-field.js:14

    Parameters:

    • config Object

      Object literal specifying widget configuration properties.

    Methods

    _afterHelpChange

    () protected

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

    Fired after the help attribute is set.

    _afterNestedFieldsChange

    () protected

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

    Fired after the nestedFields attribute is set.

    _afterTitleChange

    () protected

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

    Fired after the title attribute is set.

    _uiSetHelp

    (
    • help
    )
    protected

    Defined in alloy-ui/src/aui-form-field/js/aui-form-field.js:152

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

    Parameters:

    • help String

    _uiSetNestedFields

    (
    • nestedFields
    )
    protected

    Defined in alloy-ui/src/aui-form-field/js/aui-form-field.js:166

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

    Parameters:

    • nestedFields Array

    _uiSetTitle

    (
    • title
    )
    protected

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

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

    Parameters:

    • title String

    _validateNestedFields

    (
    • val
    )
    protected

    Defined in alloy-ui/src/aui-form-field/js/aui-form-field.js:193

    Validates the value being set to the nestedFields attribute.

    Parameters:

    • val Array

    addNestedField

    (
    • index
    • field
    )

    Defined in alloy-ui/src/aui-form-field/js/aui-form-field.js:89

    Adds the given field to this field's nested list.

    Parameters:

    destructor

    () protected

    Defined in alloy-ui/src/aui-form-field/js/aui-form-field.js:76

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

    initializer

    () protected

    Defined in alloy-ui/src/aui-form-field/js/aui-form-field.js:35

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

    removeNestedField

    (
    • field
    )

    Defined in alloy-ui/src/aui-form-field/js/aui-form-field.js:104

    Removes the given field from this field's nested list.

    Parameters:

    renderUI

    () protected

    Defined in alloy-ui/src/aui-form-field/js/aui-form-field.js:58

    Create the DOM structure for the A.FormField. Lifecycle.

    Properties

    ATTRS

    Object static

    Defined in alloy-ui/src/aui-form-field/js/aui-form-field.js:216

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

    Attributes

    content

    Node

    Defined in alloy-ui/src/aui-form-field/js/aui-form-field.js:226

    Node containing the contents of this field.

    help

    String

    Defined in alloy-ui/src/aui-form-field/js/aui-form-field.js:242

    Help text.

    Default: ''

    nestedFields

    Array

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

    The fields that are nested inside this field.

    Default: []

    title

    String

    Defined in alloy-ui/src/aui-form-field/js/aui-form-field.js:267

    The title of this field.

    Default: ''