Class FormGroup
The class is the central class within the whole form handling. It is the container element for fields and other form elements. A form group can contain other forms, also called sub-forms.
Access to the elements of a form is provided via an index based access or via an associative array access. For example, the field "firstname" can be accessed with the expression "myform.firstname".
| Property | Description |
|---|---|
childCount: Number (read-only) | Returns the number of elements in the form. |
error: String (read-only) | Returns a form-wide error message. |
object: Object (read-only) | The object that was bound to this form group. |
submittedAction: FormAction (read-only) | Returns the action that was submitted with the last request. |
triggeredAction: FormAction (read-only) | Returns the action that was triggered with the last request. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| accept() | The method copies the value from a form into the object, which was previously bound to the form. |
| copyFrom(Object) | The method updates the form with the values from the given object. The method call is basically equivalent to the pipelet UpdateFormWithObject. The method not only copies the value, it also binds the object to the form. |
| copyTo(Object) | The method updates the object with the values from the form. The method call is basically equivalent to the pipelet UpdateObjectWithForm. The method needs a submitted form. |
| getChildCount() | Returns the number of elements in the form. |
| getError() | Returns a form-wide error message. |
| getObject() | The object that was bound to this form group. |
| getSubmittedAction() | Returns the action that was submitted with the last request. |
| getTriggeredAction() | Returns the action that was triggered with the last request. |
clearFormElement, getDynamicHtmlName, getFormId, getHtmlName, getParent, getValidationResult, invalidateFormElement, invalidateFormElement, isValid
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
- childCount: Number
(read-only) Returns the number of elements in the form.
- error: String
(read-only) Returns a form-wide error message. If no error message is present the method returns null.
- object: Object
(read-only) The object that was bound to this form group.
- submittedAction: FormAction
(read-only) Returns the action that was submitted with the last request. The action is set independent whether the form must be valid for this action. The method returns null if no action at all was submitted with the last request for this form group.
- triggeredAction: FormAction
(read-only) Returns the action that was triggered with the last request. An action is only marked as triggered if the constraints regarding form validation are meet. The method returns null if no action was marked as triggered.
- accept(): void
The method copies the value from a form into the object, which was previously bound to the form. The method is equivalent to the pipelet AcceptForm.
This method is equivalent to the call formgroup.copyFrom( formgroup.object ).
- copyFrom(obj: Object): void
The method updates the form with the values from the given object.
The method call is basically equivalent to the pipelet UpdateFormWithObject.
The method not only copies the value, it also binds the object to the form. Binding means that the form keeps the information from which objects the values were taken. This can be used for two purposes:
- for lists it makes it easier in the code to find the associated object, for example in case of a related action, and
- it allows to copy back the values from the form into the object (see accept()).
Because of this bind behavior, the operation is also sometimes called a bind-operation.
Parameters:
- obj - the object from, which the values are read
- copyTo(obj: Object): void
The method updates the object with the values from the form.
The method call is basically equivalent to the pipelet UpdateObjectWithForm.
The method needs a submitted form. The copyTo call is delegated to the form fields. Each form field than checks if its value was submitted as part of the form:
- If this is true, the object gets updated with the form field value.
- If this is false, the object will not be updated.
This is the reason why you cannot copy values from one object into another object by using copyFrom(Object) and copyTo(Object) within the same request (e.g. by one call to a script or controller).
Parameters:
- obj - the object, which is updated from the form
- getChildCount(): Number
Returns the number of elements in the form.
Returns:
- the number of elements in the form.
- getError(): String
Returns a form-wide error message. If no error message is present the method returns null.
Returns:
- a form-wide error message or null.
- getObject(): Object
The object that was bound to this form group.
Returns:
- the bound object.
- getSubmittedAction(): FormAction
Returns the action that was submitted with the last request. The action is set independent whether the form must be valid for this action. The method returns null if no action at all was submitted with the last request for this form group.
Returns:
- the action that was submitted with the last request or null.
- getTriggeredAction(): FormAction
Returns the action that was triggered with the last request. An action is only marked as triggered if the constraints regarding form validation are meet. The method returns null if no action was marked as triggered.
Returns:
- the action that was triggered with the last request.