Previous TopicNext Topic


ListGroup

The ListGroup element represents a group break level within a list. A list most often divides into a number of groups. A group provides a way of showing common headings for a group of related rows. A group often has subtotals. For example, a sales report might show totals per sales representative and region.

A group is defined by a group key. The key is a column from the query. If the group key is a time field, for example, you might choose to group on an interval such as month or quarter.

Extends

DesignElement->ListingGroup

Property summary

None

Method summary

onPrepare

Inherited properties

customXml, groupName, interval, intervalRange, keyExpr, sortDirection, userProperties

Slot summary

ListGroup slots

The following sections describe the slots that a ListGroup element contains.

header

The header band for this group. The header band appears before the first detail row of a group. This band contains any number of sections. Sections appear sequentially one after another, or can be selected conditionally.

Report items within the header slot have visibility to the entire result set. If the header contains a simple element such as a data item, then it will display values from the first row of the group. If the header contains a chart, then the chart displays rows from the entire group. If the header displays an aggregate, then the aggregate is computed over the entire group.

Level 1 is the topmost group and level 9 is the bottom-most group.

footer

The footer band for this group. The footer band appears after the last detail row of a group. This band contains any number of sections. Sections appear sequentially one after another, or can be selected conditionally.

A report item within the footer slot has visibility to the entire result set. If the footer contains a simple element such as a data item, it displays values from the first row of the group. If the footer contains a chart, the chart displays rows from the entire group. If the footer displays an aggregate, the aggregate is computed over the entire group.

ListGroup method

The following section describes the only method of the ListGroup element.

onPrepare

The method that BIRT executes to handle the onPrepare event for this element. the onPrepare method executes once prior to the generation of the report. Use onPrepare method to perform tasks that affect the appearance of the element for every occurrence in the report.


(c) Copyright Actuate Corporation 2006

Previous TopicNext Topic