JBoss.orgCommunity Documentation
The <b:birt> component servers to integrate a BIRT report into Seam or JSF container. The <b:birt> tag recognizes most of the parameters described on the BIRT Report Viewer Parameters page, though it has attributes of its own.
Table 4.1. <b:birt> Component Reference
| Attribute | Correspondance to BIRT Report Viewer parameters | Description/ |
|---|---|---|
| designType | - | Corresponds to the BIRT servlet mappings. Possible values are run, frameset, preview and embed. If the attribute is set to embed the component is used for embeddable html. This type ignores all the attributes except designName and masterpage. |
| embeddable | - | A BIRT report occupies the whole page by default. It contains the <html>, <head>, <body> etc., tags. Embedded report can be a part of another page. It doesn't contain the above mentioned tags. Only HTML report can be embedded. |
| designName | __report | Sets the name of the report design to process. This can be an absolute path or relative to the working folder. Valid values are run, frameset and preview |
| format | __format | Specifies the desired output format, such as pdf, html, doc, ppt, or xls. |
| title | __title | Sets the report title. |
| showtitle | __showtitle | Determines if the report title is shown in the frameset viewer. Defaults to true. |
| toolbar | __toolbar | Determines if the report toolbar is shown in the frameset viewer.Defaults to true. Valid values are true and false. |
| navigationbar | __navigationbar | Determines if the navigation bar is shown in the frameset viewer. Defaults to true. Valid values are true and false. |
| document | __document | Sets the name for the rptdocument. The document is created when the report engine separates run and render tasks, and is used to support features like table of contents and pagination. This setting can be an absolute path or relative to the working folder. If no document parameter is used, a unique document is created in the document folder. |
| locale | __locale | Specifies the locale for the specific operation. Note that this will override the default locale. |
| svg | __svg | Specifies whether SVG is supported. |
| page | __page | Specifies specific page to render. |
| pagerange | __pagerange | Specifies page range to render. Eg 1-4,7. |
| masterpage | __masterpage | Indicates that the report master page should be used or not. Validvalues are true and false. |
| overwrite | __overwrite | This setting if set to true will force an overwrite of the existing report document. |
| bookmark | __bookmark | Specifies a specific bookmark within the report to load. The viewer will automatically load the appropriate page. |
| rtl | __rtl | Specifies whether to display the report in right to left format. This setting defaults to false. |
| fittopage | __fittopage | Specifies whether PDF generation should fit content to a page. Valid values are true and false. |
| resourceFolder | __resourceFolder | Specifies the resource folder to use. This setting will override the default setting in the web.xml. The resource folder is used to locate libraries, images, and resource files. |