Eclipse BIRT Report Object Model (ROM)
Module Element
Display Name: | Module |
Since: | 2.0 |
XML Element: | None |
Extends: | None |
Extendable: | No |
Abstract: | Yes |
Name Space: | None |
Name Requirement: | Optional |
Allows User Properties: | No |
Has Style: | No |
The module element describes the common characteristics between libraries and designs. It provides a wide variety of properties to help people understand the module, and provide lists of most components: page setup, data sources, data sets, reusable report items, and so on.
ROM defines a number of name spaces within a report design. A name space holds a set of named components. Each name space is independent of the other. ROM name spaces are:
Name Space | Contents |
Styles | Shared styles |
Data Sources | Data sources (database connections) |
Data Sets | Queries and other data sources |
Master Pages | Page definitions. |
Layout Elements | All visual elements such as lists, tables, etc. |
Parameters | Report parameters |
The name is optional for elements that can appear in the Layout Elements name space. The name is required for all other elements.
Report Design element
Library element
The person who created the report.
Type: | string |
Since: | 1.0 |
Required: | No |
Display Name: | Author |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
The person who created the report. The user can fill this in to keep track of the person who wrote the report, or is responsible for maintaining the report. This is purely documentation; BIRT does not use this property at runtime.
Module element createdBy Property
Text that describes the report design.
Type: | html |
Since: | 1.0 |
Required: | No |
Display Name: | Comments |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | Yes |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
Text that describes the report design. It can contain embedded HTML. The comments are notes for the people who develop and maintain the report. Comments cannot be externalized. BIRT does not use this information at runtime, it is purely documentation for the report developer.
Name of the tool that created the design.
Type: | string |
Since: | 1.0 |
Required: | No |
Display Name: | Created by |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
Name of the tool that created the design. Designs created by BIRT will contain the text "BIRT Version xxx". Customers or third parties who generate designs can insert their product name here. This is purely a documentation property; BIRT does not use it at runtime.
author
property
A description presented to the end user of report when it is deployed.
Type: | html |
Since: | 2.0 |
Required: | No |
Display Name: | Description |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
A description presented to the end user of report when it is deployed. Can contain HTML. Can be externalized. This is a full description, and can be shown to the user when using the report in the UI. The actual use of this property is determined by the application UI.
title
property
The resource key for the description.
Type: | resourceKey |
Since: | 2.0 |
Required: | No |
Display Name: | Description key |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | Yes |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
Localization resource key for the description presented to the end user of report.
description
property
Resource file name which stores the externalized strings.
Type: | list |
Since: | 1.0 |
Required: | No |
Display Name: | Include resource |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
Report designs support externalized strings by storing the resource keys; which are stored in the resource file. This property stores the resource file name.
The name(s) of JavaScript files to include into this report.
Type: | List of IncludeScript Structures |
Since: | 1.0 |
Required: | No |
Display Name: | Include scripts |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | No |
Property Sheet Visibility: | Hidden |
Property Sheet Group: | Top |
The name(s) of JavaScript files to include into this
report. BIRT reads and executes these scripts before calling the
initialize
method for the design. The scripts can
define reusable variables, functions, objects, Java imports and so on. The
design can contain any number of script includes.
initialize
method
Type: | List of ScriptLib Structures |
Since: | 2.1.1 |
Required: | No |
Display Name: | Script libraries |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | No |
Property Sheet Visibility: | Hidden |
Property Sheet Group: | Top |
A short description of the report presented to the user when the report is deployed.
Type: | string |
Since: | 1.0 |
Required: | No |
Display Name: | Title |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
A short description of the report presented to the user when the report is deployed. The string can be externalized. The use of the string depends on the application UI used at deployment.
description
property
title
property
The resource key for the title
Type: | resourceKey |
Since: | 1.0 |
Required: | No |
Display Name: | Title key |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | Yes |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
Localization resource key for the title
title
property