AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    A.OptionsDataEditor Class

    Extends: A.DataEditor
    Defined in: alloy-ui/src/aui-data-editor/js/aui-options-data-editor.js:17
    Module: aui-options-data-editor

    A base class for Options Data Editor.

    Constructor

    A.OptionsDataEditor

    (
    • config
    )

    Defined in alloy-ui/src/aui-data-editor/js/aui-options-data-editor.js:17

    Parameters:

    • config Object

      Object literal specifying widget configuration properties.

    Methods

    _afterClickAddButton

    () protected

    Defined in alloy-ui/src/aui-data-editor/js/aui-options-data-editor.js:89

    Fired after the button for adding options is clicked.

    _afterEditedValueChange

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-data-editor/js/aui-options-data-editor.js:107

    Fired after the editedValue attribute is set.

    Parameters:

    _afterLabelChange

    () protected

    Inherited from A.DataEditor: alloy-ui/src/aui-data-editor/js/aui-data-editor.js:89

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

    _afterRequiredChange

    () protected

    Inherited from A.DataEditor: alloy-ui/src/aui-data-editor/js/aui-data-editor.js:99

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

    _afterVisibleChange

    () protected

    Inherited from A.DataEditor: alloy-ui/src/aui-data-editor/js/aui-data-editor.js:109

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

    _createOptionNode

    (
    • text
    )
    Node protected

    Defined in alloy-ui/src/aui-data-editor/js/aui-options-data-editor.js:120

    Creates an option node.

    Parameters:

    • text String

    Returns:

    Node:

    _getOptionNodeIndex

    (
    • node
    )
    protected

    Defined in alloy-ui/src/aui-data-editor/js/aui-options-data-editor.js:137

    Gets the option node's index in the options list.

    Parameters:

    _moveItem

    (
    • from
    • to
    )
    protected

    Defined in alloy-ui/src/aui-data-editor/js/aui-options-data-editor.js:151

    Moves the item from an index to another in the items array.

    Parameters:

    _onClickRemoveButton

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-data-editor/js/aui-options-data-editor.js:174

    Fired when a button for removing an option is clicked.

    Parameters:

    _onDrag

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-data-editor/js/aui-options-data-editor.js:211

    Fired after the drag:drag event is triggered.

    Parameters:

    _onDragOver

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-data-editor/js/aui-options-data-editor.js:228

    Fired after the drag:over event is triggered.

    Parameters:

    _onValueChange

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-data-editor/js/aui-options-data-editor.js:194

    Fired when the value of one of the editors text fields changes.

    Parameters:

    _removeOptionNode

    (
    • optionNode
    )
    protected

    Defined in alloy-ui/src/aui-data-editor/js/aui-options-data-editor.js:252

    Removes the given option node.

    Parameters:

    _setUpDrag

    () protected

    Defined in alloy-ui/src/aui-data-editor/js/aui-options-data-editor.js:264

    Sets up everything needed for dragging options to different positions.

    _uiSetEditedValue

    (
    • editedValue
    )
    protected

    Defined in alloy-ui/src/aui-data-editor/js/aui-options-data-editor.js:288

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

    Parameters:

    • editedValue Array

    _uiSetLabel

    (
    • label
    )
    protected

    Inherited from A.DataEditor: alloy-ui/src/aui-data-editor/js/aui-data-editor.js:119

    <p>Updates the ui according to the value of the <code>label</code> attribute.</p>

    Parameters:

    • label String

    _uiSetRequired

    (
    • required
    )
    protected

    Inherited from A.DataEditor: alloy-ui/src/aui-data-editor/js/aui-data-editor.js:133

    <p>Updates the ui according to the value of the <code>required</code> attribute.</p>

    Parameters:

    • required Object

    _uiSetVisible

    (
    • visible
    )
    protected

    Inherited from A.DataEditor: alloy-ui/src/aui-data-editor/js/aui-data-editor.js:151

    <p>Updates the ui according to the value of the <code>visible</code> attribute.</p>

    Parameters:

    • visible Object

    destructor

    () protected

    Inherited from A.DataEditor: alloy-ui/src/aui-data-editor/js/aui-data-editor.js:55

    <p>Destructor lifecycle implementation for the <code>A.DataEditor</code> class. Lifecycle.</p>

    initializer

    () protected

    Inherited from A.DataEditor but overwritten in alloy-ui/src/aui-data-editor/js/aui-options-data-editor.js:35

    Constructor for the A.OptionsDataEditor. Lifecycle.

    isEmpty

    () Boolean

    Inherited from A.DataEditor but overwritten in alloy-ui/src/aui-data-editor/js/aui-options-data-editor.js:54

    Returns true if this edited value has no elements.

    Returns:

    Boolean:

    isValid

    () Boolean

    Inherited from A.DataEditor but overwritten in alloy-ui/src/aui-data-editor/js/aui-options-data-editor.js:64

    If the Option Data Editor has a String in each option field this will return true.

    Returns:

    Boolean:

    Properties

    ATTRS

    Object static

    Defined in alloy-ui/src/aui-data-editor/js/aui-options-data-editor.js:308

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

    Attributes

    editedValue

    Boolean

    Inherited from A.DataEditor but overwritten in alloy-ui/src/aui-data-editor/js/aui-options-data-editor.js:317

    The value after edition.

    Default: []

    label

    String

    Inherited from A.DataEditor: alloy-ui/src/aui-data-editor/js/aui-data-editor.js:187

    <p>The label to be used by this boolean editor.</p>

    Default: ''

    node

    Node

    Inherited from A.DataEditor: alloy-ui/src/aui-data-editor/js/aui-data-editor.js:198

    <p>The node where the editor UI is rendered.</p>

    originalValue

    Array

    Inherited from A.DataEditor but overwritten in alloy-ui/src/aui-data-editor/js/aui-options-data-editor.js:328

    The value to be edited.

    Default: []

    required

    Inherited from A.DataEditor: alloy-ui/src/aui-data-editor/js/aui-data-editor.js:224

    <p>Defines if the data editor is required or not.</p>

    Default: false

    strings

    Object

    Inherited from A.DataEditor but overwritten in alloy-ui/src/aui-data-editor/js/aui-options-data-editor.js:339

    Collection of strings used to label elements of the UI.

    visible

    Boolean

    Inherited from A.DataEditor: alloy-ui/src/aui-data-editor/js/aui-data-editor.js:248

    <p>Determines if <code>DataEditor</code> is visible or not.</p>

    Default: false