Google Git
Sign in
apache / incubator-odftoolkit-site / d22ef2d53769a0a209d42b84c8275ad1d8522260 / . / content / odftoolkit / mvn-site / 0.8-incubating / simple-odf / apidocs / org / odftoolkit / simple / style / TableProperties.html
blob: 270c1d965d51d391e26ef7401f826e7e8e7dc8e9 [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:17 CET 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>TableProperties (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="TableProperties (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/TableProperties.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/TableCellProperties.html" title="class in org.odftoolkit.simple.style"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/style/TextProperties.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/TableProperties.html" target="_top">Frames</a></li>
<li><a href="TableProperties.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 TableProperties" class="title">Class TableProperties</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.TableProperties</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">TableProperties</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 table style settings. It provides methods to access
or modify the formatting properties applied to tables. More functions will be
added latter.
<p>
This class is a corresponded high level class for element
"style:table-properties". It provides methods to access the attributes and
children of "style:table-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/TableProperties.html#TableProperties()">TableProperties</a></strong>()</code>
<div class="block">Create an instance of TableProperties</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/TableProperties.html#TableProperties(org.odftoolkit.odfdom.dom.element.style.StyleTablePropertiesElement)">TableProperties</a></strong>(org.odftoolkit.odfdom.dom.element.style.StyleTablePropertiesElement&nbsp;properties)</code>
<div class="block">Create an instance of TableProperties from an element
<style:table-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="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/TableProperties.html#getBreakAfter()">getBreakAfter</a></strong>()</code>
<div class="block">Return the break property after the reference.</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/TableProperties.html#getBreakBefore()">getBreakBefore</a></strong>()</code>
<div class="block">Return the break property before the reference.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/odftoolkit/simple/style/TableProperties.html" title="class in org.odftoolkit.simple.style">TableProperties</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/TableProperties.html#getOrCreateTableProperties(org.odftoolkit.odfdom.dom.element.OdfStyleBase)">getOrCreateTableProperties</a></strong>(org.odftoolkit.odfdom.dom.element.OdfStyleBase&nbsp;style)</code>
<div class="block">Return an instance of
<code>TableProperties to represent the "style:table-properties" in a style element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/TableProperties.html#getPageNumber()">getPageNumber</a></strong>()</code>
<div class="block">Return the page number that is used for a new page with a master style.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/odftoolkit/simple/style/TableProperties.html" title="class in org.odftoolkit.simple.style">TableProperties</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/TableProperties.html#getTableProperties(org.odftoolkit.odfdom.dom.element.OdfStyleBase)">getTableProperties</a></strong>(org.odftoolkit.odfdom.dom.element.OdfStyleBase&nbsp;style)</code>
<div class="block">Return an instance of
<code>TableProperties to represent the "style:table-properties" in a style element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/TableProperties.html#setBreak(java.lang.String, java.lang.String)">setBreak</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;breakPosition,
<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;breakAttribute)</code>
<div class="block">Set the break.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/style/TableProperties.html#setPageNumber(int)">setPageNumber</a></strong>(int&nbsp;pageNumber)</code>
<div class="block">Set the page number for a new page with a master style.</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="TableProperties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TableProperties</h4>
<pre>protected&nbsp;TableProperties()</pre>
<div class="block">Create an instance of TableProperties</div>
</li>
</ul>
<a name="TableProperties(org.odftoolkit.odfdom.dom.element.style.StyleTablePropertiesElement)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TableProperties</h4>
<pre>protected&nbsp;TableProperties(org.odftoolkit.odfdom.dom.element.style.StyleTablePropertiesElement&nbsp;properties)</pre>
<div class="block">Create an instance of TableProperties from an element
<style:table-properties></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>properties</code> - - the element of style:table-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="setBreak(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBreak</h4>
<pre>public&nbsp;void&nbsp;setBreak(<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;breakPosition,
<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;breakAttribute)</pre>
<div class="block">Set the break.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>breakPosition</code> - the position to insert a break (before or after)</dd><dd><code>breakAttribute</code> - the attribute name (page or column)</dd></dl>
</li>
</ul>
<a name="getBreakBefore()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBreakBefore</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;getBreakBefore()</pre>
<div class="block">Return the break property before the reference.
<p>
Null will be returned if there is no break setting before the reference.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>- the break property; null if there is no break setting.</dd></dl>
</li>
</ul>
<a name="getBreakAfter()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBreakAfter</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;getBreakAfter()</pre>
<div class="block">Return the break property after the reference.
<p>
Null will be returned if there is no break setting after the reference.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>- the break property; null if there is no break setting.</dd></dl>
</li>
</ul>
<a name="getPageNumber()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPageNumber</h4>
<pre>public&nbsp;int&nbsp;getPageNumber()</pre>
<div class="block">Return the page number that is used for a new page with a master style.
<p>
If there is no valid page number, 0 will be returned;</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the page number</dd></dl>
</li>
</ul>
<a name="setPageNumber(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPageNumber</h4>
<pre>public&nbsp;void&nbsp;setPageNumber(int&nbsp;pageNumber)</pre>
<div class="block">Set the page number for a new page with a master style.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pageNumber</code> - the page number</dd></dl>
</li>
</ul>
<a name="getOrCreateTableProperties(org.odftoolkit.odfdom.dom.element.OdfStyleBase)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOrCreateTableProperties</h4>
<pre>public static&nbsp;<a href="../../../../org/odftoolkit/simple/style/TableProperties.html" title="class in org.odftoolkit.simple.style">TableProperties</a>&nbsp;getOrCreateTableProperties(org.odftoolkit.odfdom.dom.element.OdfStyleBase&nbsp;style)</pre>
<div class="block">Return an instance of
<code>TableProperties</p> to represent the "style:table-properties" in a style element.
<p>If there is no "style:table-properties" defined in the style element, a new "style:table-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>TableProperties</p></dd></dl>
</li>
</ul>
<a name="getTableProperties(org.odftoolkit.odfdom.dom.element.OdfStyleBase)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getTableProperties</h4>
<pre>public static&nbsp;<a href="../../../../org/odftoolkit/simple/style/TableProperties.html" title="class in org.odftoolkit.simple.style">TableProperties</a>&nbsp;getTableProperties(org.odftoolkit.odfdom.dom.element.OdfStyleBase&nbsp;style)</pre>
<div class="block">Return an instance of
<code>TableProperties</p> to represent the "style:table-properties" in a style element.
<p>If there is no "style:table-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>TableProperties</p>;Null if there is no
"style:table-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/TableProperties.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/TableCellProperties.html" title="class in org.odftoolkit.simple.style"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/style/TextProperties.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/TableProperties.html" target="_top">Frames</a></li>
<li><a href="TableProperties.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>