![]() ![]() |
The List element creates a banded presentation of a set of data rows. The data in each band can be in any of the supported section types: grid, free-form, text, chart, and so forth. A list is composed of a series of bands. Each band can contain any number of sections that print sequentially. You can attach conditions so that only one of the sections prints for any given list or row.
If a list appears as a top-level section or as a subsection within another top-level list, the bands fill the entire width of the page. If a list appears within a container, such as a grid, table cell, or free-form, the list width is fixed. The list height grows as large as needed to display the list contents.
DesignElement->ReportElement->ReportItem->Listing
None
comments, customXml, dataSet, extends, filter, height, name, paramBindings, sort, style, userProperties
backgroundColor, backgroundImage, borderBottomColor, borderBottomStyle, borderBottomWidth, borderLeftColor, borderLeftStyle, borderLeftWidth, borderRightColor, borderRightStyle, borderRightWidth, borderTopColor, borderTopStyle, borderTopWidth, canShrink, color, dateTimeFormat, display, fontFamily, fontSize, fontStyle, fontVariant, fontWeight, highlightRules, highlightTestExpr, letterSpacing, lineHeight, mapRules, mapTestExpr, marginBottom, marginLeft, marginRight, marginTop, masterPage, numberAlign, numberFormat, orphans, paddingBottom, paddingLeft, paddingRight, paddingTop, pageBreakAfter, pageBreakBefore, pageBreakInside, showIfBlank, stringFormat, textAlign, textIndent, textLineThrough, textOverline, textTransform, textUnderline, verticalAlign, whiteSpace, widows, wordSpacing
The following sections describe the slots of the List element.
A band that appears before the first row of the list. The header band appears before the first detail row of a list. This band contains any number of sections. Sections appear sequentially one after another, or can be selected conditionally. The header normally appears whether the report contains any data rows or not. The user can change this behavior using an expression.
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, it displays values from the first row. If the header contains a chart, the chart displays rows from the entire data set. If the header displays an aggregate, the aggregate is computed over the entire data set.
Groups for the report. The outermost group appears first in the list, the innermost group appears last. Each group has a group key, a header, a footer, and more.
Sections to print for every row in the query. The detail band contains the sections to print for each row within the list. The list creates a separate instance of the detail band for each row. The detail band normally contains simple elements such as a data item.
The detail band can also contain a nested list or table, in which case the nested list or table repeats for each row in the outer list. This technique is useful for creating subreports. For example, an outer report displays a list of customers and an inner report prints a form letter that contains a list of the customer's sales this month.
A section that appears after the last row of the report. The footer normally appears whether the report contains any data rows or not. The user can change this behavior through an expression.
Report items within the footer slot have visibility to the entire result set. If the footer contains a simple element such as a data item, then it will display values from the last row. If the footer contains a chart, then the chart displays rows from the entire data set. If the footer displays an aggregate, then the aggregate is computed over the entire data set.
The following sections describe the methods of the List element.
The method that BIRT executes to handle the onCreate event for this element. The onCreate method executes every time the element is generated. Use the onCreate method to perform tasks that are data dependent.
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.
The method that BIRT executes to handle the onRender event for this element. The onRender method executes at run time and not at generation time. Use the onRender method to perform tasks that are dependent on the run time details. Examples of run time factors that might require special handling include the run time environment, the user requesting the report, the parameter values in effect when the report is run, and whether the report is produced in HTML or PDF format.
![]() ![]() |