The Combo widget allows a user to either enter a value or to select an item from a list of choices. The labels and the choices that are available on the ComboBox widget for a user to select are retrieved from a WebSphere® Multichannel Bank Transformation Toolkit context or from an external source, for example, a web service. A change in the choice that has been selected by a user in a Combo widget can be detected by the other widgets on the page.
Property | Description |
---|---|
id | The id is the identifier for the widget. |
dataName | The dataName property is the name of the data element to which the widget is bound. This property is mandatory. |
urlForList | The urlForList property specifies the URL of the .js file that contains the data of the list of choices that are available for selection on the widget. |
dataNameForList | The dataNameForList property specifies the name of the data, from a WebSphere Multichannel Bank Transformation Toolkit context or a JSON string, that holds the labels and values of the choices that are available for a user to select on the widget. This is an optional property. |
labelField | The name of the field in data provider array objects ( dataNameForList or urlForList.) to use as the label field. |
isMandatory | The isMandatory property specifies whether a user is required to enter a value in the text box. |
visibility | The visibility property
defines how a widget is displayed on a GUI. The following values can
be specified for this property:
|
disabled | Disabled elements cannot have focus, do not receive or fire mouse events, cannot receive user input. If you select a value of true for the disabled property, the widget is displayed on a GUI but a user cannot interact with it. Data contained in a disabled widget is not processed when the form is submitted. The default value for the disabled property is false. |
readOnly | The readOnly property can be set to keep a user from changing the value. The default value for the readOnly property is false. |
hint | The hint is a description of the widget that is displayed as a tooltip for a user. The hint property has multilingual support. |
shortcut | The shortcut property specifies a keyboard shortcut for the widget. If a user enters the keyboard shortcut on a client, the widget receives focus on the GUI of the client. You can specify either a single character as the value of the shortcut property, or you can specify Ctrl and a character as the value of the shortcut property. |
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. |
If the dataNameForList property is used, its value must be an IndexedCollection. The fields that are contained in the record of the IndexedCollection that is specified is used by the Combo widget as Combo label; the names of the fields are used as the selection values of the Combo widget, and the values of the fields are used as the labels that are displayed on the widget.
Note that if values for both the dataNameForList property and the urlForList property have been specified, the value of dataNameForList takes priority over the value of urlForList even if the value of dataNameForList specifies data that does not exist in the context. This means that if values for both the dataNameForList property and the urlForList property have been specified, the value of the urlForList property will not be used.
At run time, the list of choices that are available for a user to select on the Combo widget is updated with either AJAX or with the loadStoreFromURL function.
For more detailed information about data mapping, you can see: Binding data to a combo widget
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. |
onChange | Is fired when the value of the widget changes. |
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. |
Property | Description |
---|---|
readOnly | The readOnly property
can be set to keep a user from changing the value. The default value
for the readOnly property is false. Note: This
property can be used in the Condition and Actions part
of ECA rule.
|
value | The value property specifies the text that is
displayed in the widget. 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.
|
isMandatory | The value of the widget cannot be empty if the
isMandatory property is true. Note: This property can be used in the Condition and Actions part
of ECA rule.
|
visibility | This property
defines how a widget is displayed on a GUI. The following values can
be specified for this property:
Note: This property can be used in the Condition and Actions part
of ECA rule.
|
disabled | Disabled elements
cannot have focus, do not receive or fire mouse events, cannot receive
user input. If you select a value of true for the
disabled property, the widget is displayed on a GUI but a user cannot
interact with it. Data contained in a disabled widget is not processed
when the form is submitted. The default value for the disabled property
is false. Note: This property can be used in
the Condition and Actions part
of ECA rule.
|
hint | The hint is a description of the widget that
is displayed as a tooltip for a user. The hint property has multilingual
support. Note: This property can be used in the Actions 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 |
---|---|
loadStoreFromURL | The loadStoreFromURL function loads a list of
choices that are available for selection from a URL. Note: This function
can be used in the Actions part of ECA rule.
|
showErrorMessage | The showMessage function displays an error message
on a GUI. Note: This function can be used in the Actions part
of ECA rule.
|
isFocusable | Returns a value of true if
a widget can be focused and a value of false if it
cannot be focused. Note: This
function can be used in the Condition part
of ECA rule.
|
focus | Specifies that the widget
should be focused. Note: This
function can be used in the Actions part of
ECA rule.
|