Adaptive Forms (Core Components)

Class: FormPanel

FormView~ FormPanel

FormPanel class represents a panel within a form.

new FormPanel(params)

Creates an instance of FormPanel.

Parameters:
Name Type Description
params Object

The parameters for initializing the FormPanel.

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

instantiateInstanceManager()

Instantiates the InstanceManager for the FormPanel.

Returns:

The newly instantiated InstanceManager.

Type
InstanceManager

setModel(model)

Sets the model for the FormPanel.

Parameters:
Name Type Description
model Object

The model to be set for the FormPanel.
Overrides:

setFocus(id)

Sets the focus to a child element within the FormPanel.

Parameters:
Name Type Description
id string

The ID of the child element to set focus to.
Overrides:

addChild(childView)

Adds a child view to the FormPanel.

Parameters:
Name Type Description
childView Object

The child view to be added.

getCountOfAllChildrenInModel()

Gets the count of all children in the model.

Returns:

The count of all children in the model.

Type
number

getChild(id)

Gets a child view by its ID.

Parameters:
Name Type Description
id string

The ID of the child view to retrieve.
Returns:

The child view with the specified ID.

Type
Object

handleChildAddition(childView)

Handles the addition of a child view. This method needs to be implemented in tabs, accordion, and wizard.

Parameters:
Name Type Description
childView Object

The child view that was added.

handleChildRemoval(childView)

Handles the removal of a child view. This method needs to be implemented in tabs, accordion, and wizard.

Parameters:
Name Type Description
childView Object

The child view that was removed.

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 to be applied.
Overrides:

getChildViewByIndex(index)

Gets the child view at the specified index. This method needs to be implemented in every layout.

Parameters:
Name Type Description
index number

The index of the child view.

getIndexToInsert(closestNonRepeatableFieldId, closestRepeatableFieldInstanceManagerIds)

Gets the index at which to insert a new field.

Parameters:
Name Type Description
closestNonRepeatableFieldId string

The ID of the closest non-repeatable field.
closestRepeatableFieldInstanceManagerIds Array:.<string:>

The IDs of the closest repeatable field instance managers.
Returns:

The index at which to insert the new field.

Type
number

getRepeatableRootElement(childView)

Gets the repeatable root element of a child view.

Parameters:
Name Type Description
childView Object

The child view.
Returns:

The repeatable root element.

Type
HTMLElement

updateChildVisibility(visible, state)

Updates the visibility of a child element. This method needs to be implemented in individual layouts.

Parameters:
Name Type Description
visible boolean

The visibility state of the child element.
state Object

The state object.

findFirstVisibleChild(children)

Finds the first visible child element from the given children.

Parameters:
Name Type Description
children Array:.<HTMLElement:>

The children elements to search.
Returns:

The first visible child element, or null if none found.

Type
HTMLElement

updateEmptyStatus()

Updates the HTML class based on the existence of a value in a field. For the layout components, there's no need to do this, so override the updateEmptyStatus method.

Overrides:

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

syncMarkupWithModel()

Synchronizes the markup with the model.

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:

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:

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:

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

updateEnabled(enable)

Updates the HTML state based on the enable state of the panel.

Parameters:
Name Type Description
enable boolean

The enable state of the panel.
Inherited From:
Overrides:

updateValid(valid, state)

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

Parameters:
Name Type Description
valid boolean

The valid state of the panel.
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 panel.

Parameters:
Name Type Description
validity object

The validity state of the panel.
state Object

The state object.
Inherited From:
Overrides: