The Form container is used to fill with other widgets and submit data. For example, developers usually place widgets like text, label and combo box in a form container. These widgets are often bound to predefined data within the transaction.
Property | Description |
---|---|
id | The id is the identifier for the widget. |
defaultAction | The defaultAction property specifies the default
server-side action that is executed when the form is submitted. This
property is set in the Action tab of the Properties view.
The defaultAction property consists of the following sub-properties:
|
validateOnSubmit | The validateOnSubmit property specifies whether validation is required for the widgets that are contained in the form. If the validateOnSubmit property is set to true and any of the widgets contained in the form fail during validation or the cross validation fails, the submit button will be disabled. The default value is true. |
styleClass | The styleClass property specifies the name of the CSS style ( also known as CSS style class) associated with the widget. This property is set by selecting a style from the CSS styles table in the Style tab of the Properties view. If you do not configure the styleClass property, the default style is used instead. For more detailed information, refer to Setting CSS style to widgets. |
width | The width property specifies the width of the widget. This property is set in the Appearance tab of the Properties view. |
height | The height property specifies the height of the widget. This property is set in the Appearance tab of the Properties view. |
Cross-field Validation function is used to validate multiple fields in a form if their values are correlative. Submit type buttons in the form will be disabled until all the defined cross-field validations for the form are valid. For more information, please refer to Defining Cross-field Validation using XUI Editor.
Event | Description |
---|---|
onClick | Is fired when the left mouse button is clicked. |
onFocus | Is fired when the widget receives focus because the user moves the mouse pointer over the widget. |
onBlur | Is fired when the widget does not receive focus, or when the user clicks outside the widget, or when the widget is hidden. |
onKeyDown | Is fired when a keyboard key is pressed. |
onKeyUp | Is fired when a keyboard key is released. |
onKeyPress | Is fired when a keyboard key is pressed or held down. |
onMouseDown | Is fired when a mouse button is clicked. |
onMouseUp | Is fired when a mouse button is released |
onMouseEnter | Is fired when the mouse pointer moves over the widget. |
onMouseLeave | Is fired when the mouse pointer moves out of the widget. |
onMouseMove | Is fired when the mouse pointer moves over nodes that are contained in the widget. |
onSubmit | Is fired when the form is submitted. |
onReset | Is fired when the form is reset. |
onValidStateChange | Is fired when the valid state of the form changes. |
onLoaded | Is fired when the form and the widgets inside the form have loaded. |
onAsyncOK | Is fired when the page has been successfully updated with AJAX. |
onAsyncError | Is fired when the page has failed to be updated with AJAX. |
onAsyncTimeOut | Is fired when the AJAX times out. |
onWidgetChange | Is fired when any widget value inside the form is changed. |
Property | Description |
---|---|
id | The id is the identifier
for the widget. Note: This
property can be used in the Condition part
of ECA rule.
|
validateOnSubmit | The validateOnSubmit property specifies whether
validation is required for the widgets that are contained in the form.
If the validateOnSubmit property is set to true and
any of the widgets contained in the form fail during validation, the
submit button will be disabled. The default value is true. Note: This
property can be used in the Condition and Actions part
of ECA rule.
|
asyncStatus | The asyncStatus property specifies the status
of the AJAX. The status is provided as an HTTP status code. Note: This
property can be used in the Condition part
of ECA rule.
|
asyncErrorMessage | The asyncErrorMessage property provides an error
message an AJAX. The error message is retrieved from the browser-side. Note: This
property can be used in the Condition part
of ECA rule.
|
asyncCode | The asyncCode property specifies the code that
is used as the identifier for the AJAX. Note: This property can be
used in the Condition part of ECA rule.
|
styleClass | The styleClass property
specifies the name of the CSS style ( also known as CSS style class)
associated with the widget. This property is set by selecting a style
from the CSS styles table in the Style tab of the Properties view.
If you do not configure the styleClass property, the default style
is used instead. For more detailed information, refer to Setting CSS style to widgets. Note: This
property can be used in the Actions part of
ECA rule.
|
Function | Description |
---|---|
isValid | Returns a value of true if
all the widgets that are contained in the form are valid according
to client-side validation rules. Client-side validation rules are
defined as Type parameters. Note: This function can be used in the Condition part
of ECA rule.
|
validate | Returns a value of true if
the form is valid. The validate function has the following two features
that the isValid function does not have:
Note: This function can be used in the Actions part
of ECA rule.
|
submit | Programmatically submits the form data to the
server, and then the action that is specified in the defaultAction
property is performed on the server. Note: This function can be used
in the Actions part of ECA rule.
|
callAsyncOperation | Submits the form data in an asynchronous request,
which executes the specified WebSphere Multichannel
Bank Transformation Toolkit operation which is specified in the 'operationId'
parameter. After the operation has executed, the form is updated with
the response data and the 'asynCode' property of the form is set as
the value specified in the 'asynCode' parameter. The 'timeOut' is
the specified number of milliseconds of the asynchronous request. Note: This
function can be used in the Actions part of
ECA rule.
|
reset | Sets the value of all widgets under the form to the initial
value after the page is loaded. This function have no return value. Note: This
function can be used in the Actions part of
ECA rule.
|