LIST element

The LIST element defines the layout of a control used to display lists of data. Each field or action control becomes a column and data values are then tabulated.

Attributes

The LIST element has the following attributes:

Table 1. Attributes of the LIST Element

Attribute Name

Required

Default

Description

TITLE

No

  

A reference to an externalized string containing the title string for this list. See also note below.

STYLE

No

  

The class name of the CSS style to associate with this list for formatting.

DESCRIPTION

No

  

A reference to an externalized string that provides more details about the list than the title alone. This will be displayed below the title on the page.

SORTABLE

No

true

Lists can be sorted by clicking on the appropriate headers. This is set by default to be enabled without the use of the attribute. This attribute allows this feature to be controlled with false disabling the feature and true enabling it.

SUMMARY

No

  

A reference to an externalized string containing the summary of this list. The SUMMARY attribute describes the purpose and/or structure of a list.

SCROLL_HEIGHT

No

  

Specifies in pixels the desired fixed height of a scrollable list. A vertical scrollbar is provided once the list exceeds the scroll height. The scrollbar is only applied to the list body and the list's column headers remain fixed Scroll height is independent of the list contents and therefore an empty list will still be set to the height specified.

BEHAVIOR

No

  

Optional attribute which controls the display and behavior of the toggle button used to expand or collapse the list.

Three value options are available for this attribute:

  • NONE which prevents the toggle button from being displayed in the list header.
  • EXPANDED : the toggle button is displayed and the list is initially expanded.
  • COLLAPSED : the toggle button is displayed and the list is initially collapsed.

When the BEHAVIOR is not set for a list, its default value of EXPANDED is implied.

Note that this attribute is only applicable when the property ENABLE_COLLAPSIBLE_CLUSTERS is not set or is set to true in curam_config.xml. For details see General configuration.

PAGINATED

No

true

Enables the ability to page through lists displayed in Cúram pages. Any LIST longer than the configured minimum size will display only the first "page" of data and the pagination controls will be displayed below the list.

DEFAULT_PAGE_SIZE

No

Based on the global configured value, usually 15.

Specifies the page size the list will get by default. The page size can be then changed at runtime by the user.

PAGINATION_THRESHOLD

No

Based on the global configured value, usually same as DEFAULT_PAGE_SIZE.

Specifies the minimum list size at which pagination will be enabled. For shorter lists there will be no pagination, even if otherwise pagination is switched on.
Note: Lists on search pages now display the number of items found as a result of the search. The number of items will be displayed beside the list title.

The text used to display the number of items can be customized by setting the following property in the CDEJResources.properties file, for example:

record.number.message=Items found:

The actual number of items will be displayed after the text.

This feature only applies to search pages and must be enabled by adding the following to the curam-config.xml file:
<LIST_ROW_COUNT>true</LIST_ROW_COUNT>

Child Elements

The LIST element can contain the following child elements. It must contain at least one ACTION_CONTROL, FIELD, or CONTAINER element. SOURCE connections can be made to list or non-list properties. Within a table all list properties must belong to the same list structure defined in the server interface model. This ensures that they are all the same length. The number of rows in the list will be equal to the number of elements in the list properties. The value of a non-list property is simply repeated on each row.

Table 2. Child Elements of the LIST Element

Element Name

Cardinality / Description

TITLE

0..1. The TITLE element will be displayed above the LIST.

DESCRIPTION

0..1 The DESCRIPTION element element has the same behavior as the DESCRIPTION attribute but allows the description to be built up from a number of sources. If both are specified, this element takes precedence over the corresponding attribute.

ACTION_SET

0..1. The action set can contain ACTION_CONTROL elements of any type. The action controls will be displayed above and/or below the entire list.

FIELD

0..n. The FIELD, CONTAINER, and ACTION_CONTROL elements can be freely intermingled. Only output fields can be used (i.e., fields with no target connection.)

CONTAINER

0..n. The FIELD, CONTAINER, and ACTION_CONTROL elements can be freely intermingled. Within the container, only output fields can be used (i.e., fields with no target connection.)

CONDITION

0..1. Affects whether or not the list is displayed.

FOOTER_ROW

0..n. This should be defined after all other child elements.

LIST_CONNECT

0..n. This should be defined after all other child elements. The only supported child elements are SOURCE and TARGET. The SOURCE connection must be a display phase bean.