blob: 52f80685130e71c6604e00b9ea5f91d3f6cc51d2 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Report Item 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">ReportItem Element</p>
<h1>Element Overview</h1>
<div class="section-text">
Abstract base element for all visual report items.</div>
<h3>Details</h3>
<table class="detail-table">
<tr><td>Display Name:</td>
<td>Report Item</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>XML Element:</td>
<td><code>None</code></td></tr>
<tr><td>Extends:</td>
<td><a href="ReportElement.html">ReportElement</a></td></tr>
<tr><td>Extendable:</td>
<td>No</td></tr>
<tr><td>Abstract:</td>
<td>Yes</td></tr>
<tr><td>Name Space:</td>
<td>Report Items</td></tr>
<tr><td>Name Requirement:</td>
<td>Optional</td></tr>
<tr><td>Allows User Properties:</td>
<td>Yes</td></tr>
<tr><td>Has Style:</td>
<td>Yes</td></tr>
<tr><td>Default Style:</td>
<td>None</td></tr>
</table>
<h3>Property Summary</h3>
<dl class="section-text">
<dt><a href="#Property-bookmark">bookmark</a></dt>
<dd>Defines this item as a hyperlink target.</dd>
<dt><a href="#Property-boundDataColumns">boundDataColumns</a></dt>
<dd>Bindings the data set column and expressions with the property values..</dd>
<dt><a href="#Property-cube">cube</a></dt>
<dd></dd>
<dt><a href="#Property-dataBindingRef">dataBindingRef</a></dt>
<dd></dd>
<dt><a href="#Property-dataSet">dataSet</a></dt>
<dd>The name of the data set that provides data for this item.</dd>
<dt><a href="#Property-height">height</a></dt>
<dd>Height of the item.</dd>
<dt><a href="#Property-paramBindings">paramBindings</a></dt>
<dd>Bindings between input parameters in the included design and values in the main design.</dd>
<dt><a href="#Property-refTemplateParameter">refTemplateParameter</a></dt>
<dd>Name of the template parameter definition.</dd>
<dt><a href="#Property-style">style</a></dt>
<dd>Name of the style applied to this item.</dd>
<dt><a href="#Property-toc">toc</a></dt>
<dd>A table of contents entry for this item.</dd>
<dt><a href="#Property-visibility">visibility</a></dt>
<dd>A list of visibility rules that determines when the item appears.</dd>
<dt><a href="#Property-width">width</a></dt>
<dd>Width of the item.</dd>
<dt><a href="#Property-x">x</a></dt>
<dd>The x (horizontal) position of the item.</dd>
<dt><a href="#Property-y">y</a></dt>
<dd>The y (vertical) position of the item.</dd>
<dt><a href="#Property-zIndex">zIndex</a></dt>
<dd></dd>
</dl>
<h3>Inherited Properties</h3>
<p class="section-text">
<a href="ReportElement.html#Property-comments">comments</a>,
<a href="DesignElement.html#Property-customXml">customXml</a>,
<a href="ReportElement.html#Property-displayName">displayName</a>,
<a href="ReportElement.html#Property-displayNameID">displayNameID</a>,
<a href="ReportElement.html#Property-eventHandlerClass">eventHandlerClass</a>,
<a href="ReportElement.html#Property-extends">extends</a>,
<a href="ReportElement.html#Property-name">name</a>,
<a href="DesignElement.html#Property-propertyMasks">propertyMasks</a>,
<a href="DesignElement.html#Property-userProperties">userProperties</a>,
<a href="ReportElement.html#Property-viewAction">viewAction</a>
</p>
<h3>Description</h3>
<div class="section-text">
<p>ReportItem is the common base element for all visual report elements. Report
items include a style. The style provides visual characteristics for anything
that prints in a report: a section or report item.</p>
<p>Report items are positioned within the report based on a series of rules
described in the ROM Layout Specification. The free-form item provides absolute
(x, y) positioning, but most other containers provide some kinds of automated
positioning. The report item provides properties for each kind of layout, but
the properties are used only when appropriate. For example, every item can have
an (x, y) position, but the position is ignored unless the item appears within a
free-form container.</p>
<p>Each report item also has a private style. The private
style is a separate element in the XML definition. However, within the UI and
scripting, the style properties appear as though they were properties of this
item itself.</p>
<h4>Report Item Inheritance</h4>
<p>Report items can extend other report items. However, to keep the system
manageable, ROM allows a report item to extend only those items defined in a
library. (Libraries are not yet available in Release 1.0.)</p>
<p>A report item cannot extend another report item that appears in the Body area
of the report design.</p>
<p>These rules avoid complex designs such as having a container extend the
container that contains itself. (A determined user can still create this
scenario within a library, however.)</p></div>
<h1>Property Detail</h1>
<h2><a name="Property-bookmark">bookmark Property</a></h2>
<p class="section-text">Defines this item as a hyperlink target.</p>
<h3>Details</h3>
<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#expression">expression</a></td></tr>
<tr><td>Context:</td>
<td></td></tr>
<tr><td>Expression Type:</td>
<td>string</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>Bookmark</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><p>Many report items can be the target of hyperlinks. The
bookmark is a string that uniquely identifies the item instance within the
report. This property is an expression that evaluates to a string. If the string
is blank or null, then the item has no bookmark. Bookmarks should be unique. If
there are duplicates, the behavior of the hyperlink is undefined: it may jump to
the first item with that name.</p></p></div>
<h3>See Also</h3>
<div class="section-text">
<p>Action property on labels, data items, images and other
items.</p></div>
<hr>
<h2><a name="Property-boundDataColumns">boundDataColumns Property</a></h2>
<p class="section-text">Bindings the data set column and expressions with the property values..</p>
<h3>Details</h3>
<table class="detail-table">
<tr><td>Type:</td>
<td>List of <a href="../structs/ComputedColumn.html">ComputedColumn</a> Structures</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>Bound data columns</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>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>
<h3>Description</h3>
<div class="section-text">
<p>
<p>Property values of a report item can bind to a data set column or other expressions through bound data columns' names. If a data set column or expression are not bound in the data columns, the exeuction of the expression fails.</p>
<p></p></div>
<h3>See Also</h3>
<div class="section-text">
<p>&nbsp;</p></div>
<hr>
<h2><a name="Property-cube">cube Property</a></h2>
<p class="section-text"></p>
<h3>Details</h3>
<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../elements/Cube.html">Cube</a> Reference</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>Cube</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>
<hr>
<h2><a name="Property-dataBindingRef">dataBindingRef Property</a></h2>
<p class="section-text"></p>
<h3>Details</h3>
<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../elements/ReportItem.html">ReportItem</a> Reference</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>Data binding reference</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>
<hr>
<h2><a name="Property-dataSet">dataSet Property</a></h2>
<p class="section-text">The name of the data set that provides data for this item.</p>
<h3>Details</h3>
<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../elements/DataSet.html">DataSet</a> Reference</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Data set</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><p>Reference to the data set to use
for this component. If blank, the data set is that defined for the enclosing
list, table or other element. See derived elements for the use of the data set
for that element.</p>
<p>The data set name is optional. If none is provided, then
the report item &quot;inherits&quot; a data set. A report item used as a section
automatically uses the first data set defined in the report design. This
convenience exists to simplify the tasks for customers to create simple reports
using the XML design format. A report item nested inside a container uses the
data set for the container.</p>
</p></div>
<h3>See Also</h3>
<div class="section-text">
<p>Report Item <code> bindings</code>
property</p></div>
<hr>
<h2><a name="Property-height">height Property</a></h2>
<p class="section-text">Height of the item.</p>
<h3>Details</h3>
<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#dimension">dimension</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Height</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>Report Item</td></tr>
</table>
<h3>Description</h3>
<div class="section-text">
<p><p>Height of the item. Some items have a dynamic size. In
this case, this is the minimum height, or may be ignored altogether. The actual
size in the printed report usually depends on the content, and may be larger
than the height set here. For example, a data, label or text item will grow as
tall as required to display its content.</p></p></div>
<h3>See Also</h3>
<div class="section-text">
<p>Report Item <code> width</code> property</p></div>
<hr>
<h2><a name="Property-paramBindings">paramBindings Property</a></h2>
<p class="section-text">Bindings between input parameters in the included design and values in the main design.</p>
<h3>Details</h3>
<table class="detail-table">
<tr><td>Type:</td>
<td>List of <a href="../structs/ParamBinding.html">ParamBinding</a> Structures</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Parameter bindings </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>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>
<h3>Description</h3>
<div class="section-text">
<p><p>A report item can bind to a data set as described in the
data set property. A report item can pass information to the data set by
providing <i>bindings</i> to input parameters of the data set. Each binding
identifies an input parameter by name, and provides an expression that gives the
value of the parameter.</p></p></div>
<h3>See Also</h3>
<div class="section-text">
<p>Report Item <code>dataSet</code>
property</p>
<p>Data Set element, especially the Parameters
property</p></div>
<hr>
<h2><a name="Property-refTemplateParameter">refTemplateParameter Property</a></h2>
<p class="section-text">Name of the template parameter definition.</p>
<h3>Details</h3>
<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../elements/TemplateParameterDefinition.html">TemplateParameterDefinition</a> Reference</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>Referred template parameter definition</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>
<h3>Description</h3>
<div class="section-text">
<p>when a report item is created from an <i>template element</i>,
this property will reference to the base template element definition. </p></div>
<hr>
<h2><a name="Property-style">style Property</a></h2>
<p class="section-text">Name of the style applied to this item.</p>
<h3>Details</h3>
<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../elements/Style.html">Style</a> Reference</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Style</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><p>Report items provide many style properties. The style
properties are defined in the <i>ROM Styles Specification</i>. An element can
inherit its style properties from a parent element, from a named style, or from
a style that identifies the context in which the item appears. This property
provides the name of the shared style to use.</p>
<p>This item can also set the value of style properties.
Properties set on this element &quot;override&quot; those inherited from a parent element
or a shared style.</p></p></div>
<h3>See Also</h3>
<div class="section-text">
<p>Style element in the <i>ROM Styles Specification</i>.</p></div>
<hr>
<h2><a name="Property-toc">toc Property</a></h2>
<p class="section-text">A table of contents entry for this item.</p>
<h3>Details</h3>
<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../structs/TOCStructure.html">TOCStructure</a> Structure</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>TOC</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>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>
<h3>Description</h3>
<div class="section-text">
<p><p>A table of contents entry for this item. The TOC property
defines an expression that returns a string that is to appear in the Table of
Contents for this item or its container.</p></p></div>
<hr>
<h2><a name="Property-visibility">visibility Property</a></h2>
<p class="section-text">A list of visibility rules that determines when the item appears.</p>
<h3>Details</h3>
<table class="detail-table">
<tr><td>Type:</td>
<td>List of <a href="../structs/HideRule.html">HideRule</a> Structures</td></tr>
<tr><td>Since:</td>
<td>reserved</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Visibility </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>
<h3>Description</h3>
<div class="section-text">
<p><p>The visibility rules control when the item appears in the
report. An item can be completely hidden, in which case it won�t even be created
in the Factory. For example, perhaps the Country item should appear for
international customers, but not domestic customers. An item can also be hidden
conditionally depending on the output format. For example, perhaps a hyperlink
should appear when the report is viewed on the web, but not when it is printed.</p></p></div>
<h3>See Also</h3>
<div class="section-text">
<p>Visibility Rule structure for the details of the rules.</p></div>
<hr>
<h2><a name="Property-width">width Property</a></h2>
<p class="section-text">Width of the item.</p>
<h3>Details</h3>
<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#dimension">dimension</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Width</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>Report Item</td></tr>
</table>
<h3>Description</h3>
<div class="section-text">
<p><p>Width of the item. When an item appears as a section (a
top-level bit of content within the report), the width property is often
ignored, and is taken to be the width of the page. See the derived elements for
details.</p></p></div>
<h3>See Also</h3>
<div class="section-text">
<p>Report Item <code> height</code> property</p></div>
<hr>
<h2><a name="Property-x">x Property</a></h2>
<p class="section-text">The x (horizontal) position of the item.</p>
<h3>Details</h3>
<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#dimension">dimension</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>X</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>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Report Item</td></tr>
</table>
<h3>Description</h3>
<div class="section-text">
<p><p>The x position of the item. This is an absolute dimension
relative to from the left of the container. Dimensions include both a measure
and units: &quot;10in&quot; or &quot;5cm&quot;. The position can also be relative: &quot;10%&quot;.</p>
<p>The position is used only for containers that provide
absolute positioning. Such containers include the free-form container and the
graphic master page. Otherwise, the position is computed automatically by the
container, and this property is ignored.</p></p></div>
<h3>See Also</h3>
<div class="section-text">
<p>Dimension property type</p>
<p>Report Item <code> y</code> property</p></div>
<hr>
<h2><a name="Property-y">y Property</a></h2>
<p class="section-text">The y (vertical) position of the item.</p>
<h3>Details</h3>
<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#dimension">dimension</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>Y</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>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Report Item</td></tr>
</table>
<h3>Description</h3>
<div class="section-text">
<p><p>The x position of the item. This is an absolute dimension
relative to from the top of the container. Dimensions include both a measure and
units: &quot;10in&quot; or &quot;5cm&quot;. The position can also be relative: &quot;10%&quot;.</p>
<p>The position is used only for containers that provide
absolute positioning. Such containers include the free-form container and the
graphic master page. Otherwise, the position is computed automatically by the
container, and this property is ignored.</p></p></div>
<h3>See Also</h3>
<div class="section-text">
<p>Dimension property type</p>
<p>Report Item <code> x</code> property</p></div>
<hr>
<h2><a name="Property-zIndex">zIndex Property</a></h2>
<p class="section-text"></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>2.2</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Z index</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>0</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>
</body>
</html>