ref/rom/elements/Library.html - gerrit/www.eclipse.org/birt - Git at Google

 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
 <html>
 <head>
 <title>Library 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">Library Element</p>
 <h1>Element Overview</h1>
 <div class="section-text">
 Predefined set of components and rules.</div>
 <h3>Details</h3>

 <table class="detail-table">
 <tr><td>Display Name:</td>
 <td>Library</td></tr>
 <tr><td>Since:</td>
 <td>2.0</td></tr>
 <tr><td>XML Element:</td>
 <td><code>library</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>Slot Summary</h3>

 <dl class="section-text">
 <dt><a href="#Slot-themes">themes</a></dt>
 <dd>Contains a number of themes. Theme is a container for styles</dd>
 <dt><a href="#Slot-parameters">parameters</a></dt>
 <dd>A list of resuable 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>Reusable connections that can be used a report.</dd>
 <dt><a href="#Slot-dataSets">dataSets</a></dt>
 <dd>Reusable Data sets (queries).</dd>
 <dt><a href="#Slot-pageSetup">pageSetup</a></dt>
 <dd>Master pages are reusable components available to report designs.</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 &quot;private library&quot; for this design.</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>A BIRT report library is a collection of report components that can be used in a
 report design. Report components include reusable visual report items, data sources,
 data sets, parameters, translations and more.

 <p>A library is a customizable, pre-defined set of rules that helps a user quickly create
 a report with a specific look.

 <p>A BIRT library includes both formatting information and rules that help you the developer
 create a report. A library is like a "skin" for a report; it takes the data, structure and
 layout of a report and applies formatting defined in the library to transform the report's
 appearance.

 <p>A library may start with a "style sheet": a set of common styles to apply to all reports
 within an application. The library can then add commonly-used data sources, reusable components,
 translated text, images and more.</p></div>
 <h1>Slot Detail</h1>

 <h2><a name="Slot-themes">themes Slot</a></h2>

 <p class="section-text">Contains a number of themes. Theme is a container for styles</p>
 <h3>Details</h3>

 <table class="detail-table">
 <tr><td>Display Name:</td>
 <td>Themes</td></tr>
 <tr><td>Since:</td>
 <td>2.0</td></tr>
 <tr><td>XML Element:</td>
 <td><code>themes</code></td></tr>
 <tr><td>Contents:</td>
 <td>List of <a href="Theme.html">Theme</a></td></tr>
 </table>

 <h3>Description</h3>

 <div class="section-text">
 <p>Styles in a library is defined inside a theme, a report design first use the theme from a
 library, then reuse a style within the theme.</p></div>

 <hr>
 <h2><a name="Slot-parameters">parameters Slot</a></h2>

 <p class="section-text">A list of resuable 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>Such parameters don't appear in the report's "requester page" unit a report
 uses them. The result uses a reusable parameter by defining a new parameter
 that extends the parameter defined in the library. In most cases, the report
 design simply inherits all characteristics of the reusable parameter.</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 &quot;flattened&quot; 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">Reusable connections that can be used a 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 reusable data sources. 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">Reusable Data sets (queries).</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></td></tr>
 </table>

 <h3>Description</h3>

 <div class="section-text">
 <p>This slot holds the list of usable data sets. 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">Master pages are reusable components available to report designs.</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>Master pages are reusable components available to report designs.The report design can
 simply reuse a library master page, can extend and customize a library master page, or can
 define a page just for that report design.</p>

 <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 &quot;decoration&quot;, 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>

 <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 &quot;private library&quot; 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="List.html">List</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. 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 &amp; pasting, the developer can instead define the element
   once in the library components slot. Then, he can use library to create the
   various instances.</p>

 <p>&nbsp;</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>Cubes</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>
	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
	<html>
	<head>
	<title>Library 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">Library Element</p>
	<h1>Element Overview</h1>
	<div class="section-text">
	Predefined set of components and rules.</div>
	<h3>Details</h3>

	<table class="detail-table">
	<tr><td>Display Name:</td>
	<td>Library</td></tr>
	<tr><td>Since:</td>
	<td>2.0</td></tr>
	<tr><td>XML Element:</td>
	<td><code>library</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>Slot Summary</h3>

	<dl class="section-text">
	<dt><a href="#Slot-themes">themes</a></dt>
	<dd>Contains a number of themes. Theme is a container for styles</dd>
	<dt><a href="#Slot-parameters">parameters</a></dt>
	<dd>A list of resuable 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>Reusable connections that can be used a report.</dd>
	<dt><a href="#Slot-dataSets">dataSets</a></dt>
	<dd>Reusable Data sets (queries).</dd>
	<dt><a href="#Slot-pageSetup">pageSetup</a></dt>
	<dd>Master pages are reusable components available to report designs.</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-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>A BIRT report library is a collection of report components that can be used in a
	report design. Report components include reusable visual report items, data sources,
	data sets, parameters, translations and more.

	<p>A library is a customizable, pre-defined set of rules that helps a user quickly create
	a report with a specific look.

	<p>A BIRT library includes both formatting information and rules that help you the developer
	create a report. A library is like a "skin" for a report; it takes the data, structure and
	layout of a report and applies formatting defined in the library to transform the report's
	appearance.

	<p>A library may start with a "style sheet": a set of common styles to apply to all reports
	within an application. The library can then add commonly-used data sources, reusable components,
	translated text, images and more.</p></div>
	<h1>Slot Detail</h1>

	<h2><a name="Slot-themes">themes Slot</a></h2>

	<p class="section-text">Contains a number of themes. Theme is a container for styles</p>
	<h3>Details</h3>

	<table class="detail-table">
	<tr><td>Display Name:</td>
	<td>Themes</td></tr>
	<tr><td>Since:</td>
	<td>2.0</td></tr>
	<tr><td>XML Element:</td>
	<td><code>themes</code></td></tr>
	<tr><td>Contents:</td>
	<td>List of <a href="Theme.html">Theme</a></td></tr>
	</table>

	<h3>Description</h3>

	<div class="section-text">
	<p>Styles in a library is defined inside a theme, a report design first use the theme from a
	library, then reuse a style within the theme.</p></div>

	<hr>
	<h2><a name="Slot-parameters">parameters Slot</a></h2>

	<p class="section-text">A list of resuable 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>Such parameters don't appear in the report's "requester page" unit a report
	uses them. The result uses a reusable parameter by defining a new parameter
	that extends the parameter defined in the library. In most cases, the report
	design simply inherits all characteristics of the reusable parameter.</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">Reusable connections that can be used a 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 reusable data sources. 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">Reusable Data sets (queries).</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></td></tr>
	</table>

	<h3>Description</h3>

	<div class="section-text">
	<p>This slot holds the list of usable data sets. 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">Master pages are reusable components available to report designs.</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>Master pages are reusable components available to report designs.The report design can
	simply reuse a library master page, can extend and customize a library master page, or can
	define a page just for that report design.</p>

	<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>

	<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="List.html">List</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. 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 library components slot. Then, he can use library to create the
	various instances.</p>

	<p> </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>Cubes</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>