| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN"> |
| <html> |
| <head> |
| <title>Graphic 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">GraphicMasterPage Element</p> |
| <h1>Element Overview</h1> |
| <div class="section-text"> |
| A master page with free-form page decorations.</div> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Graphic Master Page</td></tr> |
| <tr><td>Since:</td> |
| <td>reserved</td></tr> |
| <tr><td>XML Element:</td> |
| <td><code>graphic-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-columnSpacing">columnSpacing</a></dt> |
| <dd>The amount of space between columns.</dd> |
| <dt><a href="#Property-columns">columns</a></dt> |
| <dd>The number of columns on the page</dd> |
| </dl> |
| |
| <h3>Slot Summary</h3> |
| |
| <dl class="section-text"> |
| <dt><a href="#Slot-contents">contents</a></dt> |
| <dd></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>A graphic master page describes a physical page free-form page "decoration". The decoration |
| can include simple headers and footers, but can also include content within the left and right |
| margins, as well as watermarks under the content area. The page can contain multiple columns. |
| In a multi-column report, the content area is the area inside the margins defined by each column. |
| Note that each page has only one content area, though that content area can be divided into multiple |
| columns. That is, a page has one content area. If a page has multiple columns, the column layout is |
| "overlaid" on top of the content area. |
| <p> |
| <h4>Graphic Pages in HTML and FO Output.</h4> |
| |
| Graphic pages contain free-form content. However, simple HTML output, and |
| FO output do not support arbitrary free-form items on a page. If a graphic master |
| page is used for such formats, BIRT will automatically convert the graphic page |
| to a simple page at run time, following these rules: </h4> |
| <ul> |
| <li>A header area is defined above the content area of the page.Any elements entirely within this |
| header appear in the printed page header. |
| </li> |
| <li>A footer area is defined below the content area of the page. Any elements entirely within this |
| footer appear in the printed page footer. |
| </li> |
| <li>Any element that appears outside the header or footer areas is ignored for the simple HTML and FO formats.</li> |
| </ul></div> |
| <h1>Property Detail</h1> |
| |
| <h2><a name="Property-columnSpacing">columnSpacing Property</a></h2> |
| |
| <p class="section-text">The amount of space between columns.</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>Column space</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>0.5pt</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>The amount of space between columns.</p></div> |
| |
| <hr> |
| <h2><a name="Property-columns">columns Property</a></h2> |
| |
| <p class="section-text">The number of columns on the page</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#integer">integer</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>Columns</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>1</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>The number of columns on the page. A multi-column page prints like a phone book or a dictionary: the left |
| column is filled from top to bottom, then the next column, and so on until all columns are full.</p></div> |
| <h1>Slot Detail</h1> |
| |
| <h2><a name="Slot-contents">contents Slot</a></h2> |
| |
| <p class="section-text"></p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Content</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>XML Element:</td> |
| <td><code>contents</code></td></tr> |
| <tr><td>Contents:</td> |
| <td>List of <a href="Data.html">Data</a>, <a href="ExtendedItem.html">ExtendedItem</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="Line.html">Line</a>, <a href="Rectangle.html">Rectangle</a>, <a href="Text.html">Text</a></td></tr> |
| <tr><td>Default Style:</td> |
| <td>None</td></tr> |
| </table> |
| |
| </body> |
| </html> |
