Google Git
Sign in
apache / incubator-odftoolkit-site / d22ef2d53769a0a209d42b84c8275ad1d8522260 / . / content / odftoolkit / mvn-site / 0.8-incubating / simple-odf / apidocs / org / odftoolkit / simple / style / PageLayoutProperties.html
blob: c2240299338e0e7e37326468997777ac2c3ebd3d [file] [log] [blame]
<!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>PageLayoutProperties (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="PageLayoutProperties (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/PageLayoutProperties.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/NumberFormat.html" title="enum in org.odftoolkit.simple.style"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/style/ParagraphProperties.html" title="class 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/PageLayoutProperties.html" target="_top">Frames</a></li>
<li><a href="PageLayoutProperties.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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 PageLayoutProperties" class="title">Class PageLayoutProperties</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.PageLayoutProperties</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">PageLayoutProperties</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 page layout style settings. It provides methods to
access borders, margins,number format, page width, page height and etc. More
functions will be added latter.
<p>
This class is a corresponded high level class for element
"style:page-layout-properties". It provides methods to access the attributes
and children of "style:page-layout-properties".</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">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#PageLayoutProperties()">PageLayoutProperties</a></strong>()</code>
<div class="block">Create an instance of PageLayoutProperties</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#PageLayoutProperties(org.odftoolkit.odfdom.dom.element.style.StylePageLayoutPropertiesElement)">PageLayoutProperties</a></strong>(org.odftoolkit.odfdom.dom.element.style.StylePageLayoutPropertiesElement&nbsp;pageLayoutProperties)</code>
<div class="block">Create an instance of PageLayoutProperties from an element
<style:page-layout-properties></div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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">&nbsp;</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><a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#getBorder()">getBorder</a></strong>()</code>
<div class="block">Return the border setting for all four borders.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#getBottomBorder()">getBottomBorder</a></strong>()</code>
<div class="block">Return the border setting for the bottom border.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#getFootnoteMaxHeight()">getFootnoteMaxHeight</a></strong>()</code>
<div class="block">Get the max height of a footnote area on a 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/PageLayoutProperties.html#getFootnoteSepAdjustment()">getFootnoteSepAdjustment</a></strong>()</code>
<div class="block">Get the way in which a footnote separator line is aligned on a 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/PageLayoutProperties.html#getFootnoteSepColor()">getFootnoteSepColor</a></strong>()</code>
<div class="block">Get the color of footnote separator line.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#getFootnoteSepDistanceAfterSep()">getFootnoteSepDistanceAfterSep</a></strong>()</code>
<div class="block">Get the distance between a footnote separator line and the footnote text.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#getFootnoteSepDistanceBeforeSep()">getFootnoteSepDistanceBeforeSep</a></strong>()</code>
<div class="block">Get the distance between the text area and a footnote separator line.</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/PageLayoutProperties.html#getFootnoteSepLineStyle()">getFootnoteSepLineStyle</a></strong>()</code>
<div class="block">Get the line style of a footnote separator line.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#getFootnoteSepThickness()">getFootnoteSepThickness</a></strong>()</code>
<div class="block">Get the thickness of a footnote separator line.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#getFootnoteSepWidth()">getFootnoteSepWidth</a></strong>()</code>
<div class="block">Get the width of a footnote separator line.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#getLeftBorder()">getLeftBorder</a></strong>()</code>
<div class="block">Return the border setting for the left border.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#getMarginBottom()">getMarginBottom</a></strong>()</code>
<div class="block">Get the size of the bottom margin of this
<code>PageLayoutProperties</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#getMarginLeft()">getMarginLeft</a></strong>()</code>
<div class="block">Get the size of the left margin of this <code>PageLayoutProperties</code>
If the size is set to zero, the left margin definition will be removed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#getMarginRight()">getMarginRight</a></strong>()</code>
<div class="block">Get the size of the right margin of this
<code>PageLayoutProperties</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#getMarginTop()">getMarginTop</a></strong>()</code>
<div class="block">Get the size of the top margin of this <code>PageLayoutProperties</code></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/PageLayoutProperties.html#getNumberFormat()">getNumberFormat</a></strong>()</code>
<div class="block">Get the number format of this <code>PageLayoutProperties</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html" title="class in org.odftoolkit.simple.style">PageLayoutProperties</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#getOrCreatePageLayoutProperties(org.odftoolkit.odfdom.dom.element.OdfStyleBase)">getOrCreatePageLayoutProperties</a></strong>(org.odftoolkit.odfdom.dom.element.OdfStyleBase&nbsp;style)</code>
<div class="block">Return an instance of
<code>PageLayoutProperties to represent the "style:page-layout-properties" in a style element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#getPageHeight()">getPageHeight</a></strong>()</code>
<div class="block">Get the page height of this <code>PageLayoutProperties</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html" title="class in org.odftoolkit.simple.style">PageLayoutProperties</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#getPageLayoutProperties(org.odftoolkit.odfdom.dom.element.OdfStyleBase)">getPageLayoutProperties</a></strong>(org.odftoolkit.odfdom.dom.element.OdfStyleBase&nbsp;style)</code>
<div class="block">Return an instance of
<code>PageLayoutProperties to represent the "style:page-layout-properties" in a style element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#getPageWidth()">getPageWidth</a></strong>()</code>
<div class="block">Get the page width of this <code>PageLayoutProperties</code></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/PageLayoutProperties.html#getPrintOrientation()">getPrintOrientation</a></strong>()</code>
<div class="block">Get the print orientation of this <code>PageLayoutProperties</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#getRightBorder()">getRightBorder</a></strong>()</code>
<div class="block">Return the border setting for the right border.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#getTopBorder()">getTopBorder</a></strong>()</code>
<div class="block">Return the border setting for the top border.</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/PageLayoutProperties.html#getWritingMode()">getWritingMode</a></strong>()</code>
<div class="block">Get the writing mode of this <code>PageLayoutProperties</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#setBorder(org.odftoolkit.simple.style.Border)">setBorder</a></strong>(<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a>&nbsp;border)</code>
<div class="block">Set the border definition for all four borders.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#setBorders(org.odftoolkit.simple.style.StyleTypeDefinitions.CellBordersType, org.odftoolkit.simple.style.Border)">setBorders</a></strong>(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.CellBordersType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.CellBordersType</a>&nbsp;bordersType,
<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a>&nbsp;border)</code>
<div class="block">Set the border style.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#setBottomBorder(org.odftoolkit.simple.style.Border)">setBottomBorder</a></strong>(<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a>&nbsp;border)</code>
<div class="block">Set the border definition for the bottom border.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#setFootnoteMaxHeight(double)">setFootnoteMaxHeight</a></strong>(double&nbsp;height)</code>
<div class="block">Set the max height of a footnote area on a 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/PageLayoutProperties.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>&nbsp;adjustment,
org.odftoolkit.odfdom.type.Color&nbsp;color,
double&nbsp;distanceAfterSep,
double&nbsp;distanceBeforeSep,
<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.LineStyle.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.LineStyle</a>&nbsp;lineStyle,
org.odftoolkit.odfdom.type.Percent&nbsp;width,
double&nbsp;thickness)</code>
<div class="block">Set the formatting of footnote separator of this
<code>PageLayoutProperties</code>
If the parameter <code>adjustment</code> is null, the adjustment
definition will be set as left.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#setLeftBorder(org.odftoolkit.simple.style.Border)">setLeftBorder</a></strong>(<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a>&nbsp;border)</code>
<div class="block">Set the border definition for the left border.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#setMarginBottom(double)">setMarginBottom</a></strong>(double&nbsp;marginBottom)</code>
<div class="block">Set the bottom margin of this <code>PageLayoutProperties</code>
If the size is set to zero, the bottom margin definition will be removed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#setMarginLeft(double)">setMarginLeft</a></strong>(double&nbsp;marginLeft)</code>
<div class="block">Set the left margin of this <code>PageLayoutProperties</code>
If the size is set to zero, the left margin definition will be removed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#setMarginRight(double)">setMarginRight</a></strong>(double&nbsp;marginRight)</code>
<div class="block">Set the right margin of this <code>PageLayoutProperties</code>
If the size is set to zero, the right margin definition will be removed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#setMarginTop(double)">setMarginTop</a></strong>(double&nbsp;marginTop)</code>
<div class="block">Set the top margin of this <code>PageLayoutProperties</code>
If the size is set to zero, the top margin definition will be removed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.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>&nbsp;format)</code>
<div class="block">Set the number format of this <code>PageLayoutProperties</code>
If the parameter <code>format</code> is null, the definition will be
removed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#setPageHeight(double)">setPageHeight</a></strong>(double&nbsp;pageHeight)</code>
<div class="block">Set the page height of this <code>PageLayoutProperties</code>
If the size is set to zero, the page height definition will be removed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#setPageWidth(double)">setPageWidth</a></strong>(double&nbsp;pageWidth)</code>
<div class="block">Set the page width of this <code>PageLayoutProperties</code>
If the size is set to zero, the page width definition will be removed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.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>&nbsp;orientation)</code>
<div class="block">Set the print orientation of this <code>PageLayoutProperties</code>
If the parameter <code>orientation</code> is null, the print orientation
definition will be removed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#setRightBorder(org.odftoolkit.simple.style.Border)">setRightBorder</a></strong>(<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a>&nbsp;border)</code>
<div class="block">Set the border definition for the right border.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html#setTopBorder(org.odftoolkit.simple.style.Border)">setTopBorder</a></strong>(<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a>&nbsp;border)</code>
<div class="block">Set the border definition for the top border.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.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>&nbsp;mode)</code>
<div class="block">Set the writing mode of this <code>PageLayoutProperties</code>
If the parameter <code>mode</code> is null, the default value of writing
node "page" will be set.</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&nbsp;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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="PageLayoutProperties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PageLayoutProperties</h4>
<pre>protected&nbsp;PageLayoutProperties()</pre>
<div class="block">Create an instance of PageLayoutProperties</div>
</li>
</ul>
<a name="PageLayoutProperties(org.odftoolkit.odfdom.dom.element.style.StylePageLayoutPropertiesElement)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PageLayoutProperties</h4>
<pre>protected&nbsp;PageLayoutProperties(org.odftoolkit.odfdom.dom.element.style.StylePageLayoutPropertiesElement&nbsp;pageLayoutProperties)</pre>
<div class="block">Create an instance of PageLayoutProperties from an element
<style:page-layout-properties></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pageLayoutProperties</code> - - the element of style:page-layout-properties</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setBorders(org.odftoolkit.simple.style.StyleTypeDefinitions.CellBordersType, org.odftoolkit.simple.style.Border)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBorders</h4>
<pre>public&nbsp;void&nbsp;setBorders(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.CellBordersType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.CellBordersType</a>&nbsp;bordersType,
<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a>&nbsp;border)</pre>
<div class="block">Set the border style.
<p>
The first parameter <code>bordersType</code> describes which borders you
want to apply the style to, e.g. up border, bottom border, left border,
right border or four borders.
<p>
The border style information will be removed if the parameter
<code>bordersType</code> is NONE.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bordersType</code> - - the type of the borders</dd><dd><code>border</code> - - the border style description</dd></dl>
</li>
</ul>
<a name="getBorder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBorder</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a>&nbsp;getBorder()</pre>
<div class="block">Return the border setting for all four borders.
<p>
Null will be returned if there is no border setting for all four borders.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the border setting</dd></dl>
</li>
</ul>
<a name="getTopBorder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTopBorder</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a>&nbsp;getTopBorder()</pre>
<div class="block">Return the border setting for the top border.
<p>
Null will be returned if there is no border setting for the top border.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the border setting</dd></dl>
</li>
</ul>
<a name="getLeftBorder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLeftBorder</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a>&nbsp;getLeftBorder()</pre>
<div class="block">Return the border setting for the left border.
<p>
Null will be returned if there is no border setting for the left border.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the border setting</dd></dl>
</li>
</ul>
<a name="getRightBorder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRightBorder</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a>&nbsp;getRightBorder()</pre>
<div class="block">Return the border setting for the right border.
<p>
Null will be returned if there is no border setting for the right border.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the border setting</dd></dl>
</li>
</ul>
<a name="getBottomBorder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBottomBorder</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a>&nbsp;getBottomBorder()</pre>
<div class="block">Return the border setting for the bottom border.
<p>
Null will be returned if there is no border setting for the bottom
border.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the border setting</dd></dl>
</li>
</ul>
<a name="setBorder(org.odftoolkit.simple.style.Border)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBorder</h4>
<pre>public&nbsp;void&nbsp;setBorder(<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a>&nbsp;border)</pre>
<div class="block">Set the border definition for all four borders.
<p>
If the parameter <code>border</code> is null, the border definition for
all four borders will be removed.
<p>
If the line type in the border definition is NONE, the border definition
for all four borders will be removed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>border</code> - - the border setting</dd></dl>
</li>
</ul>
<a name="setBottomBorder(org.odftoolkit.simple.style.Border)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBottomBorder</h4>
<pre>public&nbsp;void&nbsp;setBottomBorder(<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a>&nbsp;border)</pre>
<div class="block">Set the border definition for the bottom border.
<p>
If the parameter <code>border</code> is null, the border definition for
the bottom border will be removed.
<p>
If the line type in the border definition is NONE, the border definition
for the bottom border will be removed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>border</code> - - the border setting</dd></dl>
</li>
</ul>
<a name="setTopBorder(org.odftoolkit.simple.style.Border)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTopBorder</h4>
<pre>public&nbsp;void&nbsp;setTopBorder(<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a>&nbsp;border)</pre>
<div class="block">Set the border definition for the top border.
<p>
If the parameter <code>border</code> is null, the border definition for
the top border will be removed.
<p>
If the line type in the border definition is NONE, the border definition
for the top border will be removed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>border</code> - - the border setting</dd></dl>
</li>
</ul>
<a name="setLeftBorder(org.odftoolkit.simple.style.Border)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLeftBorder</h4>
<pre>public&nbsp;void&nbsp;setLeftBorder(<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a>&nbsp;border)</pre>
<div class="block">Set the border definition for the left border.
<p>
If the parameter <code>border</code> is null, the border definition for
the left border will be removed.
<p>
If the line type in the border definition is NONE, the border definition
for the left border will be removed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>border</code> - - the border setting</dd></dl>
</li>
</ul>
<a name="setRightBorder(org.odftoolkit.simple.style.Border)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRightBorder</h4>
<pre>public&nbsp;void&nbsp;setRightBorder(<a href="../../../../org/odftoolkit/simple/style/Border.html" title="class in org.odftoolkit.simple.style">Border</a>&nbsp;border)</pre>
<div class="block">Set the border definition for the right border.
<p>
If the parameter <code>border</code> is null, the border definition for
the right border will be removed.
<p>
If the line type in the border definition is NONE, the border definition
for the right border will be removed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>border</code> - - the border setting</dd></dl>
</li>
</ul>
<a name="setMarginLeft(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMarginLeft</h4>
<pre>public&nbsp;void&nbsp;setMarginLeft(double&nbsp;marginLeft)</pre>
<div class="block">Set the left margin of this <code>PageLayoutProperties</code>
<p>
If the size is set to zero, the left margin definition will be removed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>marginLeft</code> - the size of the left margin (in Millimeter)</dd></dl>
</li>
</ul>
<a name="getMarginLeft()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMarginLeft</h4>
<pre>public&nbsp;double&nbsp;getMarginLeft()</pre>
<div class="block">Get the size of the left margin of this <code>PageLayoutProperties</code>
<p>
If the size is set to zero, the left margin definition will be removed.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the size of the left margin (in Millimeter)</dd></dl>
</li>
</ul>
<a name="setMarginRight(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMarginRight</h4>
<pre>public&nbsp;void&nbsp;setMarginRight(double&nbsp;marginRight)</pre>
<div class="block">Set the right margin of this <code>PageLayoutProperties</code>
<p>
If the size is set to zero, the right margin definition will be removed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>marginRight</code> - the size of the right margin (in Millimeter)</dd></dl>
</li>
</ul>
<a name="getMarginRight()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMarginRight</h4>
<pre>public&nbsp;double&nbsp;getMarginRight()</pre>
<div class="block">Get the size of the right margin of this
<code>PageLayoutProperties</code></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the size of the right margin (in Millimeter)</dd></dl>
</li>
</ul>
<a name="setMarginTop(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMarginTop</h4>
<pre>public&nbsp;void&nbsp;setMarginTop(double&nbsp;marginTop)</pre>
<div class="block">Set the top margin of this <code>PageLayoutProperties</code>
<p>
If the size is set to zero, the top margin definition will be removed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>marginTop</code> - the size of the right margin (in Millimeter)</dd></dl>
</li>
</ul>
<a name="getMarginTop()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMarginTop</h4>
<pre>public&nbsp;double&nbsp;getMarginTop()</pre>
<div class="block">Get the size of the top margin of this <code>PageLayoutProperties</code></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the size of the top margin (in Millimeter)</dd></dl>
</li>
</ul>
<a name="setMarginBottom(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMarginBottom</h4>
<pre>public&nbsp;void&nbsp;setMarginBottom(double&nbsp;marginBottom)</pre>
<div class="block">Set the bottom margin of this <code>PageLayoutProperties</code>
<p>
If the size is set to zero, the bottom margin definition will be removed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>marginBottom</code> - the size of the bottom margin (in Millimeter)</dd></dl>
</li>
</ul>
<a name="getMarginBottom()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMarginBottom</h4>
<pre>public&nbsp;double&nbsp;getMarginBottom()</pre>
<div class="block">Get the size of the bottom margin of this
<code>PageLayoutProperties</code></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the size of the bottom margin (in Millimeter)</dd></dl>
</li>
</ul>
<a name="getNumberFormat()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumberFormat</h4>
<pre>public&nbsp;<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>&nbsp;getNumberFormat()</pre>
<div class="block">Get the number format of this <code>PageLayoutProperties</code></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the number format</dd></dl>
</li>
</ul>
<a name="setNumberFormat(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNumberFormat</h4>
<pre>public&nbsp;void&nbsp;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>&nbsp;format)</pre>
<div class="block">Set the number format of this <code>PageLayoutProperties</code>
<p>
If the parameter <code>format</code> is null, the definition will be
removed.</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></dl>
</li>
</ul>
<a name="getPageWidth()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPageWidth</h4>
<pre>public&nbsp;double&nbsp;getPageWidth()</pre>
<div class="block">Get the page width of this <code>PageLayoutProperties</code></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&nbsp;void&nbsp;setPageWidth(double&nbsp;pageWidth)</pre>
<div class="block">Set the page width of this <code>PageLayoutProperties</code>
<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></dl>
</li>
</ul>
<a name="getPageHeight()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPageHeight</h4>
<pre>public&nbsp;double&nbsp;getPageHeight()</pre>
<div class="block">Get the page height of this <code>PageLayoutProperties</code></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&nbsp;void&nbsp;setPageHeight(double&nbsp;pageHeight)</pre>
<div class="block">Set the page height of this <code>PageLayoutProperties</code>
<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></dl>
</li>
</ul>
<a name="getPrintOrientation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrintOrientation</h4>
<pre>public&nbsp;<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>&nbsp;getPrintOrientation()</pre>
<div class="block">Get the print orientation of this <code>PageLayoutProperties</code></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the 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&nbsp;void&nbsp;setPrintOrientation(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.PrintOrientation.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.PrintOrientation</a>&nbsp;orientation)</pre>
<div class="block">Set the print orientation of this <code>PageLayoutProperties</code>
<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></dl>
</li>
</ul>
<a name="getFootnoteSepAdjustment()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFootnoteSepAdjustment</h4>
<pre>public&nbsp;<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>&nbsp;getFootnoteSepAdjustment()</pre>
<div class="block">Get the way in which a footnote separator line is aligned on a page.
<p>
If there is no <code>style:footnote-sep</code> element, the default value
"left" will be returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the adjustment value of footnote separator line.</dd></dl>
</li>
</ul>
<a name="getFootnoteSepColor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFootnoteSepColor</h4>
<pre>public&nbsp;<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>&nbsp;getFootnoteSepColor()</pre>
<div class="block">Get the color of footnote separator line.
<p>
If there is no <code>style:footnote-sep</code> element, the null value
will be returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the color of footnote separator line.</dd></dl>
</li>
</ul>
<a name="getFootnoteSepDistanceAfterSep()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFootnoteSepDistanceAfterSep</h4>
<pre>public&nbsp;double&nbsp;getFootnoteSepDistanceAfterSep()</pre>
<div class="block">Get the distance between a footnote separator line and the footnote text.
<p>
If there is no <code>style:footnote-sep</code> element, null will be
returned.</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&nbsp;double&nbsp;getFootnoteSepDistanceBeforeSep()</pre>
<div class="block">Get the distance between the text area and a footnote separator line.
<p>
If there is no <code>style:footnote-sep</code> element, null will be
returned.</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&nbsp;<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>&nbsp;getFootnoteSepLineStyle()</pre>
<div class="block">Get the line style of a footnote separator line.
<p>
If there is no <code>style:footnote-sep</code> element, the default value
"NONE" will be returned.</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&nbsp;double&nbsp;getFootnoteSepWidth()</pre>
<div class="block">Get the width of a footnote separator line.
<p>
If there is no <code>style:footnote-sep</code> element, the default value
0 will be returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the width a footnote separator line.</dd></dl>
</li>
</ul>
<a name="getFootnoteSepThickness()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFootnoteSepThickness</h4>
<pre>public&nbsp;double&nbsp;getFootnoteSepThickness()</pre>
<div class="block">Get the thickness of a footnote separator line.
<p>
If there is no <code>style:footnote-sep</code> element, the default value
0 will be returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the thickness 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="blockList">
<li class="blockList">
<h4>setFootnoteSepProperties</h4>
<pre>public&nbsp;void&nbsp;setFootnoteSepProperties(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.AdjustmentStyle.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.AdjustmentStyle</a>&nbsp;adjustment,
org.odftoolkit.odfdom.type.Color&nbsp;color,
double&nbsp;distanceAfterSep,
double&nbsp;distanceBeforeSep,
<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.LineStyle.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.LineStyle</a>&nbsp;lineStyle,
org.odftoolkit.odfdom.type.Percent&nbsp;width,
double&nbsp;thickness)</pre>
<div class="block">Set the formatting of footnote separator of this
<code>PageLayoutProperties</code>
<p>
If the parameter <code>adjustment</code> is null, the adjustment
definition will be set as left. <br>
If the parameter <code>lineStyle</code> is null, the line style
definition will be set as NONE. <br>
If other parameters, like <code>color,
distanceAfterSep, distanceBeforeSep, width or thickness</code> is null,
the corresponding definition will be removed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>adjustment</code> - - specifies how a footnote separator line is aligned on a
page.</dd><dd><code>color</code> - - specifies the color of a column or footnote separator line</dd><dd><code>distanceAfterSep</code> - - specifies the space between a footnote separator line and
the footnote text.</dd><dd><code>distanceBeforeSep</code> - - specifies the space between the body text area and a
footnote separator line.</dd><dd><code>lineStyle</code> - - specifies the style of a footnote separator line.</dd><dd><code>width</code> - - specifies the length of the footnote separator line as a
percentage of the body text area.</dd><dd><code>thickness</code> - - specifies the width or thickness of a line.</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&nbsp;void&nbsp;setWritingMode(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.WritingMode.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.WritingMode</a>&nbsp;mode)</pre>
<div class="block">Set the writing mode of this <code>PageLayoutProperties</code>
<p>
If the parameter <code>mode</code> is null, the default value of writing
node "page" will be set.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mode</code> - - specifies a writing mode.</dd></dl>
</li>
</ul>
<a name="getWritingMode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWritingMode</h4>
<pre>public&nbsp;<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>&nbsp;getWritingMode()</pre>
<div class="block">Get the writing mode of this <code>PageLayoutProperties</code></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the value of writing mode</dd></dl>
</li>
</ul>
<a name="setFootnoteMaxHeight(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFootnoteMaxHeight</h4>
<pre>public&nbsp;void&nbsp;setFootnoteMaxHeight(double&nbsp;height)</pre>
<div class="block">Set the max height of a footnote area on a page.
<p>
If the value of this attribute is set to 0, there is no limit to the
amount of space that the footnote can occupy.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>height</code> - - the max height which a footnote area can occupy</dd></dl>
</li>
</ul>
<a name="getFootnoteMaxHeight()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFootnoteMaxHeight</h4>
<pre>public&nbsp;double&nbsp;getFootnoteMaxHeight()</pre>
<div class="block">Get the max height of a footnote area on a page.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the value of max height of footnote area.</dd></dl>
</li>
</ul>
<a name="getOrCreatePageLayoutProperties(org.odftoolkit.odfdom.dom.element.OdfStyleBase)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOrCreatePageLayoutProperties</h4>
<pre>public static&nbsp;<a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html" title="class in org.odftoolkit.simple.style">PageLayoutProperties</a>&nbsp;getOrCreatePageLayoutProperties(org.odftoolkit.odfdom.dom.element.OdfStyleBase&nbsp;style)</pre>
<div class="block">Return an instance of
<code>PageLayoutProperties</p> to represent the "style:page-layout-properties" in a style element.
<p>If there is no "style:page-layout-properties" defined in the style element, a new "style:page-layout-properties" element will be created.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>style</code> - - a style element</dd>
<dt><span class="strong">Returns:</span></dt><dd>an instance of <code>PageLayoutProperties</p></dd></dl>
</li>
</ul>
<a name="getPageLayoutProperties(org.odftoolkit.odfdom.dom.element.OdfStyleBase)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPageLayoutProperties</h4>
<pre>public static&nbsp;<a href="../../../../org/odftoolkit/simple/style/PageLayoutProperties.html" title="class in org.odftoolkit.simple.style">PageLayoutProperties</a>&nbsp;getPageLayoutProperties(org.odftoolkit.odfdom.dom.element.OdfStyleBase&nbsp;style)</pre>
<div class="block">Return an instance of
<code>PageLayoutProperties</p> to represent the "style:page-layout-properties" in a style element.
<p>If there is no "style:page-layout-properties" defined in the style element, null will be returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>style</code> - - a style element</dd>
<dt><span class="strong">Returns:</span></dt><dd>an instance of <code>PageLayoutProperties</p>;Null if there is no
"style:page-layout-properties" defined</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/PageLayoutProperties.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/NumberFormat.html" title="enum in org.odftoolkit.simple.style"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/style/ParagraphProperties.html" title="class 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/PageLayoutProperties.html" target="_top">Frames</a></li>
<li><a href="PageLayoutProperties.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2010-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>