AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    A.FormBuilderFieldTypes Class

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

    A.FormBuilder extension, which is responsible for all the logic related to field types.

    Constructor

    A.FormBuilderFieldTypes

    (
    • config
    )

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:8

    Parameters:

    • config Object

      Object literal specifying layout builder configuration properties.

    Methods

    _afterFieldTypesChange

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:148

    Fired after the fieldTypes attribute is set.

    Parameters:

    _afterSelectFieldType

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:159

    Fired after a field type is selected by the user.

    Parameters:

    _checkActiveLayoutHasFieldType

    (
    • fieldType
    )
    Boolean protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:176

    Check on all created fields if there is one of the same type of the parameter.

    Parameters:

    • fieldType Object

    Returns:

    Boolean:

    _checkListHasFieldType

    (
    • fieldList
    • fieldType
    )
    Boolean protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:205

    Checks on all fields of a field list if there is one of the same type of the parameter.

    Parameters:

    • fieldList A.FormBuilderFIeldList
    • fieldType Object

    Returns:

    Boolean:

    _hasFieldType

    (
    • fieldType
    • field
    )
    Boolean protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:228

    Checks if the given field is of the given field type.

    Parameters:

    Returns:

    Boolean:

    _setFieldTypes

    (
    • val
    )
    A.FormBuilderFieldType protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:254

    Sets the fieldTypes attribute.

    Parameters:

    Returns:

    A.FormBuilderFieldType:

    _unregisterFieldType

    (
    • fieldType
    )
    protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:272

    Removes a single given field type from this form builder.

    Parameters:

    _unregisterFieldTypeByIndex

    (
    • index
    )
    protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:295

    Unregisters the field type at the given index.

    Parameters:

    _updateUniqueFieldType

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:311

    Enable or disable unique FieldTypes based on created Fields.

    _valueFieldTypesModal

    () A.FormBuilderFieldTypesModal protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:327

    Default value for the modal displayed to select a field.

    Returns:

    A.FormBuilderFieldTypesModal:

    destructor

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:32

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

    disableUniqueFieldType

    (
    • field
    )

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:47

    Disables unique fields for the field class that the given field is an instance of.

    Parameters:

    findTypeOfField

    (
    • field
    )

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:62

    Finds the type of the given field.

    Parameters:

    hideFieldsPanel

    ()

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

    Hides the fields modal.

    initializer

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:20

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

    registerFieldTypes

    (
    • typesToAdd
    )

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

    Adds a the given field types to this form builder.

    Parameters:

    • typesToAdd Array | Object | A.FormBuilderFieldType

      This can be either an array of items or a single item. Each item should be either an instance of A.FormBuilderFieldType, or the configuration object to be used when instantiating one.

    showFieldsPanel

    ()

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:111

    Shows the fields modal.

    unregisterFieldTypes

    (
    • typesToRemove
    )

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:126

    Removes the given field types from this form builder.

    Parameters:

    • typesToRemove Array | String | A.FormBuilderFieldType

      This can be either an array of items, or a single one. For each item, if it's a string, the form builder will remove all registered field types with a field class that matches it. For items that are instances of A.FormBuilderFieldType, only the same instances will be removed.

    Properties

    ATTRS

    Object static

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:352

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

    Attributes

    fieldTypes

    Array

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:361

    The collection of field types that can be selected as fields for this form builder.

    Default: []

    fieldTypesModal

    A.FormBuilderFieldTypesModal

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:375

    The modal that will be used to select a field type.