| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_03) on Fri Feb 22 10:35:16 CET 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>MasterPage (Simple ODF API v0.8-incubating - http://incubator.apache.org/odftoolkit/)</title> |
| <meta name="date" content="2013-02-22"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MasterPage (Simple ODF API v0.8-incubating - http://incubator.apache.org/odftoolkit/)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/MasterPage.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html" title="class in org.odftoolkit.simple.style"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/odftoolkit/simple/style/NumberFormat.html" title="enum in org.odftoolkit.simple.style"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/odftoolkit/simple/style/MasterPage.html" target="_top">Frames</a></li> |
| <li><a href="MasterPage.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.odftoolkit.simple.style</div> |
| <h2 title="Class MasterPage" class="title">Class MasterPage</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.odftoolkit.simple.style.MasterPage</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">MasterPage</span> |
| extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">This class represents the master page style settings. It provides methods to |
| access page layout styles. More functions will be added latter. |
| |
| <p> |
| This class is a corresponding high level class for element |
| "style:master-page". It provides methods to access the attributes and |
| children of "style:master-page".</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.8</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#getFootnoteMaxHeight()">getFootnoteMaxHeight</a></strong>()</code> |
| <div class="block">Get the footnote max height of the the <code>PageLayoutProperties</code> |
| referenced by this master page.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#getFootnoteSepAdjustment()">getFootnoteSepAdjustment</a></strong>()</code> |
| <div class="block">Get the way in which a footnote separator line aligned to a page, which |
| is set by the <code>PageLayoutProperties</code> referenced by this master |
| page.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#getFootnoteSepColor()">getFootnoteSepColor</a></strong>()</code> |
| <div class="block">Get the color of a footnote separator which is set by the |
| <code>PageLayoutProperties</code> referenced by this master page.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#getFootnoteSepDistanceAfterSep()">getFootnoteSepDistanceAfterSep</a></strong>()</code> |
| <div class="block">Get the distance between a footnote separator and the footnote area, |
| which is set by the <code>PageLayoutProperties</code> referenced by this |
| master page.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#getFootnoteSepDistanceBeforeSep()">getFootnoteSepDistanceBeforeSep</a></strong>()</code> |
| <div class="block">Get the distance between the text area and the footnote separator, which |
| is set by the <code>PageLayoutProperties</code> referenced by this master |
| page.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#getFootnoteSepLineStyle()">getFootnoteSepLineStyle</a></strong>()</code> |
| <div class="block">Get the line style of a footnote separator which is set by the |
| <code>PageLayoutProperties</code> referenced by this master page.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#getFootnoteSepThickness()">getFootnoteSepThickness</a></strong>()</code> |
| <div class="block">Get the thickness of a footnote separator which is set by the |
| <code>PageLayoutProperties</code> referenced by this master page.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#getFootnoteSepWidth()">getFootnoteSepWidth</a></strong>()</code> |
| <div class="block">Get the real width of a footnote separator which is set by the |
| <code>PageLayoutProperties</code> referenced by this master page.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#getMarginBottom()">getMarginBottom</a></strong>()</code> |
| <div class="block">Get the bottom margin of the <code>PageLayoutProperties</code> referenced |
| by this master page.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#getMarginLeft()">getMarginLeft</a></strong>()</code> |
| <div class="block">Get the left margin of the <code>PageLayoutProperties</code> referenced |
| by this master page.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#getMarginRight()">getMarginRight</a></strong>()</code> |
| <div class="block">Get the right margin of the <code>PageLayoutProperties</code> referenced |
| by this master page.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#getMarginTop()">getMarginTop</a></strong>()</code> |
| <div class="block">Get the top margin of the <code>PageLayoutProperties</code> referenced by |
| this master page.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#getName()">getName</a></strong>()</code> |
| <div class="block">Get the name of this master page.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#getNumberFormat()">getNumberFormat</a></strong>()</code> |
| <div class="block">Get the number format of the the <code>PageLayoutProperties</code> |
| referenced by this master page.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/odftoolkit/simple/style/MasterPage.html" title="class in org.odftoolkit.simple.style">MasterPage</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#getOrCreateMasterPage(org.odftoolkit.simple.Document, java.lang.String)">getOrCreateMasterPage</a></strong>(<a href="../../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</a> doc, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Return a master page according to its name and its document.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#getPageHeight()">getPageHeight</a></strong>()</code> |
| <div class="block">Get the page height of the the <code>PageLayoutProperties</code> |
| referenced by this master page.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#getPageWidth()">getPageWidth</a></strong>()</code> |
| <div class="block">Get the page width of the the <code>PageLayoutProperties</code> |
| referenced by this master page.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#getPrintOrientation()">getPrintOrientation</a></strong>()</code> |
| <div class="block">Get the print orientation of the the <code>PageLayoutProperties</code> |
| referenced by this master page.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#getWritingMode()">getWritingMode</a></strong>()</code> |
| <div class="block">Get the writing mode of the the <code>PageLayoutProperties</code> |
| referenced by this master page.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#setFootnoteMaxHeight(double)">setFootnoteMaxHeight</a></strong>(double height)</code> |
| <div class="block">Set the footnote max height of the <code>PageLayoutProperties</code> |
| referenced by this master page.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#setFootnoteSepProperties(org.odftoolkit.simple.style.StyleTypeDefinitions.AdjustmentStyle, org.odftoolkit.odfdom.type.Color, double, double, org.odftoolkit.simple.style.StyleTypeDefinitions.LineStyle, org.odftoolkit.odfdom.type.Percent, double)">setFootnoteSepProperties</a></strong>(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.AdjustmentStyle.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.AdjustmentStyle</a> adjustment, |
| org.odftoolkit.odfdom.type.Color color, |
| double distanceAfterSep, |
| double distanceBeforeSep, |
| <a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.LineStyle.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.LineStyle</a> lineStyle, |
| org.odftoolkit.odfdom.type.Percent width, |
| double thickness)</code> |
| <div class="block">Set the foot note separator properties of the |
| <code>PageLayoutProperties</code> referenced by this master page.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#setMargins(double, double, double, double)">setMargins</a></strong>(double marginTop, |
| double marginBottom, |
| double marginLeft, |
| double marginRight)</code> |
| <div class="block">Set the margins of the <code>PageLayoutProperties</code> referenced by |
| this master page.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#setNumberFormat(java.lang.String)">setNumberFormat</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> format)</code> |
| <div class="block">Set the number format of the <code>PageLayoutProperties</code> referenced |
| by this master page.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#setPageHeight(double)">setPageHeight</a></strong>(double pageHeight)</code> |
| <div class="block">Set the page height of the <code>PageLayoutProperties</code> referenced |
| by this master page.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#setPageWidth(double)">setPageWidth</a></strong>(double pageWidth)</code> |
| <div class="block">Set the page width of the <code>PageLayoutProperties</code> referenced by |
| this master page.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#setPrintOrientation(org.odftoolkit.simple.style.StyleTypeDefinitions.PrintOrientation)">setPrintOrientation</a></strong>(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.PrintOrientation.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.PrintOrientation</a> orientation)</code> |
| <div class="block">Set the print orientation of the <code>PageLayoutProperties</code> |
| referenced by this master page.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/MasterPage.html#setWritingMode(org.odftoolkit.simple.style.StyleTypeDefinitions.WritingMode)">setWritingMode</a></strong>(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.WritingMode.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.WritingMode</a> mode)</code> |
| <div class="block">Set the writing mode of the <code>PageLayoutProperties</code> referenced |
| by this master page.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getOrCreateMasterPage(org.odftoolkit.simple.Document, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrCreateMasterPage</h4> |
| <pre>public static <a href="../../../../org/odftoolkit/simple/style/MasterPage.html" title="class in org.odftoolkit.simple.style">MasterPage</a> getOrCreateMasterPage(<a href="../../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</a> doc, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Return a master page according to its name and its document. |
| <p> |
| If there is no existing master page defined by this name in the document, |
| a new master with this name will be created and returned.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>doc</code> - - the document to which the master page belongs.</dd><dd><code>name</code> - - the name of the master page</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a master page</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the style DOM cannot be initialized</dd></dl> |
| </li> |
| </ul> |
| <a name="getName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getName()</pre> |
| <div class="block">Get the name of this master page. |
| <p> |
| This represents the attribute <code>style:name</code> of |
| <code>style:master-page</code>.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the style name of this master page.</dd></dl> |
| </li> |
| </ul> |
| <a name="getMarginTop()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMarginTop</h4> |
| <pre>public double getMarginTop()</pre> |
| <div class="block">Get the top margin of the <code>PageLayoutProperties</code> referenced by |
| this master page.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the top margin (in Millimeter)</dd></dl> |
| </li> |
| </ul> |
| <a name="getMarginRight()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMarginRight</h4> |
| <pre>public double getMarginRight()</pre> |
| <div class="block">Get the right margin of the <code>PageLayoutProperties</code> referenced |
| by this master page.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the right margin (in Millimeter)</dd></dl> |
| </li> |
| </ul> |
| <a name="getMarginLeft()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMarginLeft</h4> |
| <pre>public double getMarginLeft()</pre> |
| <div class="block">Get the left margin of the <code>PageLayoutProperties</code> referenced |
| by this master page.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the left margin (in Millimeter)</dd></dl> |
| </li> |
| </ul> |
| <a name="getMarginBottom()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMarginBottom</h4> |
| <pre>public double getMarginBottom()</pre> |
| <div class="block">Get the bottom margin of the <code>PageLayoutProperties</code> referenced |
| by this master page.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the bottom margin (in Millimeter)</dd></dl> |
| </li> |
| </ul> |
| <a name="setMargins(double, double, double, double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMargins</h4> |
| <pre>public void setMargins(double marginTop, |
| double marginBottom, |
| double marginLeft, |
| double marginRight) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Set the margins of the <code>PageLayoutProperties</code> referenced by |
| this master page. |
| <p> |
| If the margin size is set to zero, the corresponding margin definition |
| will be removed.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>marginTop</code> - the size of the top margin (in Millimeter)</dd><dd><code>marginBottom</code> - the size of the bottom margin (in Millimeter)</dd><dd><code>marginLeft</code> - the size of the left margin (in Millimeter)</dd><dd><code>marginRight</code> - the size of the right margin (in Millimeter)</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the corresponding <code>StylePageLayoutElement</code> |
| cannot be accessed for write.</dd></dl> |
| </li> |
| </ul> |
| <a name="getPageWidth()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPageWidth</h4> |
| <pre>public double getPageWidth()</pre> |
| <div class="block">Get the page width of the the <code>PageLayoutProperties</code> |
| referenced by this master page.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the size of page width (in Millimeter)</dd></dl> |
| </li> |
| </ul> |
| <a name="setPageWidth(double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPageWidth</h4> |
| <pre>public void setPageWidth(double pageWidth) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Set the page width of the <code>PageLayoutProperties</code> referenced by |
| this master page. |
| <p> |
| If the size is set to zero, the page width definition will be removed.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>pageWidth</code> - the size of the page width (in Millimeter)</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the corresponding <code>StylePageLayoutElement</code> |
| cannot be accessed for write.</dd></dl> |
| </li> |
| </ul> |
| <a name="getPageHeight()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPageHeight</h4> |
| <pre>public double getPageHeight()</pre> |
| <div class="block">Get the page height of the the <code>PageLayoutProperties</code> |
| referenced by this master page.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the size of page height (in Millimeter)</dd></dl> |
| </li> |
| </ul> |
| <a name="setPageHeight(double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPageHeight</h4> |
| <pre>public void setPageHeight(double pageHeight) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Set the page height of the <code>PageLayoutProperties</code> referenced |
| by this master page. |
| <p> |
| If the size is set to zero, the page height definition will be removed.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>pageHeight</code> - the size of the page height (in Millimeter)</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the corresponding <code>StylePageLayoutElement</code> |
| cannot be accessed for write.</dd></dl> |
| </li> |
| </ul> |
| <a name="getNumberFormat()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumberFormat</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getNumberFormat()</pre> |
| <div class="block">Get the number format of the the <code>PageLayoutProperties</code> |
| referenced by this master page.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the value of number format</dd></dl> |
| </li> |
| </ul> |
| <a name="setNumberFormat(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNumberFormat</h4> |
| <pre>public void setNumberFormat(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> format) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Set the number format of the <code>PageLayoutProperties</code> referenced |
| by this master page.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>format</code> - specify the number format. The values of the style:num-format |
| attribute are 1, i, I, string, an empty string, a or A.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the corresponding <code>StylePageLayoutElement</code> |
| cannot be accessed for write.</dd></dl> |
| </li> |
| </ul> |
| <a name="getPrintOrientation()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrintOrientation</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getPrintOrientation()</pre> |
| <div class="block">Get the print orientation of the the <code>PageLayoutProperties</code> |
| referenced by this master page.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the value of print orientation</dd></dl> |
| </li> |
| </ul> |
| <a name="setPrintOrientation(org.odftoolkit.simple.style.StyleTypeDefinitions.PrintOrientation)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPrintOrientation</h4> |
| <pre>public void setPrintOrientation(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.PrintOrientation.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.PrintOrientation</a> orientation) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Set the print orientation of the <code>PageLayoutProperties</code> |
| referenced by this master page. |
| <p> |
| If the parameter <code>orientation</code> is null, the print orientation |
| definition will be removed.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>orientation</code> - - the print orientation</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the corresponding <code>StylePageLayoutElement</code> |
| cannot be accessed for write.</dd></dl> |
| </li> |
| </ul> |
| <a name="getWritingMode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWritingMode</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getWritingMode()</pre> |
| <div class="block">Get the writing mode of the the <code>PageLayoutProperties</code> |
| referenced by this master page.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the value of writing mode</dd></dl> |
| </li> |
| </ul> |
| <a name="setWritingMode(org.odftoolkit.simple.style.StyleTypeDefinitions.WritingMode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setWritingMode</h4> |
| <pre>public void setWritingMode(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.WritingMode.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.WritingMode</a> mode) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Set the writing mode of the <code>PageLayoutProperties</code> referenced |
| by this master page.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>mode</code> - - writing mode</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the corresponding <code>StylePageLayoutElement</code> |
| cannot be accessed for write.</dd></dl> |
| </li> |
| </ul> |
| <a name="getFootnoteMaxHeight()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFootnoteMaxHeight</h4> |
| <pre>public double getFootnoteMaxHeight()</pre> |
| <div class="block">Get the footnote max height of the the <code>PageLayoutProperties</code> |
| referenced by this master page.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the value of footnote max height</dd></dl> |
| </li> |
| </ul> |
| <a name="setFootnoteMaxHeight(double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFootnoteMaxHeight</h4> |
| <pre>public void setFootnoteMaxHeight(double height) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Set the footnote max height of the <code>PageLayoutProperties</code> |
| referenced by this master page.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>height</code> - - the max height of a footnote area</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the corresponding <code>StylePageLayoutElement</code> |
| cannot be accessed for write.</dd></dl> |
| </li> |
| </ul> |
| <a name="getFootnoteSepAdjustment()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFootnoteSepAdjustment</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getFootnoteSepAdjustment()</pre> |
| <div class="block">Get the way in which a footnote separator line aligned to a page, which |
| is set by the <code>PageLayoutProperties</code> referenced by this master |
| page.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the adjustment of a footnote separator line</dd></dl> |
| </li> |
| </ul> |
| <a name="getFootnoteSepColor()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFootnoteSepColor</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getFootnoteSepColor()</pre> |
| <div class="block">Get the color of a footnote separator which is set by the |
| <code>PageLayoutProperties</code> referenced by this master page.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the color of a footnote separator line</dd></dl> |
| </li> |
| </ul> |
| <a name="getFootnoteSepDistanceAfterSep()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFootnoteSepDistanceAfterSep</h4> |
| <pre>public double getFootnoteSepDistanceAfterSep()</pre> |
| <div class="block">Get the distance between a footnote separator and the footnote area, |
| which is set by the <code>PageLayoutProperties</code> referenced by this |
| master page.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the distance after a footnote separator line</dd></dl> |
| </li> |
| </ul> |
| <a name="getFootnoteSepDistanceBeforeSep()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFootnoteSepDistanceBeforeSep</h4> |
| <pre>public double getFootnoteSepDistanceBeforeSep()</pre> |
| <div class="block">Get the distance between the text area and the footnote separator, which |
| is set by the <code>PageLayoutProperties</code> referenced by this master |
| page.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the distance before a footnote separator line</dd></dl> |
| </li> |
| </ul> |
| <a name="getFootnoteSepLineStyle()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFootnoteSepLineStyle</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getFootnoteSepLineStyle()</pre> |
| <div class="block">Get the line style of a footnote separator which is set by the |
| <code>PageLayoutProperties</code> referenced by this master page.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the line style of a footnote separator line</dd></dl> |
| </li> |
| </ul> |
| <a name="getFootnoteSepWidth()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFootnoteSepWidth</h4> |
| <pre>public double getFootnoteSepWidth()</pre> |
| <div class="block">Get the real width of a footnote separator which is set by the |
| <code>PageLayoutProperties</code> referenced by this master page.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the real width of a footnote separator line</dd></dl> |
| </li> |
| </ul> |
| <a name="getFootnoteSepThickness()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFootnoteSepThickness</h4> |
| <pre>public double getFootnoteSepThickness()</pre> |
| <div class="block">Get the thickness of a footnote separator which is set by the |
| <code>PageLayoutProperties</code> referenced by this master page.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the thickness of a footnote separator line</dd></dl> |
| </li> |
| </ul> |
| <a name="setFootnoteSepProperties(org.odftoolkit.simple.style.StyleTypeDefinitions.AdjustmentStyle, org.odftoolkit.odfdom.type.Color, double, double, org.odftoolkit.simple.style.StyleTypeDefinitions.LineStyle, org.odftoolkit.odfdom.type.Percent, double)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setFootnoteSepProperties</h4> |
| <pre>public void setFootnoteSepProperties(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.AdjustmentStyle.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.AdjustmentStyle</a> adjustment, |
| org.odftoolkit.odfdom.type.Color color, |
| double distanceAfterSep, |
| double distanceBeforeSep, |
| <a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.LineStyle.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.LineStyle</a> lineStyle, |
| org.odftoolkit.odfdom.type.Percent width, |
| double thickness) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Set the foot note separator properties of the |
| <code>PageLayoutProperties</code> referenced by this master page.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the corresponding <code>StylePageLayoutElement</code> |
| cannot be accessed for write.</dd><dt><span class="strong">See Also:</span></dt><dd><code>PageLayoutProperties#setFootnoteSepProperties(AdjustmentStyle, |
| Color, double, double, LineStyle, Percent, double)</code></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/MasterPage.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/odftoolkit/simple/style/GraphicProperties.html" title="class in org.odftoolkit.simple.style"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/odftoolkit/simple/style/NumberFormat.html" title="enum in org.odftoolkit.simple.style"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/odftoolkit/simple/style/MasterPage.html" target="_top">Frames</a></li> |
| <li><a href="MasterPage.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2010-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |