| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN"> |
| <html> |
| <head> |
| <title>Action 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">Action Structure</p> |
| <h1>Structure Overview</h1> |
| <div class="section-text"> |
| Defines a hyperlink.</div> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Action</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| </table> |
| |
| <h3>Property Summary</h3> |
| |
| <dl class="section-text"> |
| <dt><a href="#Property-formatType">formatType</a></dt> |
| <dd>Format of the target link.</dd> |
| <dt><a href="#Property-linkType">linkType</a></dt> |
| <dd>The kind of link: hyperlink, bookmark link or drill-though.</dd> |
| <dt><a href="#Property-paramBindings">paramBindings</a></dt> |
| <dd>Optional list of parameter bindings for the target. |
| Used when the hyperlink is used to run a report.</dd> |
| <dt><a href="#Property-reportName">reportName</a></dt> |
| <dd>Name of the target report for a drill-through link.</dd> |
| <dt><a href="#Property-search">search</a></dt> |
| <dd>An optional set of search criteria for the target report for a drill-though link.</dd> |
| <dt><a href="#Property-targetBookmark">targetBookmark</a></dt> |
| <dd>Target bookmark defined within this same report, or another report for a drill-though link.</dd> |
| <dt><a href="#Property-targetBookmarkType">targetBookmarkType</a></dt> |
| <dd></dd> |
| <dt><a href="#Property-targetFileType">targetFileType</a></dt> |
| <dd></dd> |
| <dt><a href="#Property-targetWindow">targetWindow</a></dt> |
| <dd>The name of the target browser window for the link.</dd> |
| <dt><a href="#Property-uri">uri</a></dt> |
| <dd>Expression that provides the web URL.</dd> |
| </dl> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>The Action structure defines a hyperlink. There are five |
| major kinds of actions:</p> |
| |
| <ul> |
| <li>Hyperlink: To an external web site, e-mail system, etc.</li> |
| <li>Bookmark Link: To a location within this report as specified by a bookmark.</li> |
| <li>Drill-though: To a location within another report as specified by a bookmark.</li> |
| </ul> |
| |
| <p>The drill-though link can link to an existing report, or |
| request to run a new report. It can optionally include:</p> |
| |
| <ul> |
| <li>Parameters to pass when creating a new report.</li> |
| <li>A location within the target report as specified by a search.</li> |
| <li>A location within the target report as specified by a bookmark.</li> |
| </ul> |
| |
| <p>The Hyperlink property returns a standard web-style link |
| with "http:" or "mailto:" prefix. Expression hyperlinks can include special BIRT |
| features (search and so on), but only as encoded into a URL. If the link wants |
| to jump to a specific target within the document, encode that target within the |
| URL as defined by target document type. (For example: http://foo.com/docs/myDoc.html#myTarget.)</p> |
| |
| <p>If the user provides a relative URL, it is assumed to be |
| relative to the same web server that is being used to view the report. The exact |
| semantics are implementation-specific in the open source release. In the |
| commercial release, the URL is relative to the web server that hosts |
| ActivePortal.</p> |
| |
| <p>A bookmark link simply identifies a bookmark identified |
| within this report. Use the Bookmark property of a report item to create the |
| target bookmark.</p> |
| |
| <h4>Property Usage</h4> |
| |
| <table class="section-table"> |
| <thead> |
| <tr> |
| <th rowspan="2">Property</td> |
| <th colspan="3">Link Type</td> |
| </tr> |
| </thead> |
| <tr> |
| <td></td> |
| <td>Hyperlink</td> |
| <td>Bookmark Link</td> |
| <td>Drill-through</td> |
| </tr> |
| <tr> |
| <td> |
| <code>targetWindow</code></td> |
| <td>X</td> |
| <td> </td> |
| <td>X</td> |
| </tr> |
| <tr> |
| <td><code>hyperlink</code></td> |
| <td>X</td> |
| <td> </td> |
| <td> </td> |
| </tr> |
| <tr> |
| <td><code>bookmarkLink</code></td> |
| <td> </td> |
| <td>X</td> |
| <td> </td> |
| </tr> |
| <tr> |
| <td> |
| <code>drillThroughBookmarkLink</code></td> |
| <td> </td> |
| <td> </td> |
| <td>X</td> |
| </tr> |
| <tr> |
| <td><code>reportName</code></td> |
| <td> </td> |
| <td> </td> |
| <td>X</td> |
| </tr> |
| <tr> |
| <td><code>drillThroughParamBindings</code></td> |
| <td> </td> |
| <td> </td> |
| <td>X</td> |
| </tr> |
| <tr> |
| <td><code>drillThroughSearch</code></td> |
| <td></td> |
| <td></td> |
| <td>X</td> |
| </tr> |
| </table></div> |
| <h1>Property Detail</h1> |
| |
| <h2><a name="Property-formatType">formatType Property</a></h2> |
| |
| <p class="section-text">Format of the target link.</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>Format Type</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>Yes</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>html</td> |
| <td>html</td> |
| <td>html</td> |
| <td></td></tr> |
| <tr><td>pdf</td> |
| <td>pdf</td> |
| <td>pdf</td> |
| <td></td></tr> |
| </tbody></table><br> |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>Format of the target link, can be pdf or html link.</p></div> |
| |
| <hr> |
| <h2><a name="Property-linkType">linkType Property</a></h2> |
| |
| <p class="section-text">The kind of link: hyperlink, bookmark link or drill-though.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#choice">choice</a> (actionLinkType)</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>Link type</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>hyperlink</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>Yes</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>none</td> |
| <td>No action link type</td> |
| <td>none</td> |
| <td>No link is defined.</td></tr> |
| <tr><td>hyperlink</td> |
| <td>HyperLink</td> |
| <td>hyperlink</td> |
| <td>A link to a web page, |
| "mailto:", or other web resource.</td></tr> |
| <tr><td>drill-through</td> |
| <td>Drill Through</td> |
| <td>drill-through</td> |
| <td>A link to another |
| report.</td></tr> |
| <tr><td>bookmark-link</td> |
| <td>Bookmark Link</td> |
| <td>bookmark-link</td> |
| <td></td></tr> |
| </tbody></table><br> |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>This property identifies the kind of link. The link type |
| determines which link properties to use as shown above. The default is a |
| hyperlink.</p> |
| |
| <p>A drill-through is a link to another report. The report |
| name is given as a relative or absolute name. If the name is relative, then the |
| target document is on the same web (application) server as the current report. |
| For example:</p> |
| |
| <ul> |
| <li>report1: in the same virtual directory as this report.</li> |
| <li>../report2: Up one virtual directory from this report.</li> |
| <li>../summary/report3: In a sibling directory to this report.</li> |
| <li>/reports/summary/report4: In an absolute location on this web server.</li> |
| </ul> |
| |
| <p>The destination can be any type of report as supported by |
| the web server interface that receives the link commands. If the destination is |
| a BIRT design, the report will be run.</p></div> |
| |
| <hr> |
| <h2><a name="Property-paramBindings">paramBindings Property</a></h2> |
| |
| <p class="section-text">Optional list of parameter bindings for the target. |
| Used when the hyperlink is used to run a report.</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>reserved</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>Runtime Settable:</td> |
| <td>Yes</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>Optional list of parameter bindings for the target. Used |
| when the hyperlink is used to run a report. The bindings evaluate an expression |
| within the current report, and bind that value to a report parameter in the |
| target report. For example, if the current report is a list of customers, the |
| report can include a hyperlink that runs a report that shows any open orders for |
| that customer. In this case, the parameter bindings pass the customer ID to the |
| target report.</p></div> |
| |
| <hr> |
| <h2><a name="Property-reportName">reportName Property</a></h2> |
| |
| <p class="section-text">Name of the target report for a drill-through link.</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>reserved</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Report Name</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>Yes</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>The name of a document on the same server as this report. |
| Can include relative or absolute names. If the suffix is omitted, it is assumed |
| to be 1) a BIRT document or 2) a BIRT design. If the report name is blank, then |
| the no hyperlink is defined even if the link type is set to Drill-though.</p></div> |
| |
| <hr> |
| <h2><a name="Property-search">search Property</a></h2> |
| |
| <p class="section-text">An optional set of search criteria for the target report for a drill-though link.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td>List of <a href="../structs/SearchKey.html">SearchKey</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>Search Keys</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>Yes</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>Optional list of search criteria. The report is run (if |
| needed) or an existing report is opened. Then, BIRT performs a search on the |
| target report based on the search criteria entered here.</p> |
| |
| <p>For example, if the current report is a list of |
| customers, the report can include a hyperlink that links to a report that shows |
| open orders for all customer, then search for the customer�s orders. In this |
| case, the search criteria look for the customer�s ID within the target report.</p></div> |
| |
| <hr> |
| <h2><a name="Property-targetBookmark">targetBookmark Property</a></h2> |
| |
| <p class="section-text">Target bookmark defined within this same report, or another report for a drill-though link.</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>reserved</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Bookmark link</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>Yes</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>The target bookmark within this report.</p> |
| |
| <p>If the link type is bookmark link then the value here |
| must match a bookmark defined within the report. If the bookmark target is not |
| defined, then the link will do nothing.</p> |
| |
| <p>If link type is drill-though link then the value here |
| must match a bookmark defined within the target report. If the bookmark target |
| is not defined, then the drill-though link will display the first page of the |
| report.</p></div> |
| <h3>See Also</h3> |
| |
| <div class="section-text"> |
| <p>Report Item <code>bookmark</code> Property</p></div> |
| |
| <hr> |
| <h2><a name="Property-targetBookmarkType">targetBookmarkType 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> (actionBookmarkType)</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>Target Bookmark Type</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>Yes</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>bookmark</td> |
| <td>Bookmark</td> |
| <td>bookmark</td> |
| <td></td></tr> |
| <tr><td>toc</td> |
| <td>Table of Content</td> |
| <td>toc</td> |
| <td></td></tr> |
| </tbody></table><br> |
| |
| <hr> |
| <h2><a name="Property-targetFileType">targetFileType 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> (actionTargetFileType)</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>Target File Type</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>Yes</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>report-design</td> |
| <td>Report Design</td> |
| <td>report-design</td> |
| <td></td></tr> |
| <tr><td>report-document</td> |
| <td>Report Document</td> |
| <td>report-document</td> |
| <td></td></tr> |
| </tbody></table><br> |
| |
| <hr> |
| <h2><a name="Property-targetWindow">targetWindow Property</a></h2> |
| |
| <p class="section-text">The name of the target browser window for the link.</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>Target</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>_blank</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>Yes</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>_blank</td> |
| <td>Blank</td> |
| <td>_blank</td> |
| <td></td></tr> |
| <tr><td>_self</td> |
| <td>Self</td> |
| <td>_self</td> |
| <td></td></tr> |
| <tr><td>_parent</td> |
| <td>Parent</td> |
| <td>_parent</td> |
| <td></td></tr> |
| <tr><td>_top</td> |
| <td>Top</td> |
| <td>_top</td> |
| <td></td></tr> |
| </tbody></table><br> |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>The name of the target browser window for the link. Used |
| only for the Hyperlink and Drill-Through options, ignored for the Bookmark Link |
| option. This property is optional.</p></div> |
| |
| <hr> |
| <h2><a name="Property-uri">uri Property</a></h2> |
| |
| <p class="section-text">Expression that provides the web URL.</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>1.0</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Location</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>Yes</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>The expression that provides the actual link. This is a |
| Web-style hyperlink and includes http:, mailto: and other URLs. Both relative |
| and absolute URLs are allowed. The meaning of relative URL depends on the |
| deployment environment.</p> |
| |
| <p>If the property is not set, then no link is defined, even |
| if the link type is set to "Hyperlink."</p></div> |
| </body> |
| </html> |
