| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN"> |
| <html> |
| <head> |
| <title>Simple Master Page 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">SimpleMasterPage Element</p> |
| <h1>Element Overview</h1> |
| <div class="section-text"> |
| The simple master page provides a header and footer that |
| appear on every page.</div> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Simple Master Page</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>XML Element:</td> |
| <td><code>simple-master-page</code></td></tr> |
| <tr><td>Extends:</td> |
| <td><a href="MasterPage.html">MasterPage</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>Pages</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>Yes</td></tr> |
| <tr><td>Default Style:</td> |
| <td><a href="../styles.html#page">page</a></td></tr> |
| </table> |
| |
| <h3>Property Summary</h3> |
| |
| <dl class="section-text"> |
| <dt><a href="#Property-floatingFooter">floatingFooter</a></dt> |
| <dd>If true, the footer "floats" after the last content on each page.</dd> |
| <dt><a href="#Property-footerHeight">footerHeight</a></dt> |
| <dd>Height of the page footer.</dd> |
| <dt><a href="#Property-headerHeight">headerHeight</a></dt> |
| <dd>Height of the page header.</dd> |
| <dt><a href="#Property-showFooterOnLast">showFooterOnLast</a></dt> |
| <dd>Whether to show the page footer on the last page of the report.</dd> |
| <dt><a href="#Property-showHeaderOnFirst">showHeaderOnFirst</a></dt> |
| <dd>Whether to show the page header on the first page of the report.</dd> |
| </dl> |
| |
| <h3>Slot Summary</h3> |
| |
| <dl class="section-text"> |
| <dt><a href="#Slot-pageHeader">pageHeader</a></dt> |
| <dd>Element to display at the top of each page.</dd> |
| <dt><a href="#Slot-pageFooter">pageFooter</a></dt> |
| <dd>Element to display at the bottom of each page.</dd> |
| </dl> |
| |
| <h3>Inherited Properties</h3> |
| |
| <p class="section-text"> |
| <a href="MasterPage.html#Property-bottomMargin">bottomMargin</a>, |
| <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="MasterPage.html#Property-height">height</a>, |
| <a href="MasterPage.html#Property-leftMargin">leftMargin</a>, |
| <a href="ReportElement.html#Property-name">name</a>, |
| <a href="MasterPage.html#Property-orientation">orientation</a>, |
| <a href="DesignElement.html#Property-propertyMasks">propertyMasks</a>, |
| <a href="MasterPage.html#Property-rightMargin">rightMargin</a>, |
| <a href="MasterPage.html#Property-style">style</a>, |
| <a href="MasterPage.html#Property-topMargin">topMargin</a>, |
| <a href="MasterPage.html#Property-type">type</a>, |
| <a href="DesignElement.html#Property-userProperties">userProperties</a>, |
| <a href="ReportElement.html#Property-viewAction">viewAction</a>, |
| <a href="MasterPage.html#Property-width">width</a> |
| </p> |
| <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>The page margins define the position of the content area |
| on the page. The page header and footer reside within the content area. The page |
| header is at the top on each page, and the page footer is at the bottom.</p> |
| <p>The following crude picture gives an idea of the parts of |
| a simple master page:</p> |
| |
| <p><img src="images/simpleMasterPage.gif"></p> |
| |
| <h4>Page Header and Footer</h4> |
| |
| <p>The page header and footer can include any element except |
| the following:</p> |
| |
| <ul> |
| <li>Any element is bound to a data set. The header and footer do not have visibility to any data set.</li> |
| <li>A list, table, matrix or other item that is normally driven by a data set.</li> |
| </ul> |
| |
| <p>The header and footer can display data from global |
| variables, from report parameters or other sources. Such expressions are |
| evaluated once early in the report, and the same values will be used on all |
| subsequent pages. The one exception is the page number, which is shown as |
| expected on each page.</p> |
| |
| <p>BIRT FO output format maps page header to |
| <code>region-before</code>, and page footer to |
| <code>region-after.</code></p> |
| |
| <h4>Common Left/Center/Right Layout</h4> |
| |
| <p>A very common construction for a page header or footer is |
| to include a three-cell grid in which the first cell is left-aligned, the second |
| cell is centered and the third is right-aligned. For example:</p> |
| |
| <pre class="code-block">ABC Corp. Sales Summary Report   Page 1 of 4</pre> |
| |
| <p>Or,</p> |
| |
| <pre class="code-block">Sales Summary Report � 1 �   Run Date: 12/13/04</pre> |
| |
| <h4>Style</h4> |
| |
| <p>Page header and page footer are elements, and each |
| element defines its own style. So, to set the style of the page header or |
| footer, set the style on the page header or footer element itself.</p> |
| </p></div> |
| <h1>Property Detail</h1> |
| |
| <h2><a name="Property-floatingFooter">floatingFooter Property</a></h2> |
| |
| <p class="section-text">If true, the footer "floats" after the last content on each page.</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>reserved</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Floating footer</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>Hidden</td></tr> |
| <tr><td>Property Sheet Group:</td> |
| <td>Top</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>If true, the footer "floats" after the last content on |
| each page. If false, the footer is always at the bottom of the content area. |
| Default is false.</p></div> |
| |
| <hr> |
| <h2><a name="Property-footerHeight">footerHeight Property</a></h2> |
| |
| <p class="section-text">Height of the page footer.</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>Footer height</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>0.5in</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>Height of the page footer.</p></div> |
| |
| <hr> |
| <h2><a name="Property-headerHeight">headerHeight Property</a></h2> |
| |
| <p class="section-text">Height of the page header.</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>Header height</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>0.5in</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>Height of the page header.</p></div> |
| |
| <hr> |
| <h2><a name="Property-showFooterOnLast">showFooterOnLast Property</a></h2> |
| |
| <p class="section-text">Whether to show the page footer on the last page of the report.</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>Show footer on last page</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>Whether to show the page footer on the last page of the |
| report. Default is true.</p></div> |
| |
| <hr> |
| <h2><a name="Property-showHeaderOnFirst">showHeaderOnFirst Property</a></h2> |
| |
| <p class="section-text">Whether to show the page header on the first page of the report.</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>Show header on first page</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>Whether to show the page header on the first page of the |
| report. Default is true.</p></div> |
| <h1>Slot Detail</h1> |
| |
| <h2><a name="Slot-pageHeader">pageHeader Slot</a></h2> |
| |
| <p class="section-text">Element to display at the top of each page.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Page Header</td></tr> |
| <tr><td>Since:</td> |
| <td></td></tr> |
| <tr><td>XML Element:</td> |
| <td><code>page-header</code></td></tr> |
| <tr><td>Contents:</td> |
| <td><a href="AutoText.html">AutoText</a>, <a href="Data.html">Data</a>, <a href="FreeForm.html">FreeForm</a>, <a href="Grid.html">Grid</a>, <a href="Image.html">Image</a>, <a href="Label.html">Label</a>, <a href="TemplateReportItem.html">TemplateReportItem</a>, <a href="Text.html">Text</a>, <a href="TextData.html">TextData</a></td></tr> |
| <tr><td>Default Style:</td> |
| <td>None</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>Contains an element to display at the top of each page. Contains any report item that is not variable size or is bound to |
| data. The following elements are not allowed: Chart, List, Table, Matrix. The |
| following are allowed: Data, Label, Text, Grid, Image.</p></div> |
| <h3>See Also</h3> |
| |
| <div class="section-text"> |
| <p><code>showHeaderOnFirst</code> property</p> |
| <p><code>headerHeight</code> property</p></div> |
| |
| <hr> |
| <h2><a name="Slot-pageFooter">pageFooter Slot</a></h2> |
| |
| <p class="section-text">Element to display at the bottom of each page.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Page Footer</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>XML Element:</td> |
| <td><code>page-footer</code></td></tr> |
| <tr><td>Contents:</td> |
| <td><a href="AutoText.html">AutoText</a>, <a href="Data.html">Data</a>, <a href="FreeForm.html">FreeForm</a>, <a href="Grid.html">Grid</a>, <a href="Image.html">Image</a>, <a href="Label.html">Label</a>, <a href="TemplateReportItem.html">TemplateReportItem</a>, <a href="Text.html">Text</a>, <a href="TextData.html">TextData</a></td></tr> |
| <tr><td>Default Style:</td> |
| <td>None</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>Contains an element to display at the bottom of each |
| page. Contains any report item that is not variable size or is bound to |
| data. The following elements are not allowed: Chart, List, Table, Matrix. The |
| following are allowed: Data, Label, Text, Grid, Image.</p></div> |
| <h3>See Also</h3> |
| |
| <div class="section-text"> |
| <p><code>showHeaderOnLast</code> property</p> |
| <p><code>floatingFooter </code>property</p> |
| <p><code>footerHeight</code> property</p></div> |
| </body> |
| </html> |
