AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    A.FormBuilder Class

    Uses:
    Extends: A.Widget
    Defined in: alloy-ui/src/aui-form-builder-deprecated/js/aui-form-builder-deprecated.js:41
    Module: aui-form-builder-base
    Parent Module: aui-form-builder

    A base class for A.FormBuilder.

    Constructor

    A.FormBuilder

    (
    • config
    )

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

    Parameters:

    • config Object

      Object literal specifying widget configuration properties.

    Example:

    <div id="myFormBuilder"></div>
                                    
    YUI().use(
                                     'aui-form-builder',
                                     function(Y) {
                                       new Y.FormBuilder(
                                         {
                                           availableFields: [
                                             {
                                               iconClass: 'form-builder-field-icon-text',
                                               id: 'uniqueTextField',
                                               label: 'Text',
                                               readOnlyAttributes: ['name'],
                                               type: 'text',
                                               unique: true,
                                               width: 75
                                             },
                                             {
                                               hiddenAttributes: ['tip'],
                                               iconClass: 'form-builder-field-icon-textarea',
                                               label: 'Textarea',
                                               type: 'textarea'
                                             },
                                             {
                                               iconClass: 'form-builder-field-icon-checkbox',
                                               label: 'Checkbox',
                                               type: 'checkbox'
                                             },
                                             {
                                               iconClass: 'form-builder-field-icon-button',
                                               label: 'Button',
                                               type: 'button'
                                             },
                                             {
                                               iconClass: 'form-builder-field-icon-select',
                                               label: 'Select',
                                               type: 'select'
                                             },
                                             {
                                               iconClass: 'form-builder-field-icon-radio',
                                               label: 'Radio Buttons',
                                               type: 'radio'
                                             },
                                             {
                                               iconClass: 'form-builder-field-icon-fileupload',
                                               label: 'File Upload',
                                               type: 'fileupload'
                                             },
                                             {
                                               iconClass: 'form-builder-field-icon-fieldset',
                                               label: 'Fieldset',
                                               type: 'fieldset'
                                             }
                                           ],
                                           boundingBox: '#myFormBuilder',
                                           fields: [
                                             {
                                               label: 'City',
                                               options: [
                                                 {
                                                   label: 'Ney York',
                                                   value: 'new york'
                                                 },
                                                 {
                                                   label: 'Chicago',
                                                   value: 'chicago'
                                                 }
                                               ],
                                               predefinedValue: 'chicago',
                                               type: 'select'
                                             },
                                             {
                                               label: 'Colors',
                                               options: [
                                                 {
                                                   label: 'Red',
                                                   value: 'red'
                                                 },
                                                 {
                                                   label: 'Green',
                                                   value: 'green'
                                                 },
                                                 {
                                                   label: 'Blue',
                                                   value: 'blue'
                                                 }
                                               ],
                                               type: 'radio'
                                             }
                                           ]
                                         }
                                       ).render();
                                     }
                                    );

    Index

    Methods

    Properties

    Attributes

    Methods

    _addColMoveButton

    (
    • colNode
    • rowNode
    )
    protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:65

    <p>Overrides default <code>addColMoveButton</code> attribute.</p>

    Parameters:

    _addColMoveTarget

    (
    • col
    )
    protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:82

    <p>Overrides default <code>addColMoveTarget</code> attribute.</p>

    Parameters:

    _addFieldsChangeListener

    () protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:224

    Attach the fieldsChange event listener from all layouts on the layouts attribute.

    _addNestedField

    (
    • field
    • nested
    • index
    )
    protected

    Provided by the aui-form-builder module.

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

    Adds a field into field's nested list and normalizes the columns height.

    Parameters:

    • field A.FormField

      The Field with nested list that will receive the field

    • nested A.FormField

      Field to add as nested

    • index Number

      The position where the nested field should be added

    _addPage

    () protected

    Provided by the aui-form-builder module.

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

    Adds a new page on form builder.

    _afterActivePageNumberChange

    () protected

    Provided by the aui-form-builder module.

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

    Fired after the activePageNumber change.

    _afterDestroyFieldToolbar

    () protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:288

    Fired after the Field Toolbar be destroyed.

    _afterFieldFocusedChange

    (
    • event
    )
    protected

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

    Triggers after field focused change.

    Parameters:

    • event Object

    _afterFieldsChange

    (
    • event
    )
    protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:412

    Fired after the form-builder-field-list:fieldsChange event is triggered.

    Parameters:

    _afterFieldSettingsModalHide

    () protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:298

    Fired when the field settings modal is hidden.

    _afterFieldSettingsModalSave

    (
    • event
    )
    protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:308

    Fired when the field settings modal is saved.

    Parameters:

    _afterFieldTypesChange

    (
    • event
    )
    protected

    Inherited from A.FormBuilderFieldTypes: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:148

    <p>Fired after the <code>fieldTypes</code> attribute is set.</p>

    Parameters:

    _afterLayoutBuilderColsChange

    () protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:99

    <p>Executed after the <code>layout:rowsChange</code> is fired.</p>

    _afterLayoutBuilderMoveEnd

    () protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:111

    <p>Executed after the <code>layout-builder:moveEnd</code> is fired.</p>

    _afterLayoutBuilderMoveStart

    (
    • event
    )
    protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:124

    <p>Executed after the <code>layout-builder:moveStart</code> is fired.</p>

    Parameters:

    _afterLayoutBuilderRender

    () protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:141

    <p>Fired after this widget is rendered.</p>

    _afterLayoutColsChange

    () protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:370

    Fired after the layout-row:colsChange event is triggered.

    _afterLayoutRowsChange

    (
    • event
    )
    protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:380

    Fired after the layout:rowsChange event is triggered.

    Parameters:

    _afterLayoutsChange

    (
    • event
    )
    protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:341

    Fires after layouts changes.

    Parameters:

    _afterSelectedFieldsSetAdd

    (
    • event
    )
    protected

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

    Triggers after adding selected fields to a A.LinkedSet instance.

    Parameters:

    • event Object

    _afterSelectedFieldsSetRemove

    (
    • event
    )
    protected

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

    Triggers after removing selected fields from the A.LinkedSet instance.

    Parameters:

    • event Object

    _afterSelectFieldType

    (
    • event
    )
    protected

    Inherited from A.FormBuilderFieldTypes: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:159

    <p>Fired after a field type is selected by the user.</p>

    Parameters:

    _afterUniqueFieldsMapPut

    (
    • event
    )
    protected

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

    Triggers after adding unique fields to a A.Map instance.

    Parameters:

    • event Object

    _afterUniqueFieldsMapRemove

    (
    • event
    )
    protected

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

    Triggers after removing unique fields from the A.Map instance.

    Parameters:

    • event Object

    _afterUpdatePageContentChange

    (
    • event
    )
    protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:398

    Fired after the activePageNumber change.

    Parameters:

    _bindMoveRowEvents

    () protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:176

    <p>Bind events related to the cancel move row funcionality.</p>

    _checkActiveLayoutHasFieldType

    (
    • fieldType
    )
    Boolean protected

    Inherited from A.FormBuilderFieldTypes: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:176

    <p>Check on all created fields if there is one of the same type of the parameter.</p>

    Parameters:

    • fieldType Object

    Returns:

    Boolean:

    _checkLastRow

    (
    • layout
    )
    protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:188

    <p>Checks if the last row has more than one col or if it has at least one field, if true a new row is created and set on the last position.</p>

    Parameters:

    _checkLayoutsLastRow

    () protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:423

    Executes the '_checkLastRow' funciton for each layouts on 'layouts' attribute.

    _checkListHasFieldType

    (
    • fieldList
    • fieldType
    )
    Boolean protected

    Inherited from A.FormBuilderFieldTypes: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:205

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

    Parameters:

    • fieldList A.FormBuilderFIeldList
    • fieldType Object

    Returns:

    Boolean:

    _chooseColMoveTarget

    (
    • originalFn
    • cutButton
    • col
    )
    protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:224

    <p>Overrides default <code>chooseColMoveTarget</code> attribute.</p>

    Parameters:

    _clickColMoveTarget

    (
    • moveTarget
    )
    protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:269

    <p>Overrides default <code>clickColMoveTarget</code> attribute.</p>

    Parameters:

    _clickRemoveRow

    (
    • row
    )
    Boolean protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:318

    <p>Overrides default <code>clickRemoveRow</code> attribute. Check if the parameter <code>row</code> has fields.</p>

    Parameters:

    Returns:

    Boolean:

    _cloneField

    (
    • field
    • deep
    )
    Object protected

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

    Clones a field.

    Parameters:

    • field Object
    • deep Object

    Returns:

    Object:

    _createLastRow

    (
    • layout
    )
    protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:345

    <p>Creates a new row in the last position.</p>

    Parameters:

    _detachCancelMoveFieldEvents

    () protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:369

    <p>Detaches events related to the cancel move field funcionality.</p>

    _detachCancelMoveRowEvents

    () protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:359

    <p>Detaches events related to the cancel move row funcionality.</p>

    _disableAddFields

    () protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:379

    <p>Disable add fields functionality.</p>

    _dropField

    (
    • dragNode
    )
    protected

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

    Executes when the field is dropped.

    Parameters:

    • dragNode Object

    _enableAddFields

    () protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:393

    <p>Enable add fields functionality.</p>

    _forceRemoveRow

    () protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:407

    <p>Removes a row even with field.</p>

    _getFieldId

    (
    • field
    )
    String protected

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

    Gets the field id.

    Parameters:

    • field Object

    Returns:

    String:

    _getFieldNodeIndex

    (
    • fieldNode
    )
    protected

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

    Gets the index from the field node.

    Parameters:

    • fieldNode Object

    _getLastRow

    (
    • layout
    )
    A.LayoutRow protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:419

    <p>Gets the last row.</p>

    Parameters:

    Returns:

    A.LayoutRow:

    _getPageManagerInstance

    (
    • config
    )
    A.FormBuilderPages protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:445

    Form Builder Pages instance initializer. Receives a custom object of configurations or using default configurations instead.

    Parameters:

    • config Object

    Returns:

    A.FormBuilderPages:

    _handleCreateEvent

    (
    • field
    )
    protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:469

    Fire event of create a field.

    Parameters:

    _handleEditEvent

    (
    • field
    )
    protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:482

    Fire event of edit a field.

    Parameters:

    _handleRemoveEvent

    (
    • field
    )
    protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:495

    Fire event of remove a field.

    Parameters:

    _hasFieldType

    (
    • fieldType
    • field
    )
    Boolean protected

    Inherited from A.FormBuilderFieldTypes: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:228

    <p>Checks if the given field is of the given field type.</p>

    Parameters:

    Returns:

    Boolean:

    _initRemoveConfirmationModal

    () protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:433

    <p>Create a confirmation modal to be used when a remove row button from a row with fields is clicked.</p>

    _isColumnEmpty

    (
    • col
    )
    Boolean protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:475

    <p>Checks if the given column is empty.</p>

    Parameters:

    Returns:

    Boolean:

    _makeEmptyFieldList

    (
    • col
    )
    protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:508

    Turns the given column into an empty form builder column.

    Parameters:

    _onCancel

    (
    • event
    )
    protected

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

    Triggers on cancel. Unselect fields, stops the event propagation and prevents the default event behavior.

    Parameters:

    • event Object

    _onClickAddField

    (
    • event
    )
    protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:523

    Fired when the button for adding a new field is clicked.

    Parameters:

    _onClickField

    (
    • event
    )
    protected

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

    Triggers when a field is clicked.

    Parameters:

    • event Object

    _onClickOutsideMoveColTarget

    (
    • event
    )
    protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:487

    <p>Fires when click event is triggered.</p>

    Parameters:

    _onClickOutsideMoveRowTarget

    (
    • event
    )
    protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:508

    <p>Fires when click event is triggered.</p>

    Parameters:

    _onDragEnd

    (
    • event
    )
    protected

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

    Triggers when the drag ends.

    Parameters:

    • event Object

    _onDragMouseDown

    (
    • event
    )
    protected

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

    Triggers when the drag mouse down.

    Parameters:

    • event Object

    _onDragStart

    (
    • event
    )
    protected

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

    Triggers when the drag starts.

    Parameters:

    • event Object

    _onEscKeyPressMoveTarget

    () protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:523

    <p>Fires when esc key press event is triggered.</p>

    _onFocus

    (
    • event
    )
    protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:534

    Fired when some node is focused inside content box.

    Parameters:

    _onFormBuilderToolbarHasAddedToField

    (
    • event
    )
    protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:540

    <p>Fired when mouse enters a toolbar's field.</p>

    Parameters:

    _onMouseOutField

    (
    • event
    )
    protected

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

    Triggers when the mouse is out a field.

    Parameters:

    • event Object

    _onMouseOverField

    (
    • event
    )
    protected

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

    Triggers when the mouse is over a field.

    Parameters:

    • event Object

    _onSave

    (
    • event
    )
    protected

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

    Triggers on saving a field. First checks if the field is being edited, if it is then sets the data and syncs on the UI.

    Parameters:

    • event Object

    _openNewFieldPanel

    (
    • target
    )
    protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:563

    Opens a panel to select a new field type.

    Parameters:

    _removeColMoveButtons

    () protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:551

    <p>Overrides default <code>removeColMoveButtons</code> attribute.</p>

    _removeColMoveTargets

    () protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:561

    <p>Overrides default <code>removeColMoveTargets</code> attribute.</p>

    _removeFieldsChangeListener

    () protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:576

    Detach the fieldsChange event listener from all layouts on the layouts attribute.

    _removeLayout

    (
    • event
    )
    protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:587

    Remove a layout from the form builder. The paramenter event has the layout index to be removed.

    Parameters:

    _removeLayoutCutColButtons

    () protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:578

    <p>Remove original layout cut col buttons.</p>

    _renderContentBox

    () protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:602

    Render the form builder UI parts

    _renderEmptyColumns

    () protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:621

    Renders some content inside the empty columns of the current layout.

    _renderTabs

    () protected

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

    Overrides PropertyBuilderSettings's _renderTabs method, which renders the builder's tabs.

    _selectFirstValidMoveTarget

    () protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:588

    <p>Find and focus on first valid move target.</p>

    _setAvailableFields

    (
    • val
    )
    Array protected

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

    Set list of available fields by checking if a field is a A.PropertyBuilderAvailableField instance. If not creates a new instance of A.FormBuilderAvailableField.

    Parameters:

    • val Object

    Returns:

    Array:

    _setFieldsSortableListConfig

    (
    • val
    )
    protected

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

    Set the fieldsSortableListConfig attribute.

    Parameters:

    • val Object

    _setFieldToolbarConfig

    (
    • val
    )
    Object

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:646

    Sets the fieldToolbar attribute.

    Parameters:

    • val Object

    Returns:

    Object:

    _setFieldTypes

    (
    • val
    )
    A.FormBuilderFieldType protected

    Inherited from A.FormBuilderFieldTypes: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:254

    <p>Sets the <code>fieldTypes</code> attribute.</p>

    Parameters:

    Returns:

    A.FormBuilderFieldType:

    _setLayouts

    (
    • val
    )
    protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:659

    Sets the layouts attribute.

    Parameters:

    • val A.Array

    _setMoveButtonData

    (
    • colNode
    )
    protected

    Inherited from A.FormBuilderLayoutBuilder: alloy-ui/src/aui-form-builder/js/aui-form-builder-layout-builder.js:600

    <p>Show or hide move item in toolbar.</p>

    Parameters:

    _setupAvailableFieldsSortableList

    () protected

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

    Setup a A.SortableList of available fields.

    _setupFieldsSortableList

    () protected

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

    Setup a A.SortableList of fields.

    _syncUniqueField

    (
    • field
    )
    protected

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

    Sync unique fields.

    Parameters:

    • field Object

    _uiSetAllowRemoveRequiredFields

    (
    • val
    )
    protected

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

    Set the allowRemoveRequiredFields attribute on the UI.

    Parameters:

    • val Object

    _unregisterFieldType

    (
    • fieldType
    )
    protected

    Inherited from A.FormBuilderFieldTypes: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:272

    <p>Removes a single given field type from this form builder.</p>

    Parameters:

    _unregisterFieldTypeByIndex

    (
    • index
    )
    protected

    Inherited from A.FormBuilderFieldTypes: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:295

    <p>Unregisters the field type at the given index.</p>

    Parameters:

    _updatePageContent

    () protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:685

    Fired after the activePageNumber change.

    _updateUniqueFieldType

    () protected

    Inherited from A.FormBuilderFieldTypes: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:311

    <p>Enable or disable unique FieldTypes based on created Fields.</p>

    _valueFieldTypesModal

    () A.FormBuilderFieldTypesModal protected

    Inherited from A.FormBuilderFieldTypes: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:327

    <p>Default value for the modal displayed to select a field.</p>

    Returns:

    A.FormBuilderFieldTypesModal:

    addNestedField

    (
    • field
    )

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:135

    Adds a nested field to the given field.

    Parameters:

    bindUI

    () protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:81

    Bind the events for the A.FormBuilder UI. Lifecycle.

    closeEditProperties

    ()

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

    Selects the field tab and disables the setting tabs.

    createField

    (
    • config
    )
    Object

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

    Creates a field and returns its configuration.

    Parameters:

    • config Object

    Returns:

    Object:

    destructor

    () protected

    Inherited from A.FormBuilderLayoutBuilder but overwritten in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:116

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

    disableUniqueFieldType

    (
    • field
    )

    Inherited from A.FormBuilderFieldTypes: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:47

    <p>Disables unique fields for the field class that the given field is an instance of.</p>

    Parameters:

    duplicateField

    (
    • field
    )

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

    Gets the current field index and then clones the field. Inserts the new one after the current field index, inside of the current field parent.

    Parameters:

    • field Object

    editField

    (
    • field
    )

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:146

    Opens the settings panel for editing the given field.

    Parameters:

    editField

    (
    • field
    )

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

    Checks if the current field is a A.FormBuilderField instance and selects it.

    Parameters:

    • field Object

    findTypeOfField

    (
    • field
    )

    Inherited from A.FormBuilderFieldTypes: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:62

    <p>Finds the type of the given field.</p>

    Parameters:

    getActiveLayout

    () A.LayoutPage

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:157

    Returns the active LayoutPage.

    Returns:

    A.LayoutPage:

    getFieldClass

    (
    • type
    )
    Object | null

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

    Gets the field class based on the A.FormBuilder type. If the type doesn't exist, logs an error message.

    Parameters:

    • type Object

    Returns:

    Object | null:

    getFieldProperties

    (
    • field
    )
    Array

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

    Gets a list of properties from the field.

    Parameters:

    • field Object

    Returns:

    Array:

    getFieldRow

    (
    • field
    )
    Node

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:167

    Returns the row of the given field.

    Parameters:

    Returns:

    Node:

    The row where is the field parameter

    hideFieldsPanel

    ()

    Inherited from A.FormBuilderFieldTypes: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:79

    <p>Hides the fields modal.</p>

    initializer

    () protected

    Inherited from A.FormBuilderLayoutBuilder but overwritten in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:44

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

    initializer

    () protected

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

    Construction logic executed during A.FormBuilder instantiation. Lifecycle.

    insertField

    (
    • field
    • index
    • parent
    )

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

    Removes field from previous parent and inserts into the new parent.

    Parameters:

    • field Object
    • index Object
    • parent Object

    openEditProperties

    (
    • field
    )

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

    Enables the settings tab.

    Parameters:

    • field Object

    plotField

    (
    • field
    • container
    )

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

    Renders a field in the container.

    Parameters:

    • field Object
    • container Object

    plotFields

    (
    • fields
    • container
    )

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

    Renders a list of fields in the container.

    Parameters:

    • fields Object
    • container Object

    registerFieldTypes

    (
    • typesToAdd
    )

    Inherited from A.FormBuilderFieldTypes: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:90

    <p>Adds a the given field types to this form builder.</p>

    Parameters:

    • typesToAdd Array | Object | A.FormBuilderFieldType

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

    removeField

    (
    • field
    )

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:178

    Removes the given field from the form builder.

    Parameters:

    renderUI

    () protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:67

    Renders the A.FormBuilder UI. Lifecycle.

    selectFields

    (
    • fields
    )

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

    Adds fields to a A.LinkedSet instance.

    Parameters:

    • fields Object

    showFieldSettingsPanel

    (
    • field
    • typeName
    )

    Provided by the aui-form-builder module.

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

    Shows the settings panel for the given field.

    Parameters:

    • field A.FormField
    • typeName String

      The name of the field type.

    showFieldsPanel

    ()

    Inherited from A.FormBuilderFieldTypes: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:111

    <p>Shows the fields modal.</p>

    simulateFocusField

    (
    • field
    )

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

    Triggers a focus event in the current field and a blur event in the last focused field.

    Parameters:

    • field Object

    syncUI

    () protected

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:106

    Syncs the UI. Lifecycle.

    syncUI

    () protected

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

    Sync the A.FormBuilder UI. Lifecycle.

    unregisterFieldTypes

    (
    • typesToRemove
    )

    Inherited from A.FormBuilderFieldTypes: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:126

    <p>Removes the given field types from this form builder.</p>

    Parameters:

    • typesToRemove Array | String | A.FormBuilderFieldType

      <p>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 <code>A.FormBuilderFieldType</code>, only the same instances will be removed.</p>

    unselectFields

    (
    • fields
    )

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

    Removes fields from the A.LinkedSet instance.

    Parameters:

    • fields Object

    Properties

    ATTRS

    Object static

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:701

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

    ATTRS

    Object static

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

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

    CSS_PREFIX

    String static

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:771

    Static property provides a string to identify the CSS prefix.

    EXTENDS

    String static

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

    Static property used to define which component it extends.

    FIELDS_TAB

    Number static

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

    Static property used to define the fields tab.

    Default: 0

    NAME

    String static

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

    Static property provides a string to identify the class.

    SETTINGS_TAB

    Number static

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

    Static property used to define the settings tab.

    Default: 1

    UI_ATTRS

    Array static

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

    Static property used to define the UI attributes.

    Attributes

    allowRemoveRequiredFields

    Boolean

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

    Checks if removing required fields is permitted or not.

    Default: false

    enableEditing

    Boolean

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

    Enables a field to be editable.

    Default: true

    fieldsSortableListConfig

    Object

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

    Collection of sortable fields.

    Default: null

    fieldToolbarConfig

    Object

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:710

    A configuration object for the creation of the A.FormBuilderFieldToolbar instance to be used for the form builder field toolbars.

    fieldTypes

    Array

    Inherited from A.FormBuilderFieldTypes: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:361

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

    Default: []

    fieldTypesModal

    A.FormBuilderFieldTypesModal

    Inherited from A.FormBuilderFieldTypes: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-types.js:375

    <p>The modal that will be used to select a field type.</p>

    layouts

    Array

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:723

    The layouts where the forms fields will be rendered.

    Default: [A.Layout]

    pages

    A.FormBuilderPages

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:738

    A Form Builder Pages instance.

    strings

    Object

    Provided by the aui-form-builder module.

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder.js:749

    Collection of strings used to label elements of the UI.

    strings

    Object

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

    Collection of strings used to label elements of the UI.

    tabView

    Object

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

    Stores an instance of A.TabView.

    Default: null