A.FormBuilderFieldSentence

Uses:

A.FormBuilderFieldBase

Extends: A.FormField

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

Module: aui-form-builder-field-sentence
Parent Module: aui-form-builder

A base class for Form Builder Field Sentence.

Constructor

`A.FormBuilderFieldSentence`

(

config

)

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

Parameters:

config Object

Object literal specifying widget configuration properties.

Index

Methods

`_afterAdvancedSettingsChange`

() protected

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

Fired after the a advanced settings change.

`_afterExpandedChange`

(

event

)

protected

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

Fired after the a Toggler of Advanced Settings change.

Parameters:

event EventFacade

`_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.

`_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.

`_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

Adds an event subscription.

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

Adds an event subscription.

Parameters:

node Object
subscription Object
notifier Object
filter Object

`_createAdvancedSettingsToggler`

() protected

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

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

Inherited from A.FormBuilderFieldBase but overwritten 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

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

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

Parameters:

subscription Object
notifier Object
event Object

`_fireEvent`

(

subscription
notifier
event
valueBeforeKey

)

protected

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

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

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

Gets an event name.

`_getNodeName`

(

elem
name

)

protected

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

Gets a node name.

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

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

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

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

Prepares event handles.

Parameters:

subscription Object
node Object

`_toggleVisibilityOfModalContent`

() protected

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

Toggle visibility classes on Modal Content.

`_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

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

Parameters:

nestedFields Array

`_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

`_updateAdvancedSettingsChange`

() protected

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

`_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:

index Number
field A.FormField

`collapseModalContent`

()

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

Collapse Advanced Settings Content.

`delegate`

(

node
subscription
notifier
filter

)

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

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

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

Implementation logic for cleaning up a detached subscription.

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

Implementation logic for cleaning up a detached delegate subscription.

Parameters:

node Object
subscription Object
notifier Object

`hasModifier`

() Boolean

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

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

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

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

`isKey`

(

name

)

Boolean

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

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

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

()

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

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

`isNavKey`

() Boolean

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

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

Returns:

Boolean:

`isSpecialKey`

() Boolean

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

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

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

Implementation logic for event subscription.

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:

field A.FormField

`renderAdvancedSettings`

()

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

Renders the advanced settings on panel.

`renderBasicSettings`

()

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

Renders the basic settings on panel.

`renderSetting`

(

setting
targetNode

)

protected

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

)

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

`renderUI`

() protected

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

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

`saveSettings`

()

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

Saves the edited settings.

`validateSettings`

() Boolean

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

`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: ''

`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: []

`strings`

Object

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

Collection of strings used to label elements of the UI.

`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

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

`contentToggle`

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

Fired when toggle the modal content.

`input`

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

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

`submit`

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

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

APIs

A.FormBuilderFieldSentence Class

Constructor

Parameters:

Index

Methods

Attributes

Events

Methods

_afterAdvancedSettingsChange

_afterExpandedChange

Parameters:

_afterHelpChange

_afterNestedFieldsChange

_afterTitleChange

_attachEvent

Parameters:

_attachEvents

Parameters:

_createAdvancedSettingsToggler

_createMoveTarget

Parameters:

Returns:

_detachEvents

Parameters:

_dispatchEvent

Parameters:

_fireEvent

Parameters:

_getAdvancedSettings

Returns:

_getEventName

_getNodeName

Parameters:

_getSettings

Returns:

_hasParent

Parameters:

_prepareHandles

Parameters:

_toggleVisibilityOfModalContent

_uiSetHelp

Parameters:

_uiSetNestedFields

Parameters:

_uiSetTitle

Parameters:

_updateAdvancedSettingsChange

_validateNestedFields

Parameters:

addNestedField

Parameters:

collapseModalContent

delegate

Parameters:

destructor

detach

Parameters:

detachDelegate

Parameters:

hasModifier

Returns:

initializer

isKey

Parameters:

Returns:

isKeyInRange

Parameters:

Returns:

isKeyInSet

Returns:

isModifyingKey

isNavKey

Returns:

isSpecialKey

Returns:

on

Parameters:

removeNestedField

`A.FormBuilderFieldSentence`

`_afterAdvancedSettingsChange`

`_afterExpandedChange`

`_afterHelpChange`

`_afterNestedFieldsChange`

`_afterTitleChange`

`_attachEvent`

`_attachEvents`

`_createAdvancedSettingsToggler`

`_createMoveTarget`

`_detachEvents`

`_dispatchEvent`

`_fireEvent`

`_getAdvancedSettings`

`_getEventName`

`_getNodeName`

`_getSettings`

`_hasParent`

`_prepareHandles`

`_toggleVisibilityOfModalContent`

`_uiSetHelp`

`_uiSetNestedFields`

`_uiSetTitle`

`_updateAdvancedSettingsChange`

`_validateNestedFields`

`addNestedField`

`collapseModalContent`

`delegate`

`destructor`

`detach`

`detachDelegate`

`hasModifier`

`initializer`

`isKey`

`isKeyInRange`

`isKeyInSet`

`isModifyingKey`

`isNavKey`

`isSpecialKey`

`on`

`removeNestedField`

`renderAdvancedSettings`

`renderBasicSettings`

`renderSetting`

`renderSettingsPanel`

`renderUI`

`saveSettings`

`validateSettings`

`content`

`help`

`nestedFields`

`strings`

`title`

`change`

`contentToggle`

`input`

`submit`