Previous TopicNext Topic


Listing

The Listing element is an abstract base element that captures the behavior common to lists and tables. Both lists and tables support a data set, filtering, sorting, methods, and so forth.

See the Library and Table items for the specific visual differences between the two items.

Extends

DesignElement->ReportElement->ReportItem

Property summary

Inherited properties

comments, customXml, dataSet, extends, height, name, paramBindings, style, userProperties

Style properties

None

Listing properties

The following sections describe the properties of the Listing element.

filter

Filter criteria to apply to each row in the List. The filter property specifies filter criteria to apply to each row in the data set. The filter can contain BIRT expressions (in JavaScript.) If you want the database to do the filtering, put the filter criteria in the WHERE clause of your query.

pageBreakInterval

The number of lines between page breaks. The default value for this property is 0, which causes the entire report to print on a single page without breaks.

sort

The sort order for detail rows in the List. Specifies the sorting of the rows within the detail band. This sorting is done within BIRT. If you want the database to do the sorting, specify the sort within the ORDER BY clause of your query.

Listing methods

The following sections describe the methods of the Listing element.

onFinish

A script that executes after BIRT reads the last row from the data set for this element, but before BIRT creates the footer band.

onRow

A script that executes for each row that BIRT retrieves from the data set for this element, but before BIRT creates any content for that row.

onStart

A script that executes before BIRT retrieves the first row from the data set for this element and after BIRT opens the data set, but before creating the header band. This script is a convenient place to initialize custom running total variables.

To allow the application to calculate custom running totals:


(c) Copyright Actuate Corporation 2006

Previous TopicNext Topic