AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    A.FormBuilderFieldBase Class

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

    An augmentation class which adds some editing funcionality to form builder fields.

    Constructor

    A.FormBuilderFieldBase

    (
    • config
    )

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

    Parameters:

    • config Object

      Object literal specifying widget configuration properties.

    Methods

    _afterAdvancedSettingsChange

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:215

    Fired after the a advanced settings change.

    _afterExpandedChange

    (
    • event
    )
    protected

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

    Fired after the a Toggler of Advanced Settings change.

    Parameters:

    _attachEvent

    (
    • form
    • node
    • subscription
    • notifier
    • filter
    )
    protected

    Provided by the aui-event-delegate-submit module.

    Defined in alloy-ui/src/aui-event/js/aui-event-delegate-submit.js:96

    Adds an event subscription.

    Parameters:

    • form Object
    • node Object
    • subscription Object
    • notifier Object
    • filter Object

    _attachEvent

    (
    • node
    • subscription
    • notifier
    • delegateNode
    • filter
    )
    protected

    Provided by the aui-event-delegate-change module.

    Defined in alloy-ui/src/aui-event/js/aui-event-delegate-change.js:76

    Adds an event subscription.

    Parameters:

    • node Object
    • subscription Object
    • notifier Object
    • delegateNode Object
    • filter Object

    _attachEvents

    (
    • node
    • subscription
    • notifier
    • filter
    )
    protected

    Provided by the aui-event-delegate-change module.

    Defined in alloy-ui/src/aui-event/js/aui-event-delegate-change.js:127

    Adds an event subscription.

    Parameters:

    • node Object
    • subscription Object
    • notifier Object
    • filter Object

    _createAdvancedSettingsToggler

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:236

    Create a Toggler with the advanced settings.

    _createMoveTarget

    (
    • position
    )
    Node protected

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

    Creates a move target node.

    Parameters:

    • position Number

      The position where the moved field will be added if this is the chosen target.

    Returns:

    Node:

    _detachEvents

    (
    • node
    • subscription
    • notifier
    )
    protected

    Provided by the aui-event-delegate-submit module.

    Defined in alloy-ui/src/aui-event/js/aui-event-delegate-submit.js:157

    Deletes a group of event subscriptions.

    Parameters:

    • node Object
    • subscription Object
    • notifier Object

    _detachEvents

    (
    • node
    • subscription
    • notifier
    )
    protected

    Provided by the aui-event-delegate-change module.

    Defined in alloy-ui/src/aui-event/js/aui-event-delegate-change.js:153

    Deletes a group of event subscriptions.

    Parameters:

    • node Object
    • subscription Object
    • notifier Object

    _dispatchEvent

    (
    • subscription
    • notifier
    • event
    )
    protected

    Provided by the aui-event-input module.

    Defined in alloy-ui/src/aui-event/js/aui-event-input.js:116

    Dispatches an input event.

    Parameters:

    • subscription Object
    • notifier Object
    • event Object

    _fireEvent

    (
    • subscription
    • notifier
    • event
    • valueBeforeKey
    )
    protected

    Provided by the aui-event-input module.

    Defined in alloy-ui/src/aui-event/js/aui-event-input.js:152

    Fires an event.

    Parameters:

    • subscription Object
    • notifier Object
    • event Object
    • valueBeforeKey Object

    _getAdvancedSettings

    () Array protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:276

    Gets the list of advanced settings for this field.

    Returns:

    Array:

    _getEventName

    () protected

    Provided by the aui-event-delegate-change module.

    Defined in alloy-ui/src/aui-event/js/aui-event-delegate-change.js:178

    Gets an event name.

    _getNodeName

    (
    • elem
    • name
    )
    protected

    Provided by the aui-event-delegate-submit module.

    Defined in alloy-ui/src/aui-event/js/aui-event-delegate-submit.js:182

    Gets a node name.

    Parameters:

    • elem Object
    • name Object

    _getSettings

    () Array protected

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

    Gets the list of settings for this field. Safer then calling the property directly, as this will lazy load the settings if they're not ready yet. Each setting should be an object with the following keys: attrName and editor.

    Returns:

    Array:

    _hasParent

    (
    • node
    • testParentNode
    )
    protected

    Provided by the aui-event-delegate-submit module.

    Defined in alloy-ui/src/aui-event/js/aui-event-delegate-submit.js:196

    Checks if a node has parent.

    Parameters:

    • node Object
    • testParentNode Object

    _prepareHandles

    (
    • subscription
    • node
    )
    protected

    Provided by the aui-event-delegate-change module.

    Defined in alloy-ui/src/aui-event/js/aui-event-delegate-change.js:200

    Prepares event handles.

    Parameters:

    • subscription Object
    • node Object

    _prepareHandles

    (
    • subscription
    • node
    )
    protected

    Provided by the aui-event-delegate-submit module.

    Defined in alloy-ui/src/aui-event/js/aui-event-delegate-submit.js:213

    Prepares event handles.

    Parameters:

    • subscription Object
    • node Object

    _toggleVisibilityOfModalContent

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:355

    Toggle visibility classes on Modal Content.

    _uiSetNestedFields

    (
    • nestedFields
    )
    protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:365

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

    Parameters:

    • nestedFields Array

    _updateAdvancedSettingsChange

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:332

    Updates the UI according to the values of the Advanced Settings.

    collapseModalContent

    ()

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:94

    Collapse Advanced Settings Content.

    delegate

    (
    • node
    • subscription
    • notifier
    • filter
    )

    Provided by the aui-event-delegate-change module.

    Defined in alloy-ui/src/aui-event/js/aui-event-delegate-change.js:18

    Implementation logic for subscription via node.delegate.

    Parameters:

    • node Object
    • subscription Object
    • notifier Object
    • filter Object

    delegate

    (
    • node
    • subscription
    • notifier
    • filter
    )

    Provided by the aui-event-input module.

    Defined in alloy-ui/src/aui-event/js/aui-event-input.js:57

    Implementation logic for subscription via node.delegate.

    Parameters:

    • node Object
    • subscription Object
    • notifier Object
    • filter Object

    delegate

    (
    • node
    • subscription
    • notifier
    • filter
    )

    Provided by the aui-event-delegate-submit module.

    Defined in alloy-ui/src/aui-event/js/aui-event-delegate-submit.js:19

    Implementation logic for subscription via node.delegate.

    Parameters:

    • node Object
    • subscription Object
    • notifier Object
    • filter Object

    detach

    (
    • node
    • subscription
    • notifier
    )

    Provided by the aui-event-input module.

    Defined in alloy-ui/src/aui-event/js/aui-event-input.js:85

    Implementation logic for cleaning up a detached subscription.

    Parameters:

    • node Object
    • subscription Object
    • notifier Object

    detach

    (
    • node
    • subscription
    • notifier
    )

    Provided by the aui-event-delegate-change module.

    Defined in alloy-ui/src/aui-event/js/aui-event-delegate-change.js:33

    Implementation logic for cleaning up a detached subscription.

    Parameters:

    • node Object
    • subscription Object
    • notifier Object

    detach

    (
    • node
    • subscription
    • notifier
    )

    Provided by the aui-event-delegate-submit module.

    Defined in alloy-ui/src/aui-event/js/aui-event-delegate-submit.js:53

    Implementation logic for cleaning up a detached subscription.

    Parameters:

    • node Object
    • subscription Object
    • notifier Object

    detachDelegate

    (
    • node
    • subscription
    • notifier
    )

    Provided by the aui-event-delegate-change module.

    Defined in alloy-ui/src/aui-event/js/aui-event-delegate-change.js:47

    Implementation logic for cleaning up a detached delegate subscription.

    Parameters:

    • node Object
    • subscription Object
    • notifier Object

    detachDelegate

    (
    • node
    • subscription
    • notifier
    )

    Provided by the aui-event-delegate-submit module.

    Defined in alloy-ui/src/aui-event/js/aui-event-delegate-submit.js:67

    Implementation logic for cleaning up a detached delegate subscription.

    Parameters:

    • node Object
    • subscription Object
    • notifier Object

    detachDelegate

    (
    • node
    • subscription
    • notifier
    )

    Provided by the aui-event-input module.

    Defined in alloy-ui/src/aui-event/js/aui-event-input.js:97

    Implementation logic for cleaning up a detached delegate subscription.

    Parameters:

    • node Object
    • subscription Object
    • notifier Object

    hasModifier

    () Boolean

    Provided by the aui-event-base module.

    Defined in alloy-ui/src/aui-event/js/aui-event-base.js:240

    Checks if an event is triggered by a keyboard key like CTRL, ALT or SHIFT.

    Returns:

    Boolean:

    initializer

    () protected

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

    Constructor for the A.FormBuilderFieldBase component. Lifecycle.

    isKey

    (
    • name
    )
    Boolean

    Provided by the aui-event-base module.

    Defined in alloy-ui/src/aui-event/js/aui-event-base.js:253

    Checks if an event is triggered by a keyboard key.

    Parameters:

    • name Object

    Returns:

    Boolean:

    isKeyInRange

    (
    • start
    • end
    )
    Boolean

    Provided by the aui-event-base module.

    Defined in alloy-ui/src/aui-event/js/aui-event-base.js:266

    Checks if an event is triggered by a keyboard key located between two other keys.

    Parameters:

    • start Object
    • end Object

    Returns:

    Boolean:

    isKeyInSet

    () Boolean

    Provided by the aui-event-base module.

    Defined in alloy-ui/src/aui-event/js/aui-event-base.js:281

    Checks if an event is triggered by a keyboard key contained in the key set.

    Returns:

    Boolean:

    isModifyingKey

    ()

    Provided by the aui-event-base module.

    Defined in alloy-ui/src/aui-event/js/aui-event-base.js:296

    Checks if an event is triggered by ENTER, TAB, ESC keyboard keys or by a key located between PAGE UP and DOWN.

    isNavKey

    () Boolean

    Provided by the aui-event-base module.

    Defined in alloy-ui/src/aui-event/js/aui-event-base.js:308

    Checks if an event is triggered by navigation keys like PAGE UP and DOWN keys.

    Returns:

    Boolean:

    isSpecialKey

    () Boolean

    Provided by the aui-event-base module.

    Defined in alloy-ui/src/aui-event/js/aui-event-base.js:321

    Checks if an event is triggered by a special keyboard key like SHIFT, CAPS LOCK, etc.

    Returns:

    Boolean:

    on

    (
    • node
    • subscription
    • notifier
    )

    Provided by the aui-event-input module.

    Defined in alloy-ui/src/aui-event/js/aui-event-input.js:42

    Implementation logic for event subscription.

    Parameters:

    • node Object
    • subscription Object
    • notifier Object

    on

    (
    • node
    • subscription
    • notifier
    )

    Provided by the aui-event-delegate-submit module.

    Defined in alloy-ui/src/aui-event/js/aui-event-delegate-submit.js:82

    Implementation logic for event subscription.

    Parameters:

    • node Object
    • subscription Object
    • notifier Object

    on

    (
    • node
    • subscription
    • notifier
    )

    Provided by the aui-event-delegate-change module.

    Defined in alloy-ui/src/aui-event/js/aui-event-delegate-change.js:62

    Implementation logic for event subscription.

    Parameters:

    • node Object
    • subscription Object
    • notifier Object

    renderAdvancedSettings

    ()

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:103

    Renders the advanced settings on panel.

    renderBasicSettings

    ()

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:125

    Renders the basic settings on panel.

    renderSetting

    (
    • setting
    • targetNode
    )
    protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:140

    Renders a single field setting to be edited.

    Parameters:

    • setting Object
    • targetNode Node

    renderSettingsPanel

    (
    • container
    )

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

    Renders the settings panel.

    Parameters:

    • container Node

      The container where the panel should be rendered.

    saveSettings

    ()

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:175

    Saves the edited settings.

    validateSettings

    () Boolean

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:194

    Validates all data editors used by this field's settings.

    Returns:

    Boolean:

    Attributes

    strings

    Object

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:386

    Collection of strings used to label elements of the UI.

    Events

    change

    Provided by the aui-event-delegate-change module.

    Defined in alloy-ui/src/aui-event/js/aui-event-delegate-change.js:11

    Defines a new change event in the DOM event system.

    contentToggle

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:28

    Fired when toggle the modal content.

    input

    Provided by the aui-event-input module.

    Defined in alloy-ui/src/aui-event/js/aui-event-input.js:35

    Defines a new input event in the DOM event system.

    submit

    Provided by the aui-event-delegate-submit module.

    Defined in alloy-ui/src/aui-event/js/aui-event-delegate-submit.js:12

    Defines a new submit event in the DOM event system.