Adaptive Forms (Core Components)

Class: FormOptionFieldBase

FormView~ FormOptionFieldBase

Class containing common view code for dropdown, checkboxgroup and radiobutton

new FormOptionFieldBase()

Extends

Members

ELEMENT_FOCUS_CHANGED :string

Event constant for element focus change.

Type:
  • string
Inherited From:
Overrides:

ELEMENT_HELP_SHOWN :string

Event constant for element help shown.

Type:
  • string
Inherited From:
Overrides:

ELEMENT_ERROR_SHOWN :string

Event constant for element error shown.

Type:
  • string
Inherited From:
Overrides:

ELEMENT_VALUE_CHANGED :string

Event constant for value change.

Type:
  • string
Inherited From:
Overrides:

Methods

updateEnum(enums)

Placeholder method for updating the saved value in the option field. This method is intended to be overridden by the child class. The overriding method should contain the logic for updating the 'enum' value.

Parameters:
Name Type Description
enums Array

An array of primitive values to be saved in the option field.

updateEnumNames(enumNames)

Placeholder method for updating the display value in the option field. This method is intended to be overridden by the child class. The overriding method should contain the logic for updating the 'enumNames' value.

Parameters:
Name Type Description
enumNames Array

An array of display values for the option field.

applyState(state)

Applies the full state of the field to the HTML. Generally done just after the model is bound to the field.

Parameters:
Name Type Description
state Object

The state object.
Overrides:

updateEnumForRadioButtonAndCheckbox(newEnums, createItemCallback)

Common method to update the enums of checkbox and radiobutton

Parameters:
Name Type Description
newEnums Array

updated enum values
createItemCallback CallableFunction

function to create options

updateEnumNamesForRadioButtonAndCheckbox(newEnumsNames, createItemCallback)

Common method to update the enums Names of checkbox and radiobutton

Parameters:
Name Type Description
newEnumsNames Array

updated enum Names values
createItemCallback CallableFunction

function to create options

getWidget()

Gets the widget element used to capture the value from the user. Implementations should return the widget element that is used to capture the value from the user.

Inherited From:
Overrides:
Throws:

Throws an error if the method is not implemented.

Type
string
Returns:
  • The widget element.
Type
HTMLElement

getDescription()

Gets the element used to show the description of the field. Implementations should return the description element that is used to capture the description

Inherited From:
Overrides:
Throws:

Throws an error if the method is not implemented.

Type
string
Returns:
  • The description element.
Type
HTMLElement

getLabel()

Gets the element used to show the label of the field. Implementations should return the label element that is used to capture the label

Inherited From:
Overrides:
Throws:

Throws an error if the method is not implemented.

Type
string
Returns:
  • The label element.
Type
HTMLElement

getErrorDiv()

Gets the element used to show the error on the field. Implementations should return the error element that is used to capture the error

Inherited From:
Overrides:
Throws:

Throws an error if the method is not implemented.

Type
string
Returns:
  • The error element.
Type
HTMLElement

getTooltipDiv()

Gets the tooltip / short description div. Implementations should return the tooltip element that is used to capture the tooltip or short description

Inherited From:
Overrides:
Throws:

Throws an error if the method is not implemented.

Type
string
Returns:
  • The tooltip element.
Type
HTMLElement

getQuestionMarkDiv()

Gets the question mark div. Implementations should return the question mark element

Inherited From:
Overrides:
Throws:

Throws an error if the method is not implemented.

Type
string
Returns:
  • The question mark element.
Type
HTMLElement

getClass()

Gets the class of the form field.

Inherited From:
Overrides:
Returns:
  • The class of the form field.
Type
string

setModel(model)

Sets the model for the form field.

Parameters:
Name Type Description
model object

The model object.
Inherited From:
Overrides:

syncMarkupWithModel()

Synchronizes the markup with the model.

Inherited From:
Overrides:

setFocus(id)

Sets the focus on the component's widget.

Parameters:
Name Type Description
id string

The ID of the component's widget.
Inherited From:
Overrides:

initializeHelpContent(state)

Initializes the hint ('?') and long description.

Parameters:
Name Type Description
state Object

The state object.
Inherited From:
Overrides:

updateVisible(visible, state)

Updates the HTML based on the visible state.

Parameters:
Name Type Description
visible boolean

The visible state.
state Object

The state object.
Inherited From:
Overrides:

updateEnabled(enabled, state)

Updates the HTML state based on the enabled state of the field.

Parameters:
Name Type Description
enabled boolean

The enabled state.
state Object

The state object.
Inherited From:
Overrides:

updateReadOnly(readOnly, state)

Updates the HTML state based on the read-only state of the field.

Parameters:
Name Type Description
readOnly boolean

The read-only state.
state Object

The state object.
Inherited From:
Overrides:

updateRequired(required, state)

Updates the HTML state based on the required state of the field.

Parameters:
Name Type Description
required boolean

The required state.
state Object

The state object.
Inherited From:
Overrides:

updateValid(valid, state)

Updates the HTML state based on the valid state of the field.

Parameters:
Name Type Description
valid boolean

The valid state.
state Object

The state object.
Inherited From:
Overrides:
Deprecated:
  • Use the new method updateValidity() instead.

updateValidity(validity, state)

Updates the HTML state based on the validity state of the field.

Parameters:
Name Type Description
validity Object

The validity state.
state Object

The state object.
Inherited From:
Overrides:

updateErrorMessage(errorMessage, state)

Updates the HTML state based on the error message state of the field.

Parameters:
Name Type Description
errorMessage string

The error message.
state Object

The state object.
Inherited From:
Overrides:
Deprecated:
  • Use the new method updateValidationMessage() instead.

updateValidationMessage(validationMessage, state)

Updates the HTML state based on the validation message state of the field.

Parameters:
Name Type Description
validationMessage string

The validation message.
state Object

The state object.
Inherited From:
Overrides:

updateValue(value)

Updates the HTML state based on the value state of the field.

Parameters:
Name Type Description
value any

The value.
Inherited From:
Overrides:

updateEmptyStatus()

Updates the HTML class based on the existence of a value in a field.

Inherited From:
Overrides:

updateLabel(label)

Updates the HTML state based on the label state of the field.

Parameters:
Name Type Description
label Object

The label.
Inherited From:
Overrides:

updateActiveChild(activeChild)

Updates the active child of the form container.

Parameters:
Name Type Description
activeChild Object

The active child.
Inherited From:
Overrides:

updateDescription(descriptionText)

Updates the HTML state based on the description state of the field.

Parameters:
Name Type Description
descriptionText string

The description.
Inherited From:
Overrides:

setId(id)

Sets the ID of the form field.

Parameters:
Name Type Description
id string

The ID to set for the form field.
Inherited From:
Overrides:

setParent(parentView)

Sets the parent view of the form field.

Parameters:
Name Type Description
parentView object

The parent view to set for the form field.
Inherited From:
Overrides:

setInstanceManager(instanceManager)

Sets the instance manager for the form field.

Parameters:
Name Type Description
instanceManager object

The instance manager to set for the form field.
Inherited From:
Overrides:

setActive()

Sets the form field as active.

Inherited From:
Overrides:

setInactive()

Sets the form field as inactive.

Inherited From:
Overrides:

isActive()

Checks if the form field is active.

Inherited From:
Overrides:
Returns:

True if the form field is active, false otherwise.

Type
boolean

getFormContainerPath()

Returns the form container path of the form field.

Inherited From:
Overrides:
Returns:

The form container path.

Type
string

getId()

Returns the ID of the form field.

Inherited From:
Overrides:
Returns:

The form field ID.

Type
string

toggle(property, dataAttribute, value)

Toggles the HTML element based on the property. If the property is false, then adds the data-attribute and CSS class.

Parameters:
Name Type Description
property boolean

The property to toggle.
dataAttribute string

The data attribute to set or remove.
value string

The value to set for the data attribute.
Inherited From:
Overrides:

toggleAttribute(element, property, dataAttribute, value)

Toggles the given element based on the property. If the property is false, then adds the data-attribute and CSS class.

Parameters:
Name Type Description
element HTMLElement

The element to toggle.
property boolean

The property to toggle.
dataAttribute string

The data attribute to set or remove.
value string

The value to set for the data attribute.
Inherited From:
Overrides:

getLayoutProperties()

Returns the 'afs:layout' properties. Empty object if no layout property is present.

Inherited From:
Overrides:
Returns:

The 'afs:layout' properties.

Type
object

getModel()

Returns the model of the form field.

Inherited From:
Overrides:
Returns:

The model of the form field.

Type
object

getInstanceManager()

Returns the instance manager of the form field.

Inherited From:
Overrides:
Returns:

The instance manager of the form field.

Type
object