| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN"> |
| <html> |
| <head> |
| <title>Parameter 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">Parameter Element</p> |
| <h1>Element Overview</h1> |
| <div class="section-text"> |
| The base parameter element defines properties common to |
| all types of parameters.</div> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Parameter</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>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 text to display for the parameter to explain how to use the parameter.</dd> |
| <dt><a href="#Property-helpTextID">helpTextID</a></dt> |
| <dd>Resource key for the helpText</dd> |
| <dt><a href="#Property-hidden">hidden</a></dt> |
| <dd>Hides the parameter from the parameter UI.</dd> |
| </dl> |
| |
| <h3>Method Summary</h3> |
| |
| <dl class="section-text"> |
| <dt><a href="#Method-validate">validate</a></dt> |
| <dd>Validation method associated with the parameter</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 parameter, inherited from |
| Report Element. Expressions in the report reference the parameter using this |
| name. 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>The base parameter element defines |
| properties common to all types of parameters. Parameters can be hidden, meaning |
| that they will not appear in the UI. Parameters also provide additional pop-up |
| help text that can explain the use of the parameter to the end user.</p></div> |
| <h1>Property Detail</h1> |
| |
| <h2><a name="Property-helpText">helpText Property</a></h2> |
| |
| <p class="section-text">Additional text to display for the parameter to explain how to use the parameter.</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 text to display for the parameter to explain |
| how to use the parameter. The string can be externalized. </p></div> |
| |
| <hr> |
| <h2><a name="Property-helpTextID">helpTextID Property</a></h2> |
| |
| <p class="section-text">Resource key for the helpText</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>none</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>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>helpText can be externalized. helpTextId is the resource key for the helpText. </p></div> |
| |
| <hr> |
| <h2><a name="Property-hidden">hidden Property</a></h2> |
| |
| <p class="section-text">Hides the parameter from the parameter UI.</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>Hidden</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>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 true, the parameter will not appear in the Requester |
| page. Allows the developer to create parameters for internal use, or for use by |
| scripts. Parameters are visible by default.</p></div> |
| <h3>See Also</h3> |
| |
| <div class="section-text"> |
| <p><code>concealValue</code> property of |
| the Scalar Parameter</p></div> |
| <h1>Method Detail</h1> |
| |
| <h2><a name="Method-validate">validate Method</a></h2> |
| |
| <p class="section-text">Validation method associated with the parameter</p> |
| <h3>Synopsis |
| </h3> |
| |
| <p class="section-text"><code>boolean obj.validate( )</code></p> |
| <h3>Details |
| </h3> |
| |
| <table class="detail-table"> |
| <tr><td>Since:</td> |
| <td>reserved</td></tr> |
| <tr><td>Context:</td> |
| <td>factory</td></tr> |
| <tr><td>Arguments:</td> |
| <td>None</td></tr> |
| <tr><td>Return Type:</td> |
| <td>boolean</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>User can implement this method to perform custom validation for a particular parameter. This method is called during report execution, to validate the parameter value. </p></div> |
| </body> |
| </html> |
