The FormAction class represents the action in form instance hierarchy.
| Property | Description |
|---|---|
description: String (read-only) | Returns the optional description for the action. |
label: String (read-only) | Returns the optional label for the action. |
object: Object (read-only) | Returns the object that was bound to the form in which the action is contained. |
submitted: Boolean (read-only) | Identifies if the form action was submitted from the client to the server. |
triggered: Boolean (read-only) | Identifies that this action is triggerd. |
x: Number (read-only) | In case of an image button, returns the x coordinate of the last click. |
y: Number (read-only) | In case of an image button, returns the y coordinate of the last click. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| getDescription() | Returns the optional description for the action. |
| getLabel() | Returns the optional label for the action. |
| getObject() | Returns the object that was bound to the form in which the action is contained. |
| getX() | In case of an image button, returns the x coordinate of the last click. |
| getY() | In case of an image button, returns the y coordinate of the last click. |
| isSubmitted() | Identifies if the form action was submitted from the client to the server. |
| isTriggered() | Identifies that this action is triggerd. |
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
(read-only)Returns the optional description for the action. The description could be used as tooltip for the action.
(read-only)Returns the optional label for the action. The label would be typically used as button text.
(read-only)Returns the object that was bound to the form in which the action is contained. The method is a convenience method for getParent().getObject(). In most cases this is actually the object for which the specific action is triggered.
(read-only)Identifies if the form action was submitted from the client to the server.
(read-only)Identifies that this action is triggerd. An action is only triggered if it was submitted and the constraints, regarding a valid form, are met.
(read-only)In case of an image button, returns the x coordinate of the last click.
(read-only)In case of an image button, returns the y coordinate of the last click.
Returns the optional description for the action. The description could be used as tooltip for the action.
Returns:
Returns the optional label for the action. The label would be typically used as button text.
Returns:
Returns the object that was bound to the form in which the action is contained. The method is a convenience method for getParent().getObject(). In most cases this is actually the object for which the specific action is triggered.
Returns:
In case of an image button, returns the x coordinate of the last click.
Returns:
In case of an image button, returns the y coordinate of the last click.
Returns:
Identifies if the form action was submitted from the client to the server.
Returns:
Identifies that this action is triggerd. An action is only triggered if it was submitted and the constraints, regarding a valid form, are met.
Returns:
j