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>