Show:

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

Constructor

A.FormBuilderFieldBase

(
  • config
)

Parameters:

  • config Object

    Object literal specifying widget configuration properties.

Methods

_afterAdvancedSettingsChange

() protected

Fired after the a advanced settings change.

_afterExpandedChange

(
  • event
)
protected

Fired after the a Toggler of Advanced Settings change.

Parameters:

_attachEvent

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

Adds an event subscription.

Parameters:

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

_attachEvent

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

Adds an event subscription.

Parameters:

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

_attachEvents

(
  • node
  • subscription
  • notifier
  • filter
)
protected

Adds an event subscription.

Parameters:

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

_createAdvancedSettingsToggler

() protected

Create a Toggler with the advanced settings.

_createMoveTarget

(
  • position
)
Node protected

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

Deletes a group of event subscriptions.

Parameters:

  • node Object
  • subscription Object
  • notifier Object

_detachEvents

(
  • node
  • subscription
  • notifier
)
protected

Deletes a group of event subscriptions.

Parameters:

  • node Object
  • subscription Object
  • notifier Object

_dispatchEvent

(
  • subscription
  • notifier
  • event
)
protected

Dispatches an input event.

Parameters:

  • subscription Object
  • notifier Object
  • event Object

_fireEvent

(
  • subscription
  • notifier
  • event
  • valueBeforeKey
)
protected

Fires an event.

Parameters:

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

_getAdvancedSettings

() Array protected

Gets the list of advanced settings for this field.

Returns:

Array:

_getEventName

() protected

Gets an event name.

_getNodeName

(
  • elem
  • name
)
protected

Gets a node name.

Parameters:

  • elem Object
  • name Object

_getSettings

() Array protected

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

Checks if a node has parent.

Parameters:

  • node Object
  • testParentNode Object

_prepareHandles

(
  • subscription
  • node
)
protected

Prepares event handles.

Parameters:

  • subscription Object
  • node Object

_prepareHandles

(
  • subscription
  • node
)
protected

Prepares event handles.

Parameters:

  • subscription Object
  • node Object

_toggleVisibilityOfModalContent

() protected

Toggle visibility classes on Modal Content.

_uiSetNestedFields

(
  • nestedFields
)
protected

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

Parameters:

  • nestedFields Array

_updateAdvancedSettingsChange

() protected

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

collapseModalContent

()

Collapse Advanced Settings Content.

delegate

(
  • node
  • subscription
  • notifier
  • filter
)

Implementation logic for subscription via node.delegate.

Parameters:

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

delegate

(
  • node
  • subscription
  • notifier
  • filter
)

Implementation logic for subscription via node.delegate.

Parameters:

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

delegate

(
  • node
  • subscription
  • notifier
  • filter
)

Implementation logic for subscription via node.delegate.

Parameters:

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

detach

(
  • node
  • subscription
  • notifier
)

Implementation logic for cleaning up a detached subscription.

Parameters:

  • node Object
  • subscription Object
  • notifier Object

detach

(
  • node
  • subscription
  • notifier
)

Implementation logic for cleaning up a detached subscription.

Parameters:

  • node Object
  • subscription Object
  • notifier Object

detach

(
  • node
  • subscription
  • notifier
)

Implementation logic for cleaning up a detached subscription.

Parameters:

  • node Object
  • subscription Object
  • notifier Object

detachDelegate

(
  • node
  • subscription
  • notifier
)

Implementation logic for cleaning up a detached delegate subscription.

Parameters:

  • node Object
  • subscription Object
  • notifier Object

detachDelegate

(
  • node
  • subscription
  • notifier
)

Implementation logic for cleaning up a detached delegate subscription.

Parameters:

  • node Object
  • subscription Object
  • notifier Object

detachDelegate

(
  • node
  • subscription
  • notifier
)

Implementation logic for cleaning up a detached delegate subscription.

Parameters:

  • node Object
  • subscription Object
  • notifier Object

hasModifier

() Boolean

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

Returns:

Boolean:

initializer

() protected

Constructor for the A.FormBuilderFieldBase component. Lifecycle.

isKey

(
  • name
)
Boolean

Checks if an event is triggered by a keyboard key.

Parameters:

  • name Object

Returns:

Boolean:

isKeyInRange

(
  • start
  • end
)
Boolean

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

Parameters:

  • start Object
  • end Object

Returns:

Boolean:

isKeyInSet

() Boolean

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

Returns:

Boolean:

isModifyingKey

()

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

isNavKey

() Boolean

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

Returns:

Boolean:

isSpecialKey

() Boolean

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

Returns:

Boolean:

on

(
  • node
  • subscription
  • notifier
)

Implementation logic for event subscription.

Parameters:

  • node Object
  • subscription Object
  • notifier Object

on

(
  • node
  • subscription
  • notifier
)

Implementation logic for event subscription.

Parameters:

  • node Object
  • subscription Object
  • notifier Object

on

(
  • node
  • subscription
  • notifier
)

Implementation logic for event subscription.

Parameters:

  • node Object
  • subscription Object
  • notifier Object

renderAdvancedSettings

()

Renders the advanced settings on panel.

renderBasicSettings

()

Renders the basic settings on panel.

renderSetting

(
  • setting
  • targetNode
)
protected

Renders a single field setting to be edited.

Parameters:

  • setting Object
  • targetNode Node

renderSettingsPanel

(
  • container
)

Renders the settings panel.

Parameters:

  • container Node

    The container where the panel should be rendered.

saveSettings

()

Saves the edited settings.

validateSettings

() Boolean

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

Returns:

Boolean:

Attributes

strings

Object

Collection of strings used to label elements of the UI.

Events

change

Defines a new change event in the DOM event system.

contentToggle

Fired when toggle the modal content.

input

Defines a new input event in the DOM event system.

submit

Defines a new submit event in the DOM event system.