IBM WebSphere Multichannel Bank Transformation Toolkit, Version 7.1

Table

The Table widget provides the ability to display data in a table.

Implementation base

The Table widget is a Dojo-based widget:
  • com.ibm.btt.dijit.Grid

Properties

The following properties can be configured for the Table widget.
Table 1. Properties that can be configured for the Table widget.
Property Description
dataName The dataName property specifies the name of the data element that is used to cache the record in the table that is submitted.
dataNameForList The dataNameForList property specifies the name of the data, from a WebSphere® Multichannel Bank Transformation Toolkit context or a JSON string, that contains the records for the table.
rowsPerPage The rowsPerPage property specifies the number of rows that is displayed per page.
columnReordering The columnReordering property specifies whether the order in which the columns of the table are displayed can be changed by a user. The default value is false.
width The width property specifies the width of the widget.
height The height property specifies the height of the widget.
operationNameForPagination The operationNameForPagination property specifies the server-side operation that sort and separate the data records for display on the GUI.
sortEnabled The sortEnabled property specifies whether the rows on the table can be sorted by the user.
selectionMode The selectionMode property specifies the number of rows that can be selected by the user. Values that can be specified for the selectionMode property are none, single, and multiple.
selectionRequired The selectionRequired property specifies whether a user is required to select a record. If the selectionRequired property is set to true and the user does not select a record, an error message displays.
readOnly The readOnly property is an expert-level property, which means that it is available for use in the XUI editor only if the XUI editor is configured to display expert properties. If you select a value of true for the readOnly property, the widget is displayed on a GUI but a user cannot interact with it. If a widget has the value of its readOnly property set to true and the value of its disabled property set to false, the data of the widget is taken into account during form submission. The default value for the readOnly property is false.
Note: To ensure that the Table widget and all the widgets contained in the Table widget are read-only, you must both set the value of the readOnly property to true and select the Editable check box in the Details panel of the Columns tab, which is in the Table view of the Properties tab. If you do not select the Editable check box, the widgets that are contained in the Table widget can be edited by a user.
Each column in a table has the following properties.
Table 2. Properties of the columns in a Table widget.
Property Description
text The text property specifies the text that is displayed as the header of the column.
dataName The dataName property is the name of the data element to which the column is bound.
width The width property specifies the width of the column.
editable The editable property specifies whether the cells in the table can be edited by a user. If a value of false is specified for the editable property, the cell is displayed but cannot be edited.
alignment The alignment property specifies the alignment of the text in the cells of the table. Three values are available for the alignment property:
  • Left
  • Center
  • Right
The default value is Left.

Data mapping

The data that is specified in the dataNameForList property must be an IndexedCollection from the WebSphere Multichannel Bank Transformation Toolkit context hierarchy.

The inner data element can be either an IndexedCollection or a KeyedCollection. If the inner data element is a KeyedCollection, the values from each element that are contained in the KeyedCollection are displayed on a row of the table. If the inner data element is an IndexedCollection, the values of the elements that are contained in the IndexedCollection are displayed on a column.

The dataName property specifies the name of a data element that is retrieved from a WebSphere Multichannel Bank Transformation Toolkit context. Data that are entered into the rows of a table are submitted to the data element specified in the dataName property.

ECA editor support

The following events, properties, and functions can be configured for the Table widget with the ECA editor.
Table 3. Events that can be added to a Table widget by using the ECA 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.
onSelected Is fired when a row on the table is selected.
Table 4. Properties that can be configured for the Table widget by using the ECA editor.
Property Description
styleClass The styleClass property specifies the class selector that is associated with the widget. If you do not configure the styleClass property, the default class selector is used instead.
visibility The visibility property defines how a widget is displayed on a GUI. The following values can be specified for this property:
readOnly The readOnly property is an expert-level property, which means that it is available for use in the XUI editor only if the XUI editor is configured to display expert properties. If you select a value of true for the readOnly property, the widget is displayed on a GUI but a user cannot interact with it. If a widget has the value of its readOnly property set to true and the value of its disabled property set to false, the data of the widget is taken into account during form submission. 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.
Table 5. Functions that can be configured for the Table widget by using the ECA editor.
Function Description
focusOn() Enables a table to receive focus. The last cell of the table will receive focus.
getValueInFirstSelectedItem(attName) Retrieves the value of a column from the data element that is specified in the dataName property.
getValueInSelectedItem(itemId) Retrieves the value of a cell on a selected row.
Note: This function is not supported for WebSphere Multichannel Bank Transformation Toolkit V7.1.
getLengthSelectedRows() Retrieves the value of a row from the data element that is specified in the dataName property.


Feedback