| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN"> |
| <html> |
| <head> |
| <title>Report Design Element (Eclipse BIRT ROM Documentation)</title> |
| <link rel="stylesheet" href="../style/style.css" type="text/css"/> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| </head> |
| <body> |
| <p class="title">Eclipse BIRT Report Object Model (ROM)</p> |
| <p class="subtitle">ReportDesign Element</p> |
| <h1>Element Overview</h1> |
| <div class="section-text"> |
| The report design element represents report as a whole.</div> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Report Design</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>XML Element:</td> |
| <td><code>report</code></td></tr> |
| <tr><td>Extends:</td> |
| <td><a href="Module.html">Module</a></td></tr> |
| <tr><td>Extendable:</td> |
| <td>No</td></tr> |
| <tr><td>Abstract:</td> |
| <td>No</td></tr> |
| <tr><td>Name Space:</td> |
| <td>None</td></tr> |
| <tr><td>Name Requirement:</td> |
| <td>Not Supported</td></tr> |
| <tr><td>Allows User Properties:</td> |
| <td>Yes</td></tr> |
| <tr><td>Has Style:</td> |
| <td>No</td></tr> |
| </table> |
| |
| <h3>Property Summary</h3> |
| |
| <dl class="section-text"> |
| <dt><a href="#Property-cheatSheet">cheatSheet</a></dt> |
| <dd>A string containing the file name of the cheat sheet.</dd> |
| <dt><a href="#Property-cssStyleSheets">cssStyleSheets</a></dt> |
| <dd></dd> |
| <dt><a href="#Property-displayName">displayName</a></dt> |
| <dd>Display name of the report design</dd> |
| <dt><a href="#Property-displayNameID">displayNameID</a></dt> |
| <dd>Resource key for the localizable display name property.</dd> |
| <dt><a href="#Property-eventHandlerClass">eventHandlerClass</a></dt> |
| <dd>The full qulified name of the event handler class.</dd> |
| <dt><a href="#Property-iconFile">iconFile</a></dt> |
| <dd>The design icon/thumbnail file path</dd> |
| <dt><a href="#Property-layoutPreference">layoutPreference</a></dt> |
| <dd></dd> |
| <dt><a href="#Property-refreshRate">refreshRate</a></dt> |
| <dd>The refresh rate when viewing the report.</dd> |
| <dt><a href="#Property-thumbnail">thumbnail</a></dt> |
| <dd></dd> |
| </dl> |
| |
| <h3>Method Summary</h3> |
| |
| <dl class="section-text"> |
| <dt><a href="#Method-afterFactory">afterFactory</a></dt> |
| <dd>Perform initialization before opening the report document for writing.</dd> |
| <dt><a href="#Method-afterRender">afterRender</a></dt> |
| <dd>Called after completing a presentation time action.</dd> |
| <dt><a href="#Method-beforeFactory">beforeFactory</a></dt> |
| <dd>Perform initialization before opening the report document for writing.</dd> |
| <dt><a href="#Method-beforeRender">beforeRender</a></dt> |
| <dd>Called before starting a presentation time action.</dd> |
| <dt><a href="#Method-initialize">initialize</a></dt> |
| <dd>Called when the report starts executing in either the |
| Factory or Presentation engine.</dd> |
| </dl> |
| |
| <h3>Slot Summary</h3> |
| |
| <dl class="section-text"> |
| <dt><a href="#Slot-styles">styles</a></dt> |
| <dd>List of user-defined styles used to format elements in the report.</dd> |
| <dt><a href="#Slot-parameters">parameters</a></dt> |
| <dd>A list of Parameter elements that describe the data that the user can enter when running the report.</dd> |
| <dt><a href="#Slot-dataSources">dataSources</a></dt> |
| <dd>The connections used by the report.</dd> |
| <dt><a href="#Slot-dataSets">dataSets</a></dt> |
| <dd>Data sets (queries) defined in the design.</dd> |
| <dt><a href="#Slot-pageSetup">pageSetup</a></dt> |
| <dd>The layout of the master pages within the report.</dd> |
| <dt><a href="#Slot-components">components</a></dt> |
| <dd>Reusable report items defined in this design. Report |
| items can extend these items. Defines a "private library" for this design.</dd> |
| <dt><a href="#Slot-body">body</a></dt> |
| <dd>The visual layout sections within the report.</dd> |
| <dt><a href="#Slot-scratchPad">scratchPad</a></dt> |
| <dd>TBD</dd> |
| <dt><a href="#Slot-templateParameterDefinitions">templateParameterDefinitions</a></dt> |
| <dd>Stores the reusable template definitions.</dd> |
| <dt><a href="#Slot-cubes">cubes</a></dt> |
| <dd></dd> |
| </dl> |
| |
| <h3>Inherited Properties</h3> |
| |
| <p class="section-text"> |
| <a href="Module.html#Property-author">author</a>, |
| <a href="Module.html#Property-base">base</a>, |
| <a href="Module.html#Property-colorPalette">colorPalette</a>, |
| <a href="Module.html#Property-comments">comments</a>, |
| <a href="Module.html#Property-configVars">configVars</a>, |
| <a href="Module.html#Property-createdBy">createdBy</a>, |
| <a href="Module.html#Property-description">description</a>, |
| <a href="Module.html#Property-descriptionID">descriptionID</a>, |
| <a href="Module.html#Property-helpGuide">helpGuide</a>, |
| <a href="Module.html#Property-images">images</a>, |
| <a href="Module.html#Property-includeResource">includeResource</a>, |
| <a href="Module.html#Property-includeScripts">includeScripts</a>, |
| <a href="Module.html#Property-libraries">libraries</a>, |
| <a href="Module.html#Property-propertyBindings">propertyBindings</a>, |
| <a href="Module.html#Property-scriptLibs">scriptLibs</a>, |
| <a href="Module.html#Property-theme">theme</a>, |
| <a href="Module.html#Property-title">title</a>, |
| <a href="Module.html#Property-titleID">titleID</a>, |
| <a href="Module.html#Property-units">units</a> |
| </p> |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p> |
| |
| <p>The report design element contains the information about |
| a report design. It represents the entire set of design information stored in a |
| BIRT report design file.</p> |
| |
| <p>The report design defines properties that describe the |
| design as a whole. Report design properties do not inherit because a design |
| cannot extend another design.</p> |
| |
| <h4>Scripting Summary</h4> |
| |
| <p>Runtime object: <code>report </code> |
| (global variable)</p> |
| |
| <p>Design object: <code>report.design</code></p></div> |
| <h3>See Also</h3> |
| |
| <div class="section-text"> |
| <p>Library element</p></div> |
| <h1>Property Detail</h1> |
| |
| <h2><a name="Property-cheatSheet">cheatSheet Property</a></h2> |
| |
| <p class="section-text">A string containing the file name of the cheat sheet.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#string">string</a></td></tr> |
| <tr><td>Since:</td> |
| <td>2.0</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Cheat sheet</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Inherited:</td> |
| <td>Yes</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>No</td></tr> |
| <tr><td>Property Sheet Visibility:</td> |
| <td>Visible</td></tr> |
| <tr><td>Property Sheet Group:</td> |
| <td>Top</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>A string containing the file name of the cheat sheet used with this design.</p></div> |
| |
| <hr> |
| <h2><a name="Property-cssStyleSheets">cssStyleSheets Property</a></h2> |
| |
| <p class="section-text"></p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td>List of <a href="../structs/IncludedCssStyleSheet.html">IncludedCssStyleSheet</a> Structures</td></tr> |
| <tr><td>Since:</td> |
| <td>2.2</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Css style sheets</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Inherited:</td> |
| <td>No</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>No</td></tr> |
| <tr><td>Property Sheet Visibility:</td> |
| <td>Hidden</td></tr> |
| <tr><td>Property Sheet Group:</td> |
| <td>Top</td></tr> |
| </table> |
| |
| |
| <hr> |
| <h2><a name="Property-displayName">displayName Property</a></h2> |
| |
| <p class="section-text">Display name of the report design</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#string">string</a></td></tr> |
| <tr><td>Since:</td> |
| <td>2.0</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Display name</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Inherited:</td> |
| <td>Yes</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>No</td></tr> |
| <tr><td>Property Sheet Visibility:</td> |
| <td>Visible</td></tr> |
| <tr><td>Property Sheet Group:</td> |
| <td>Top</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>The localized display name for the report design.</p></div> |
| |
| <hr> |
| <h2><a name="Property-displayNameID">displayNameID Property</a></h2> |
| |
| <p class="section-text">Resource key for the localizable display name property.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#resourceKey">resourceKey</a></td></tr> |
| <tr><td>Since:</td> |
| <td>2.0</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Display name key</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Inherited:</td> |
| <td>Yes</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>Yes</td></tr> |
| <tr><td>Property Sheet Visibility:</td> |
| <td>Visible</td></tr> |
| <tr><td>Property Sheet Group:</td> |
| <td>Top</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>Resource bundle key for the display name property, the localized display name value will |
| be looked up from a resource file relating to the current locale.</p></div> |
| |
| <hr> |
| <h2><a name="Property-eventHandlerClass">eventHandlerClass Property</a></h2> |
| |
| <p class="section-text">The full qulified name of the event handler class.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#string">string</a></td></tr> |
| <tr><td>Since:</td> |
| <td>2.0</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Event handler class</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Inherited:</td> |
| <td>Yes</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>Yes</td></tr> |
| <tr><td>Property Sheet Visibility:</td> |
| <td>Visible</td></tr> |
| <tr><td>Property Sheet Group:</td> |
| <td>Top</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>Full quilified name of the event handler class, used to specify an external Java class |
| which define the scripting behavior that will be executed at runtime.</p></div> |
| |
| <hr> |
| <h2><a name="Property-iconFile">iconFile Property</a></h2> |
| |
| <p class="section-text">The design icon/thumbnail file path</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#string">string</a></td></tr> |
| <tr><td>Since:</td> |
| <td>2.0</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Icon file</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Inherited:</td> |
| <td>Yes</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>No</td></tr> |
| <tr><td>Property Sheet Visibility:</td> |
| <td>Visible</td></tr> |
| <tr><td>Property Sheet Group:</td> |
| <td>Top</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>The design icon/thumbnail file path</p></div> |
| |
| <hr> |
| <h2><a name="Property-layoutPreference">layoutPreference Property</a></h2> |
| |
| <p class="section-text"></p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#choice">choice</a> (reportLayoutPreference)</td></tr> |
| <tr><td>Since:</td> |
| <td>2.2</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Layout preference</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>auto layout</td></tr> |
| <tr><td>Inherited:</td> |
| <td>Yes</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>No</td></tr> |
| <tr><td>Property Sheet Visibility:</td> |
| <td>Visible</td></tr> |
| <tr><td>Property Sheet Group:</td> |
| <td>Top</td></tr> |
| </table> |
| |
| <h3>Choices</h3> |
| |
| <table class="section-table"> |
| <thead><tr><td>Name</td><td>Display Name</td> |
| <td>Value</td><td>Description</td></tr></thead> |
| <tbody> |
| <tr><td>fixed layout</td> |
| <td>Fixed Layout</td> |
| <td>fixed layout</td> |
| <td></td></tr> |
| <tr><td>auto layout</td> |
| <td>Auto Layout</td> |
| <td>auto layout</td> |
| <td></td></tr> |
| </tbody></table><br> |
| |
| <hr> |
| <h2><a name="Property-refreshRate">refreshRate Property</a></h2> |
| |
| <p class="section-text">The refresh rate when viewing the report.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#integer">integer</a></td></tr> |
| <tr><td>Since:</td> |
| <td>reserved</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Refresh rate</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>0 (the |
| report does not refresh)</span></td></tr> |
| <tr><td>Inherited:</td> |
| <td>No</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>No</td></tr> |
| <tr><td>Property Sheet Visibility:</td> |
| <td>Hidden</td></tr> |
| <tr><td>Property Sheet Group:</td> |
| <td>Top</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>The refresh rate when viewing the report. The viewer will |
| automatically rerun and redisplay the report. The rate is given in seconds. A |
| rate of 0 means no refresh.</p></div> |
| |
| <hr> |
| <h2><a name="Property-thumbnail">thumbnail Property</a></h2> |
| |
| <p class="section-text"></p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#literalString">literalString</a></td></tr> |
| <tr><td>Since:</td> |
| <td>2.1</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Thumbnail</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Inherited:</td> |
| <td>Yes</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>No</td></tr> |
| <tr><td>Property Sheet Visibility:</td> |
| <td>Hidden</td></tr> |
| <tr><td>Property Sheet Group:</td> |
| <td>Top</td></tr> |
| </table> |
| |
| <h1>Method Detail</h1> |
| |
| <h2><a name="Method-afterFactory">afterFactory Method</a></h2> |
| |
| <p class="section-text">Perform initialization before opening the report document for writing.</p> |
| <h3>Synopsis |
| </h3> |
| |
| <p class="section-text"><code>None obj.afterFactory( )</code></p> |
| <h3>Details |
| </h3> |
| |
| <table class="detail-table"> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>Context:</td> |
| <td>factory</td></tr> |
| <tr><td>Arguments:</td> |
| <td>None</td></tr> |
| <tr><td>Return Type:</td> |
| <td>None</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>Called at the end of the Factory after closing the report |
| document (if any). This is the last method called in the Factory.</p></div> |
| <h3>See Also</h3> |
| |
| <div class="section-text"> |
| <p><code>beforeFactory</code> method</p></div> |
| |
| <hr> |
| <h2><a name="Method-afterRender">afterRender Method</a></h2> |
| |
| <p class="section-text">Called after completing a presentation time action.</p> |
| <h3>Synopsis |
| </h3> |
| |
| <p class="section-text"><code>None obj.afterRender( )</code></p> |
| <h3>Details |
| </h3> |
| |
| <table class="detail-table"> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>Context:</td> |
| <td>presentation</td></tr> |
| <tr><td>Arguments:</td> |
| <td>None</td></tr> |
| <tr><td>Return Type:</td> |
| <td>None</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>BIRT calls this method at the completion of each |
| presentation-time activity such as convert a page, print a report, extract data, |
| etc. Code is likely to be specific to the deployment platform.</p> |
| |
| <p>If the report is being run and rendered in a single pass, |
| then the call to <code>afterFactory</code> will precede the |
| call to <code>afterRender</code>.</p></div> |
| <h3>See Also</h3> |
| |
| <div class="section-text"> |
| <p><code>beforeRender</code> method</p></div> |
| |
| <hr> |
| <h2><a name="Method-beforeFactory">beforeFactory Method</a></h2> |
| |
| <p class="section-text">Perform initialization before opening the report document for writing.</p> |
| <h3>Synopsis |
| </h3> |
| |
| <p class="section-text"><code>None obj.beforeFactory( )</code></p> |
| <h3>Details |
| </h3> |
| |
| <table class="detail-table"> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>Context:</td> |
| <td>startup</td></tr> |
| <tr><td>Arguments:</td> |
| <td>None</td></tr> |
| <tr><td>Return Type:</td> |
| <td>None</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>Called at the start of the Factory after the initialize( ) |
| method and before opening the report document (if any).</p></div> |
| <h3>See Also</h3> |
| |
| <div class="section-text"> |
| <p>Module element <code>initialize</code> |
| method</p> |
| |
| <p><code>afterFactory</code> method</p></div> |
| |
| <hr> |
| <h2><a name="Method-beforeRender">beforeRender Method</a></h2> |
| |
| <p class="section-text">Called before starting a presentation time action.</p> |
| <h3>Synopsis |
| </h3> |
| |
| <p class="section-text"><code>None obj.beforeRender( )</code></p> |
| <h3>Details |
| </h3> |
| |
| <table class="detail-table"> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>Context:</td> |
| <td>presentation</td></tr> |
| <tr><td>Arguments:</td> |
| <td>None</td></tr> |
| <tr><td>Return Type:</td> |
| <td>None</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>BIRT calls this method at the start of each |
| presentation-time activity such as convert a page, print a report, extract data, |
| etc. Presentation activities are usually done in repose to a client request |
| coming into the Presentation Engine. Code is likely to be specific to the |
| deployment platform.</p> |
| |
| <p>BIRT may cache the same report session across multiple |
| render actions. For example, if a user wants to view pages 1 and 2, see the |
| table of contents, then do a search, the Presentation Engine may elect to keep |
| the report loaded and the JavaScript session in effect. This allows an |
| application to perform costly presentation-time initialization once, simply keep |
| a flag that indicates whether initialization has already been done by another |
| render action.</p> |
| |
| <p>If the report is being run and rendered in a single pass, |
| then this method is called after the call to <code> |
| beforeFactory</code>. If the rendering operation is being done on a report |
| previously created, then this method is called just after the initialize method.</p> |
| |
| <p>The Presentation Engine may choose to cache a report |
| design and script session across multiple render requests. In this case, each |
| render operation will trigger a call to <code>beforeRender</code> |
| and <code>afterRender</code>. The <code> |
| initialize</code> method will be called only when the report is first loaded.</p></div> |
| <h3>See Also</h3> |
| |
| <div class="section-text"> |
| <p><code>initialize</code> method</p> |
| |
| <p><code>afterRender </code>method</p></div> |
| |
| <hr> |
| <h2><a name="Method-initialize">initialize Method</a></h2> |
| |
| <p class="section-text">Called when the report starts executing in either the |
| Factory or Presentation engine.</p> |
| <h3>Synopsis |
| </h3> |
| |
| <p class="section-text"><code>None obj.initialize( )</code></p> |
| <h3>Details |
| </h3> |
| |
| <table class="detail-table"> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>Context:</td> |
| <td>startup</td></tr> |
| <tr><td>Arguments:</td> |
| <td>None</td></tr> |
| <tr><td>Return Type:</td> |
| <td>None</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>BIRT calls this method before calling any other method in |
| the design. </p> |
| |
| <p>BIRT calls this method at the start of the Factory and |
| Presentation engines, just after loading the imports, before opening the report |
| document. Implement this method to define global functions, objects, Java |
| imports and other resources used throughout the report.</p> |
| |
| <p>Libraries can also contain an init script and imports. |
| BIRT executes these scripts in the following order:</p> |
| |
| <ul> |
| <li>For each library, in the order that the library is included:</li> |
| |
| <ul> |
| <li>Locate, read and execute the imported scripts in the order they appear in |
| the Code Modules element.</li> |
| <li>Execute the <code>initialize</code> script.</li> |
| </ul> |
| |
| <li>For the report design itself.</li> |
| |
| <ul> |
| <li>Locate, read and execute the imported scripts in the order they appear in |
| the Code Modules element.</li> |
| <li>Execute the init script.</li> |
| </ul> |
| </ul> |
| |
| <p>In general, the <code>initialize</code> |
| method of a report design or library can reference resources defined in the |
| <code>initialize</code> script of any included libraries, but |
| not visa-versa. This is the generally accepted meaning of an include.</p></div> |
| <h3>See Also</h3> |
| |
| <div class="section-text"> |
| <p>Report Design <code>beforeFactory</code> method</p> |
| <p>Report Design <code>beforeRender</code> method</p></div> |
| <h1>Slot Detail</h1> |
| |
| <h2><a name="Slot-styles">styles Slot</a></h2> |
| |
| <p class="section-text">List of user-defined styles used to format elements in the report.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Styles</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>XML Element:</td> |
| <td><code>styles</code></td></tr> |
| <tr><td>Contents:</td> |
| <td>List of <a href="Style.html">Style</a></td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>User-defined styles used to format elements in the |
| report. Each style must have a unique name within the set of styles for this |
| report.</p></div> |
| |
| <hr> |
| <h2><a name="Slot-parameters">parameters Slot</a></h2> |
| |
| <p class="section-text">A list of Parameter elements that describe the data that the user can enter when running the report.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Parameters</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>XML Element:</td> |
| <td><code>parameters</code></td></tr> |
| <tr><td>Contents:</td> |
| <td>List of <a href="Parameter.html">Parameter</a>, <a href="ParameterGroup.html">ParameterGroup</a></td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>A list of parameter elements that describe the data that |
| the user can enter when running the report. BIRT supports four kinds of |
| parameters identified above. The design can also include parameter groups that |
| organize parameters visually.</p> |
| |
| <p>The order of parameters within this slot in the design |
| file determines the order that they will appear in the requester UI.</p> |
| |
| <p>The parameters property provides a "flattened" list of |
| parameters. Each parameter identifies the group (if any) to which it belongs.</p> |
| <p>Parameter values are also available using the |
| <code>params</code> global variable.</p></div> |
| |
| <hr> |
| <h2><a name="Slot-dataSources">dataSources Slot</a></h2> |
| |
| <p class="section-text">The connections used by the report.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Data Sources</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>XML Element:</td> |
| <td><code>data-sources</code></td></tr> |
| <tr><td>Contents:</td> |
| <td>List of <a href="DataSource.html">DataSource</a></td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>This slot holds the list of data sources defined within |
| the report itself. Each data source must have a unique name. The order of items |
| within this slot is unimportant.</p></div> |
| |
| <hr> |
| <h2><a name="Slot-dataSets">dataSets Slot</a></h2> |
| |
| <p class="section-text">Data sets (queries) defined in the design.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Data Sets</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>XML Element:</td> |
| <td><code>data-sets</code></td></tr> |
| <tr><td>Contents:</td> |
| <td>List of <a href="DataSet.html">DataSet</a>, <a href="TemplateDataSet.html">TemplateDataSet</a></td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>This slot holds the list of data sets defined within the |
| report itself. Each data set must have a unique name. The order of items within |
| this slot is unimportant.</p></div> |
| |
| <hr> |
| <h2><a name="Slot-pageSetup">pageSetup Slot</a></h2> |
| |
| <p class="section-text">The layout of the master pages within the report.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Page Setup</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>XML Element:</td> |
| <td><code>page-setup</code></td></tr> |
| <tr><td>Contents:</td> |
| <td>List of <a href="GraphicMasterPage.html">GraphicMasterPage</a>, <a href="SimpleMasterPage.html">SimpleMasterPage</a></td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>The page setup defines the way that the report will |
| appear when printed. It consists of a master page that defines the page size, |
| page "decoration", margins and so on. Some reports need to use different master |
| pages, perhaps to have the first page of the report appear in letterhead, with |
| the remaining pages on plain paper. Other reports may be printed and bound, |
| requiring differing page layout for the left and right pages.</p> |
| |
| <p>A report can omit the page setup information. If so, page |
| setup is taken from a library, if provided. If the library is not provided, or |
| does not have a page setup, or the master page does not have page dimensions, |
| then the setup comes from BIRT preferences, or from locale-specific defaults.</p> |
| |
| <p>If the user lists multiple master pages, but no page |
| sequences, then BIRT uses the first master page by default. If the user defines |
| one or more page sequences, then BIRT uses the first page sequence by default. |
| Other than these two cases, the order of elements within the page setup slot is |
| unimportant.</p> |
| |
| <p>This slot defines a name space; the name of each master |
| page and page sequence must be unique across the set of other page setup |
| elements.</p> |
| |
| <p>Only the simple master page is available in the first |
| release, and the design can contain at most one simple master page in the first |
| release.</p> |
| |
| <p>The page setup can contain zero or more master pages (of |
| either type) and zero or more page sequences (of either type). The simplest |
| report provides no master page. It will appear with the default pages size and |
| margins, and with no page header or footer.</p></div> |
| <h3>See Also</h3> |
| |
| <div class="section-text"> |
| <p>Library element</p></div> |
| |
| <hr> |
| <h2><a name="Slot-components">components Slot</a></h2> |
| |
| <p class="section-text">Reusable report items defined in this design. Report |
| items can extend these items. Defines a "private library" for this design.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Components</td></tr> |
| <tr><td>Since:</td> |
| <td>reserved</td></tr> |
| <tr><td>XML Element:</td> |
| <td><code>components</code></td></tr> |
| <tr><td>Contents:</td> |
| <td>List of <a href="Data.html">Data</a>, <a href="ExtendedItem.html">ExtendedItem</a>, <a href="FreeForm.html">FreeForm</a>, <a href="Grid.html">Grid</a>, <a href="Image.html">Image</a>, <a href="Label.html">Label</a>, <a href="Line.html">Line</a>, <a href="List.html">List</a>, <a href="Rectangle.html">Rectangle</a>, <a href="Table.html">Table</a>, <a href="Text.html">Text</a>, <a href="TextData.html">TextData</a></td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>This slot defines reusable report items defined in this |
| design. Report items can extend these items.</p> |
| |
| <p>A report developer may want to use the same image, text, |
| label or other item in several places within in the report. Instead of copying & |
| pasting, the developer can instead define the element once in the components |
| slot. Then, he can use the component to create the various instances.</p> |
| |
| <p>Using a reusable component helps reduce maintenance costs |
| because changes are made in only one place, rather than across several copies.</p> |
| |
| <p>This slot defines a "private library" for this design. |
| Components that are used by several reports appear in a "shared" library file.</p> |
| |
| <p>The following rules apply to the components slot:</p> |
| |
| <ul> |
| <li>All report items in the component area must have a name. (This rule |
| applies only to items directly in the component area, not to items nested inside |
| of other items.)</li> |
| |
| <li>All report items share a single name space, including those in the |
| Components and Body.</li> |
| |
| <li>Items in the Components area can extend from other items in the |
| Components area of the same type. In the design file, the base components must |
| physically appear before derived items.</li> |
| |
| <li>Any type of report item can appear in the Components area.</li> |
| |
| <li>Only report items can appear in the components area. Master pages, |
| styles, data sets, data sources, parameters and other elements cannot appear.</li> |
| |
| <li>Report items in the components area can contain other items if their |
| definition allows. For example, a grid can contain other items.</li> |
| </ul></div> |
| |
| <hr> |
| <h2><a name="Slot-body">body Slot</a></h2> |
| |
| <p class="section-text">The visual layout sections within the report.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Body</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>XML Element:</td> |
| <td><code>body</code></td></tr> |
| <tr><td>Contents:</td> |
| <td>List of <a href="Data.html">Data</a>, <a href="ExtendedItem.html">ExtendedItem</a>, <a href="FreeForm.html">FreeForm</a>, <a href="Grid.html">Grid</a>, <a href="Image.html">Image</a>, <a href="Label.html">Label</a>, <a href="List.html">List</a>, <a href="Table.html">Table</a>, <a href="TemplateReportItem.html">TemplateReportItem</a>, <a href="Text.html">Text</a>, <a href="TextData.html">TextData</a></td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>The body portion of a design contains a list of the |
| visual report content. Content is made up of one or more sections. A section is |
| a report item that fills the width of the page. Sections represent relatively |
| independent divisions within the report. In CSS terminology, a section is a |
| block-level element.</p> |
| |
| <p><span style="font-size: 10.0pt; font-family: Arial">The simplest design |
| contains a single section. However, sophisticated designs can contain any number |
| of sections.</span></p> |
| |
| <p>The body contains any |
| number of sections, in any order.</p></div> |
| |
| <hr> |
| <h2><a name="Slot-scratchPad">scratchPad Slot</a></h2> |
| |
| <p class="section-text">TBD</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Scratch Pad</td></tr> |
| <tr><td>Since:</td> |
| <td>reserved</td></tr> |
| <tr><td>XML Element:</td> |
| <td><code>scratch-pad</code></td></tr> |
| <tr><td>Contents:</td> |
| <td>List of <a href="Data.html">Data</a>, <a href="ExtendedItem.html">ExtendedItem</a>, <a href="FreeForm.html">FreeForm</a>, <a href="Grid.html">Grid</a>, <a href="Image.html">Image</a>, <a href="Label.html">Label</a>, <a href="Line.html">Line</a>, <a href="List.html">List</a>, <a href="Rectangle.html">Rectangle</a>, <a href="Table.html">Table</a>, <a href="Text.html">Text</a>, <a href="TextData.html">TextData</a></td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>TBD</p></div> |
| |
| <hr> |
| <h2><a name="Slot-templateParameterDefinitions">templateParameterDefinitions Slot</a></h2> |
| |
| <p class="section-text">Stores the reusable template definitions.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Template Parameter Definitions</td></tr> |
| <tr><td>Since:</td> |
| <td>2.0</td></tr> |
| <tr><td>XML Element:</td> |
| <td><code>template-parameter-definitions</code></td></tr> |
| <tr><td>Contents:</td> |
| <td>List of <a href="TemplateParameterDefinition.html">TemplateParameterDefinition</a></td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>Slot that stores the reusable template definitions, report items/data set/data source can |
| be created from a template definition</p></div> |
| |
| <hr> |
| <h2><a name="Slot-cubes">cubes Slot</a></h2> |
| |
| <p class="section-text"></p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Cube Elements</td></tr> |
| <tr><td>Since:</td> |
| <td>2.2</td></tr> |
| <tr><td>XML Element:</td> |
| <td><code>cubes</code></td></tr> |
| <tr><td>Contents:</td> |
| <td>List of <a href="Cube.html">Cube</a></td></tr> |
| </table> |
| |
| </body> |
| </html> |
