Previous TopicNext Topic


Table

The Table element presents data from a data set in using a tabular layout. The columns property is optional and defines the columns. The header appears at the top of the table, and on each new page. The table can contain groups. The footer displays totals and appears at the bottom of the table. The detail appears for every row in the data set.

A table can omit the data set, in which case it displays a set of rows defined by its container.

Extends

DesignElement->ReportElement->ReportItem->Listing

Property summary

Method summary

Slot summary

Inherited properties

comments, customXml, dataSet, extends, filter, height, name, paramBindings, sort, style, toc, userProperties visibility

Inherited methods

None

Style properties

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

Table properties

The following sections describe the properties of the Table element.

caption

Text to appear as a table caption in HTML This property provides text to appear as the table caption in HTML. The text can be localized.

captionID

A resource ID for this value, used for externalizing the value of this string.

repeatHeader

A boolean value that determines whether to repeat the headings at the top of each page. If true , the headings repeat. If false, the header appears only on the first page. The default value for this property is true.

Table slots

The following sections describe the slots of the Table element.

header

Rows to appear at the top of the table, and optionally at the top of each table elements. The table header usually contains column headings.

group

Level breaks within the data. Each has its own header and footer. Groups provide a way of organizing data within a table. Groups appear from the most general, outermost, to the most specific, innermost.

detail

Rows to display for each row in the data set. The detail rows appear for each row in the data set. Rows can be conditionally selected. For example, an accounting report can display different rows for debits and credits.

footer

Rows to appear at the bottom of the table. The footer often contains totals

columns

A list of Column elements that describe the table columns. This slot describes the columns within the table. This slot is optional. If omitted, BIRT infers the columns from the table structure and sizes the columns based on their contents. If provided, the table must contain no more than the number of columns described. Use this property when you want to control the size, color, border, or other properties of each column.

Table methods

The following sections describe the methods of the Table element.

onCreate

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.

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.

onRender

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.


(c) Copyright Actuate Corporation 2006

Previous TopicNext Topic