AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    A.FormBuilderFieldChoice Class

    Uses:
    Extends: A.FormFieldChoice
    Defined in: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-choice.js:8
    Module: aui-form-builder-field-choice
    Parent Module: aui-form-builder

    A base class for Form Builder Field Choice.

    Constructor

    A.FormBuilderFieldChoice

    (
    • config
    )

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

    Parameters:

    • config Object

      Object literal specifying widget configuration properties.

    Methods

    _afterAdvancedSettingsChange

    () protected

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:215

    <p>Fired after the a advanced settings change.</p>

    _afterExpandedChange

    (
    • event
    )
    protected

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:225

    <p>Fired after the a Toggler of Advanced Settings change.</p>

    Parameters:

    _afterHelpChange

    () protected

    Inherited from A.FormField: alloy-ui/src/aui-form-field/js/aui-form-field.js:122

    Fired after the help attribute is set.

    _afterNestedFieldsChange

    () protected

    Inherited from A.FormField: alloy-ui/src/aui-form-field/js/aui-form-field.js:132

    Fired after the nestedFields attribute is set.

    _afterOptionsChange

    () protected

    Inherited from A.FormFieldChoice: alloy-ui/src/aui-form-field/js/aui-form-field-choice.js:83

    Fired after the options attribute is set.

    _afterOtherOptionChange

    () protected

    Inherited from A.FormFieldChoice: alloy-ui/src/aui-form-field/js/aui-form-field-choice.js:93

    Fired after the otherOption attribute is set.

    _afterTitleChange

    () protected

    Inherited from A.FormField: alloy-ui/src/aui-form-field/js/aui-form-field.js:142

    Fired after the title attribute is set.

    _afterTypeChange

    () protected

    Inherited from A.FormFieldChoice: alloy-ui/src/aui-form-field/js/aui-form-field-choice.js:103

    Fired after the type attribute is set.

    _attachEvent

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

    Inherited from A.FormBuilderFieldBase but overwritten in alloy-ui/src/aui-event/js/aui-event-delegate-change.js:76

    <p>Adds an event subscription.</p>

    Parameters:

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

    _attachEvents

    (
    • node
    • subscription
    • notifier
    • filter
    )
    protected

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-event/js/aui-event-delegate-change.js:127

    <p>Adds an event subscription.</p>

    Parameters:

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

    _cleanOptionsContainer

    () protected

    Inherited from A.FormFieldChoice: alloy-ui/src/aui-form-field/js/aui-form-field-choice.js:113

    Remove all option element from ui.

    _createAdvancedSettingsToggler

    () protected

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:236

    <p>Create a Toggler with the advanced settings.</p>

    _createMoveTarget

    (
    • position
    )
    Node protected

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

    <p>Creates a move target node.</p>

    Parameters:

    • position Number

      <p>The position where the moved field will be added if this is the chosen target.</p>

    Returns:

    Node:

    _createOptionNode

    (
    • optionLabel
    )
    Node protected

    Inherited from A.FormFieldChoice: alloy-ui/src/aui-form-field/js/aui-form-field-choice.js:123

    Create a option node.

    Parameters:

    • optionLabel String

    Returns:

    Node:

    A new Option Node

    _detachEvents

    (
    • node
    • subscription
    • notifier
    )
    protected

    Inherited from A.FormBuilderFieldBase but overwritten in alloy-ui/src/aui-event/js/aui-event-delegate-change.js:153

    <p>Deletes a group of event subscriptions.</p>

    Parameters:

    • node Object
    • subscription Object
    • notifier Object

    _dispatchEvent

    (
    • subscription
    • notifier
    • event
    )
    protected

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-event/js/aui-event-input.js:116

    <p>Dispatches an <code>input</code> event.</p>

    Parameters:

    • subscription Object
    • notifier Object
    • event Object

    _fillAdvancedSettings

    () protected

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

    Fills the advanced settings array with the information for this field.

    _fillSettings

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-choice.js:19

    Fills the settings array with the information for this field.

    _fireEvent

    (
    • subscription
    • notifier
    • event
    • valueBeforeKey
    )
    protected

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-event/js/aui-event-input.js:152

    <p>Fires an event.</p>

    Parameters:

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

    _getAdvancedSettings

    () Array protected

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:276

    <p>Gets the list of advanced settings for this field.</p>

    Returns:

    Array:

    _getEventName

    () protected

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-event/js/aui-event-delegate-change.js:178

    <p>Gets an event name.</p>

    _getFormClass

    (
    • type
    )
    String

    Inherited from A.FormFieldChoice: alloy-ui/src/aui-form-field/js/aui-form-field-choice.js:146

    Gets the appropriate css class to form for the given type.

    Parameters:

    • type String

    Returns:

    String:

    _getNodeName

    (
    • elem
    • name
    )
    protected

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-event/js/aui-event-delegate-submit.js:182

    <p>Gets a node name.</p>

    Parameters:

    • elem Object
    • name Object

    _getSettings

    () Array protected

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

    <p>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.</p>

    Returns:

    Array:

    _hasParent

    (
    • node
    • testParentNode
    )
    protected

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-event/js/aui-event-delegate-submit.js:196

    <p>Checks if a node has parent.</p>

    Parameters:

    • node Object
    • testParentNode Object

    _prepareHandles

    (
    • subscription
    • node
    )
    protected

    Inherited from A.FormBuilderFieldBase but overwritten in alloy-ui/src/aui-event/js/aui-event-delegate-change.js:200

    <p>Prepares event handles.</p>

    Parameters:

    • subscription Object
    • node Object

    _setFormType

    (
    • type
    )
    protected

    Inherited from A.FormFieldChoice: alloy-ui/src/aui-form-field/js/aui-form-field-choice.js:162

    Switch option type between radio and checkbox.

    Parameters:

    • type String

    _toggleVisibilityOfModalContent

    () protected

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:355

    <p>Toggle visibility classes on Modal Content.</p>

    _uiSetHelp

    (
    • help
    )
    protected

    Inherited from A.FormField: 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

    Inherited from A.FormField but overwritten in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:365

    <p>Updates the UI according to the value of the <code>nestedFields</code> attribute.</p>

    Parameters:

    • nestedFields Array

    _uiSetOptions

    (
    • options
    )
    protected

    Inherited from A.FormFieldChoice: alloy-ui/src/aui-form-field/js/aui-form-field-choice.js:182

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

    Parameters:

    • options Array

    _uiSetOtherOption

    (
    • otherOption
    )
    protected

    Inherited from A.FormFieldChoice: alloy-ui/src/aui-form-field/js/aui-form-field-choice.js:205

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

    Parameters:

    • otherOption Boolean

    _uiSetTitle

    (
    • title
    )
    protected

    Inherited from A.FormField: 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

    _uiSetType

    (
    • type
    )
    protected

    Inherited from A.FormFieldChoice: alloy-ui/src/aui-form-field/js/aui-form-field-choice.js:228

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

    Parameters:

    • type String

    _updateAdvancedSettingsChange

    () protected

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:332

    <p>Updates the UI according to the values of the Advanced Settings.</p>

    _updateOptionsContainer

    () protected

    Inherited from A.FormFieldChoice: alloy-ui/src/aui-form-field/js/aui-form-field-choice.js:248

    Set a new options container based on type attribute.

    _validateNestedFields

    (
    • val
    )
    protected

    Inherited from A.FormField: 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
    )

    Inherited from A.FormField: alloy-ui/src/aui-form-field/js/aui-form-field.js:89

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

    Parameters:

    collapseModalContent

    ()

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:94

    <p>Collapse Advanced Settings Content.</p>

    delegate

    (
    • node
    • subscription
    • notifier
    • filter
    )

    Inherited from A.FormBuilderFieldBase but overwritten in alloy-ui/src/aui-event/js/aui-event-delegate-change.js:18

    <p>Implementation logic for subscription via <code>node.delegate</code>.</p>

    Parameters:

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

    destructor

    () protected

    Inherited from A.FormField: alloy-ui/src/aui-form-field/js/aui-form-field.js:76

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

    detach

    (
    • node
    • subscription
    • notifier
    )

    Inherited from A.FormBuilderFieldBase but overwritten in alloy-ui/src/aui-event/js/aui-event-delegate-change.js:33

    <p>Implementation logic for cleaning up a detached subscription.</p>

    Parameters:

    • node Object
    • subscription Object
    • notifier Object

    detachDelegate

    (
    • node
    • subscription
    • notifier
    )

    Inherited from A.FormBuilderFieldBase but overwritten in alloy-ui/src/aui-event/js/aui-event-delegate-change.js:47

    <p>Implementation logic for cleaning up a detached delegate subscription.</p>

    Parameters:

    • node Object
    • subscription Object
    • notifier Object

    hasModifier

    () Boolean

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-event/js/aui-event-base.js:240

    <p>Checks if an event is triggered by a keyboard key like <code>CTRL</code>, <code>ALT</code> or <code>SHIFT</code>.</p>

    Returns:

    Boolean:

    initializer

    () protected

    Inherited from A.FormField but overwritten in alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:69

    <p>Constructor for the <code>A.FormBuilderFieldBase</code> component. Lifecycle.</p>

    isKey

    (
    • name
    )
    Boolean

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-event/js/aui-event-base.js:253

    <p>Checks if an event is triggered by a keyboard key.</p>

    Parameters:

    • name Object

    Returns:

    Boolean:

    isKeyInRange

    (
    • start
    • end
    )
    Boolean

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-event/js/aui-event-base.js:266

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

    Parameters:

    • start Object
    • end Object

    Returns:

    Boolean:

    isKeyInSet

    () Boolean

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-event/js/aui-event-base.js:281

    <p>Checks if an event is triggered by a keyboard key contained in the key set.</p>

    Returns:

    Boolean:

    isModifyingKey

    ()

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-event/js/aui-event-base.js:296

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

    isNavKey

    () Boolean

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-event/js/aui-event-base.js:308

    <p>Checks if an event is triggered by navigation keys like <code>PAGE UP</code> and <code>DOWN</code> keys.</p>

    Returns:

    Boolean:

    isSpecialKey

    () Boolean

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-event/js/aui-event-base.js:321

    <p>Checks if an event is triggered by a special keyboard key like <code>SHIFT</code>, <code>CAPS LOCK</code>, etc.</p>

    Returns:

    Boolean:

    on

    (
    • node
    • subscription
    • notifier
    )

    Inherited from A.FormBuilderFieldBase but overwritten in alloy-ui/src/aui-event/js/aui-event-delegate-change.js:62

    <p>Implementation logic for event subscription.</p>

    Parameters:

    • node Object
    • subscription Object
    • notifier Object

    removeNestedField

    (
    • field
    )

    Inherited from A.FormField: alloy-ui/src/aui-form-field/js/aui-form-field.js:104

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

    Parameters:

    renderAdvancedSettings

    ()

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:103

    <p>Renders the advanced settings on panel.</p>

    renderBasicSettings

    ()

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:125

    <p>Renders the basic settings on panel.</p>

    renderSetting

    (
    • setting
    • targetNode
    )
    protected

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:140

    <p>Renders a single field setting to be edited.</p>

    Parameters:

    • setting Object
    • targetNode Node

    renderSettingsPanel

    (
    • container
    )

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:157

    <p>Renders the settings panel.</p>

    Parameters:

    • container Node

      <p>The container where the panel should be rendered.</p>

    renderUI

    () protected

    Inherited from A.FormField but overwritten in alloy-ui/src/aui-form-field/js/aui-form-field-choice.js:66

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

    saveSettings

    ()

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:175

    <p>Saves the edited settings.</p>

    validateSettings

    () Boolean

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:194

    <p>Validates all data editors used by this field's settings.</p>

    Returns:

    Boolean:

    Attributes

    content

    Node

    Inherited from A.FormField: alloy-ui/src/aui-form-field/js/aui-form-field.js:226

    Node containing the contents of this field.

    help

    String

    Inherited from A.FormField: alloy-ui/src/aui-form-field/js/aui-form-field.js:242

    Help text.

    Default: ''

    name

    String

    Inherited from A.FormFieldChoice: alloy-ui/src/aui-form-field/js/aui-form-field-choice.js:280

    Id to reference form data after a form is submitted.

    Default: ''

    nestedFields

    Array

    Inherited from A.FormField: alloy-ui/src/aui-form-field/js/aui-form-field.js:255

    The fields that are nested inside this field.

    Default: []

    options

    String

    Inherited from A.FormFieldChoice: alloy-ui/src/aui-form-field/js/aui-form-field-choice.js:292

    The options that can be chosen.

    Default: []

    otherOption

    Boolean

    Inherited from A.FormFieldChoice: alloy-ui/src/aui-form-field/js/aui-form-field-choice.js:304

    If there should be a special "Other" option.

    Default: false

    strings

    Object

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:386

    <p>Collection of strings used to label elements of the UI.</p>

    title

    String

    Inherited from A.FormField: alloy-ui/src/aui-form-field/js/aui-form-field.js:267

    The title of this field.

    Default: ''

    Events

    change

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-event/js/aui-event-delegate-change.js:11

    <p>Defines a new <code>change</code> event in the DOM event system.</p>

    contentToggle

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-form-builder/js/aui-form-builder-field-base.js:28

    <p>Fired when toggle the modal content.</p>

    input

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-event/js/aui-event-input.js:35

    <p>Defines a new <code>input</code> event in the DOM event system.</p>

    submit

    Inherited from A.FormBuilderFieldBase: alloy-ui/src/aui-event/js/aui-event-delegate-submit.js:12

    <p>Defines a new <code>submit</code> event in the DOM event system.</p>