| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN"> |
| <html> |
| <head> |
| <title>Parameter Group 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">ParameterGroup Element</p> |
| <h1>Element Overview</h1> |
| <div class="section-text"> |
| Visual grouping of report parameters.</div> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Parameter Group</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>XML Element:</td> |
| <td><code>parameter-group</code></td></tr> |
| <tr><td>Extends:</td> |
| <td><a href="ReportElement.html">ReportElement</a></td></tr> |
| <tr><td>Extendable:</td> |
| <td>Yes</td></tr> |
| <tr><td>Abstract:</td> |
| <td>No</td></tr> |
| <tr><td>Name Space:</td> |
| <td>Parameters</td></tr> |
| <tr><td>Name Requirement:</td> |
| <td>Required</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-helpText">helpText</a></dt> |
| <dd>Additional pop-up help text associated with the group.</dd> |
| <dt><a href="#Property-helpTextID">helpTextID</a></dt> |
| <dd>Resource key for the help text.</dd> |
| <dt><a href="#Property-startExpanded">startExpanded</a></dt> |
| <dd>Whether the group should start expanded in the UI, or start collapsed.</dd> |
| </dl> |
| |
| <h3>Slot Summary</h3> |
| |
| <dl class="section-text"> |
| <dt><a href="#Slot-parameters">parameters</a></dt> |
| <dd>The set of parameters that appear inside the group.</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>Inherited Property Notes</h3> |
| |
| <dl class="section-text"> |
| <dt><a href="ReportElement.html#Property-name">name</a></dt> |
| <dd>The internal name of the group. The name must be |
| unique among parameters and parameter groups. The user will see this name unless |
| the display name is defined. The name cannot be externalized.</dd> |
| </dl> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>A parameter group creates a visual grouping of |
| parameters. The developer controls the order that groups appear in the UI, and |
| the order in which parameters appear in the group. A runtime UI may choose to |
| allow the user to expand & collapse parameter groups independently.</p></div> |
| <h1>Property Detail</h1> |
| |
| <h2><a name="Property-helpText">helpText Property</a></h2> |
| |
| <p class="section-text">Additional pop-up help text associated with the group.</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>1.0</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Help text</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>Additional pop-up help text associated with the group. |
| This text can explain the purpose of the group, or provide overall explanation |
| of how a set of parameters work together. The help text can be localized.</p></div> |
| |
| <hr> |
| <h2><a name="Property-helpTextID">helpTextID Property</a></h2> |
| |
| <p class="section-text">Resource key for the help text.</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>1.0</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Help text 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>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>Resource bundle key for the localizable help text.</p></div> |
| |
| <hr> |
| <h2><a name="Property-startExpanded">startExpanded Property</a></h2> |
| |
| <p class="section-text">Whether the group should start expanded in the UI, or start collapsed.</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>1.0</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Start expanded</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>true</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>If the UI can expand and collapse groups, then the UI |
| should assume that groups appear in "collapsed" form by default. Use this |
| attribute to cause the group to appear expanded by default instead. Ignored if |
| the UI does not support group expand/collapse.</p></div> |
| <h1>Slot Detail</h1> |
| |
| <h2><a name="Slot-parameters">parameters Slot</a></h2> |
| |
| <p class="section-text">The set of parameters that appear inside the group.</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></td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>The set of parameters that appear inside the group. The |
| UI should ignore the group is empty. Parameters appear in the UI in the same |
| order that they appear in this list.</p></div> |
| </body> |
| </html> |
