Previous TopicNext Topic


Module

The Module element contains report design information common to report designs and libraries. Consequently, Module is the parent of both ReportDesign and Library elements. The Module element provides lists of most components of a report, including:

Extends

Does not extend any element

Property summary

Method summary

None

Inherited properties

None

Style properties

None

Module properties

The following sections describe the properties of the Module element.

author

The person who created the report. The author property is for documentation purposes only. BIRT does not use this property.

base
A base directory to use when computing relative links from this report
comments

Text that describes the report design. The comments property supports embedded HTML. The comments are notes for report developers and those who maintain the report. Comments cannot be externalized. This property is for documentation purposes only.

configVars

A name-value pair that a report developer sets at run time. A configuration pair specifies a deployment-specific dependency, such as the name of the database to use at runtime.

createdBy

Name of the tool that created the design. BIRT report designs contain the text BIRT Version <version number>. Customers or third parties who generate designs can insert their product name here. This property is only used for documentation.

description

Text that the consumer of report sees when running the report. The description property can contain HTML and it can be externalized.

descriptionID

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

images

A list of images embedded in this report. Most images in a report are referred to with a URL, or a file deployed externally to the report. It is also possible to embed an image directly into the report design. Embedded images are especially helpful if a report design is used in a custom application and sent to the server for one-time execution.

The image name associates an Image report item with an embedded image. A script retrieves an image from the images array by using the image name, as in the following example:

var img = report.design.images["MyImage"] 
includeResource

File name of resource file that stores the externalization strings. Report designs support externalized strings by using resource keys that point to strings within the resource file.

includeScripts

The names of JavaScript files to include in the report. BIRT reads and executes these scripts before calling the initialize method for the design. Included scripts can define any of the following features:

A report can contain any number of included scripts.

propertyBindings

A list of bindings between properties and expressions. The user can override the value of a property if the expression binds to a parameter.

theme

The theme for this report. When a report or a library includes another library, it can use one of the themes provided by the included library. When a theme is applied, the report or library is able to reuse all the styles contained in this theme.

title

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.

titleID

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

units

The following table itemizes the choices for this property.

Name
Display name
Value
in
in
in
cm
cm
cm
mm
mm
mm
pt
points
pt
pc
picas
pc
em
ems
em
ex
exs
ex
px
pixels
px
%
%
%


(c) Copyright Actuate Corporation 2006

Previous TopicNext Topic