| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN"> |
| <html> |
| <head> |
| <title>Row 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">Row Element</p> |
| <h1>Element Overview</h1> |
| <div class="section-text"> |
| Represents one row within a grid or table.</div> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Row</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>XML Element:</td> |
| <td><code>row</code></td></tr> |
| <tr><td>Extends:</td> |
| <td>None</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>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>A bookmark to use as a target of links within this |
| report.</dd> |
| <dt><a href="#Property-eventHandlerClass">eventHandlerClass</a></dt> |
| <dd>The full qulified name of the event handler class.</dd> |
| <dt><a href="#Property-height">height</a></dt> |
| <dd>Minimum height of the row.</dd> |
| <dt><a href="#Property-style">style</a></dt> |
| <dd>Name of the style applied to this row.</dd> |
| <dt><a href="#Property-suppressDuplicates">suppressDuplicates</a></dt> |
| <dd></dd> |
| <dt><a href="#Property-viewAction">viewAction</a></dt> |
| <dd></dd> |
| <dt><a href="#Property-visibility">visibility</a></dt> |
| <dd>A list of rules for hiding and displaying this row in various output formats.</dd> |
| </dl> |
| |
| <h3>Method Summary</h3> |
| |
| <dl class="section-text"> |
| <dt><a href="#Method-onCreate">onCreate</a></dt> |
| <dd>Script executed when the element is created in the Factory.</dd> |
| <dt><a href="#Method-onPrepare">onPrepare</a></dt> |
| <dd>It is for a script startup phase. No data binding yet. The design of an element can be changed here.</dd> |
| <dt><a href="#Method-onRender">onRender</a></dt> |
| <dd>Script executed when the element is prepared for rendering in the Presentation engine.</dd> |
| </dl> |
| |
| <h3>Slot Summary</h3> |
| |
| <dl class="section-text"> |
| <dt><a href="#Slot-cells">cells</a></dt> |
| <dd>Any number of cell entries for the row.</dd> |
| </dl> |
| |
| <h3>Style Properties</h3> |
| |
| <p class="section-text"> |
| <a href="Style.html#Property-backgroundAttachment">backgroundAttachment</a>, |
| <a href="Style.html#Property-backgroundColor">backgroundColor</a>, |
| <a href="Style.html#Property-backgroundImage">backgroundImage</a>, |
| <a href="Style.html#Property-backgroundPositionX">backgroundPositionX</a>, |
| <a href="Style.html#Property-backgroundPositionY">backgroundPositionY</a>, |
| <a href="Style.html#Property-backgroundRepeat">backgroundRepeat</a>, |
| <a href="Style.html#Property-borderBottomColor">borderBottomColor</a>, |
| <a href="Style.html#Property-borderBottomStyle">borderBottomStyle</a>, |
| <a href="Style.html#Property-borderBottomWidth">borderBottomWidth</a>, |
| <a href="Style.html#Property-borderLeftColor">borderLeftColor</a>, |
| <a href="Style.html#Property-borderLeftStyle">borderLeftStyle</a>, |
| <a href="Style.html#Property-borderLeftWidth">borderLeftWidth</a>, |
| <a href="Style.html#Property-borderRightColor">borderRightColor</a>, |
| <a href="Style.html#Property-borderRightStyle">borderRightStyle</a>, |
| <a href="Style.html#Property-borderRightWidth">borderRightWidth</a>, |
| <a href="Style.html#Property-borderTopColor">borderTopColor</a>, |
| <a href="Style.html#Property-borderTopStyle">borderTopStyle</a>, |
| <a href="Style.html#Property-borderTopWidth">borderTopWidth</a>, |
| <a href="Style.html#Property-canShrink">canShrink</a>, |
| <a href="Style.html#Property-color">color</a>, |
| <a href="Style.html#Property-dateFormat">dateFormat</a>, |
| <a href="Style.html#Property-dateTimeFormat">dateTimeFormat</a>, |
| <a href="Style.html#Property-display">display</a>, |
| <a href="Style.html#Property-fontFamily">fontFamily</a>, |
| <a href="Style.html#Property-fontSize">fontSize</a>, |
| <a href="Style.html#Property-fontStyle">fontStyle</a>, |
| <a href="Style.html#Property-fontVariant">fontVariant</a>, |
| <a href="Style.html#Property-fontWeight">fontWeight</a>, |
| <a href="Style.html#Property-highlightRules">highlightRules</a>, |
| <a href="Style.html#Property-letterSpacing">letterSpacing</a>, |
| <a href="Style.html#Property-lineHeight">lineHeight</a>, |
| <a href="Style.html#Property-mapRules">mapRules</a>, |
| <a href="Style.html#Property-marginBottom">marginBottom</a>, |
| <a href="Style.html#Property-marginLeft">marginLeft</a>, |
| <a href="Style.html#Property-marginRight">marginRight</a>, |
| <a href="Style.html#Property-marginTop">marginTop</a>, |
| <a href="Style.html#Property-masterPage">masterPage</a>, |
| <a href="Style.html#Property-numberAlign">numberAlign</a>, |
| <a href="Style.html#Property-numberFormat">numberFormat</a>, |
| <a href="Style.html#Property-orphans">orphans</a>, |
| <a href="Style.html#Property-paddingBottom">paddingBottom</a>, |
| <a href="Style.html#Property-paddingLeft">paddingLeft</a>, |
| <a href="Style.html#Property-paddingRight">paddingRight</a>, |
| <a href="Style.html#Property-paddingTop">paddingTop</a>, |
| <a href="Style.html#Property-pageBreakAfter">pageBreakAfter</a>, |
| <a href="Style.html#Property-pageBreakBefore">pageBreakBefore</a>, |
| <a href="Style.html#Property-pageBreakInside">pageBreakInside</a>, |
| <a href="Style.html#Property-showIfBlank">showIfBlank</a>, |
| <a href="Style.html#Property-stringFormat">stringFormat</a>, |
| <a href="Style.html#Property-textAlign">textAlign</a>, |
| <a href="Style.html#Property-textIndent">textIndent</a>, |
| <a href="Style.html#Property-textLineThrough">textLineThrough</a>, |
| <a href="Style.html#Property-textOverline">textOverline</a>, |
| <a href="Style.html#Property-textTransform">textTransform</a>, |
| <a href="Style.html#Property-textUnderline">textUnderline</a>, |
| <a href="Style.html#Property-timeFormat">timeFormat</a>, |
| <a href="Style.html#Property-verticalAlign">verticalAlign</a>, |
| <a href="Style.html#Property-whiteSpace">whiteSpace</a>, |
| <a href="Style.html#Property-widows">widows</a>, |
| <a href="Style.html#Property-wordSpacing">wordSpacing</a> |
| </p> |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>A row element describes one row in a grid or table. A row |
| is composed of a list of cells. Rows can set style properties to affect all |
| cells within the row.</p></div> |
| <h1>Property Detail</h1> |
| |
| <h2><a name="Property-bookmark">bookmark Property</a></h2> |
| |
| <p class="section-text">A bookmark to use as a target of links within this |
| report.</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>Hidden</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-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-height">height Property</a></h2> |
| |
| <p class="section-text">Minimum height of the row.</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>Top</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p><p>Minimum height of the row. Some items have a dynamic |
| size. The actual size of row is computed as the minimum of the tallest cell |
| within the row, or the row height.</p></p></div> |
| |
| <hr> |
| <h2><a name="Property-style">style Property</a></h2> |
| |
| <p class="section-text">Name of the style applied to this row.</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>Rows 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 "override" those inherited from a parent element |
| or a shared style.</p></p> |
| |
| <p>All properties defined for a style appear as |
| properties on report items also. See the Style element for the list of |
| properties that appear here.</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-suppressDuplicates">suppressDuplicates Property</a></h2> |
| |
| <p class="section-text"></p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#boolean">boolean</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>Suppress Duplicates</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>false</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-viewAction">viewAction 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> (viewAction)</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>View action</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>NoChange</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>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>NoChange</td> |
| <td>No Change</td> |
| <td>NoChange</td> |
| <td></td></tr> |
| <tr><td>Changed</td> |
| <td>Changed</td> |
| <td>Changed</td> |
| <td></td></tr> |
| <tr><td>Added</td> |
| <td>Added</td> |
| <td>Added</td> |
| <td></td></tr> |
| <tr><td>Deleted</td> |
| <td>Deleted</td> |
| <td>Deleted</td> |
| <td></td></tr> |
| </tbody></table><br> |
| |
| <hr> |
| <h2><a name="Property-visibility">visibility Property</a></h2> |
| |
| <p class="section-text">A list of rules for hiding and displaying this row in various output formats.</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>1.0</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>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>The visibility rules control when the row appears in the |
| report. A row can be completely hidden, in which case it won�t even be created |
| in the Factory. A row can also be hidden conditionally depending on the output |
| format.</p></p></div> |
| <h3>See Also</h3> |
| |
| <div class="section-text"> |
| <p>Visibility Rule structure for the details of the rules.</p></div> |
| <h1>Method Detail</h1> |
| |
| <h2><a name="Method-onCreate">onCreate Method</a></h2> |
| |
| <p class="section-text">Script executed when the element is created in the Factory.</p> |
| <h3>Synopsis |
| </h3> |
| |
| <p class="section-text"><code>None obj.onCreate( )</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>Executed when the element is created in the Factory. Called after the item is created, but before |
| the item is saved to the report document file. See the scripting spec for additional information |
| about this script. Applications should perform visual customization in the on-render script instead.</p></div> |
| |
| <hr> |
| <h2><a name="Method-onPrepare">onPrepare Method</a></h2> |
| |
| <p class="section-text">It is for a script startup phase. No data binding yet. The design of an element can be changed here.</p> |
| <h3>Synopsis |
| </h3> |
| |
| <p class="section-text"><code>None obj.onPrepare( )</code></p> |
| <h3>Details |
| </h3> |
| |
| <table class="detail-table"> |
| <tr><td>Since:</td> |
| <td>2.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>It is for a script startup phase. No data binding yet. The design of an element can be changed here.</p></div> |
| |
| <hr> |
| <h2><a name="Method-onRender">onRender Method</a></h2> |
| |
| <p class="section-text">Script executed when the element is prepared for rendering in the Presentation engine.</p> |
| <h3>Synopsis |
| </h3> |
| |
| <p class="section-text"><code>None obj.onRender( )</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>Executed when the element is prepared for rendering in the Presentation engine. Changes made to the |
| element are written to the target output format, but not saved to the report document file. This is the |
| preferred place for visual customizations.</p></div> |
| <h3>See Also</h3> |
| |
| <div class="section-text"> |
| <p>Dimension property type</p></div> |
| <h1>Slot Detail</h1> |
| |
| <h2><a name="Slot-cells">cells Slot</a></h2> |
| |
| <p class="section-text">Any number of cell entries for the row.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Cells</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>XML Element:</td> |
| <td>None. (The contents appear directly within the container element.)</td></tr> |
| <tr><td>Contents:</td> |
| <td>List of <a href="Cell.html">Cell</a></td></tr> |
| <tr><td>Default Style:</td> |
| <td>None</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p><p>Any number of Cell elements for the row.</p></p></div> |
| </body> |
| </html> |
