Google Git
Sign in
apache / incubator-odftoolkit-site / d22ef2d53769a0a209d42b84c8275ad1d8522260 / . / content / odftoolkit / mvn-site / 0.8-incubating / simple-odf / apidocs / org / odftoolkit / simple / text / Header.html
blob: 480ba3bec98db3e763c280522936d1ab71ef0a4b [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>Header (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="Header (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/Header.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/text/Footer.html" title="class in org.odftoolkit.simple.text"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/text/Header.html" target="_top">Frames</a></li>
<li><a href="Header.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.text</div>
<h2 title="Class Header" class="title">Class Header</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><a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">org.odftoolkit.simple.Component</a></li>
<li>
<ul class="inheritance">
<li>org.odftoolkit.simple.text.Header</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/odftoolkit/simple/common/field/VariableContainer.html" title="interface in org.odftoolkit.simple.common.field">VariableContainer</a>, <a href="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">Header</span>
extends <a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a>
implements <a href="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</a>, <a href="../../../../org/odftoolkit/simple/common/field/VariableContainer.html" title="interface in org.odftoolkit.simple.common.field">VariableContainer</a></pre>
<div class="block">This class represents header definition in text document. It provides methods
to manipulate header in text document, such as, set text, add table.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>0.4.5</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="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/odftoolkit/simple/text/Header.html#Header(org.odftoolkit.odfdom.dom.element.style.StyleHeaderElement)">Header</a></strong>(org.odftoolkit.odfdom.dom.element.style.StyleHeaderElement&nbsp;element)</code>
<div class="block">Create a header instance by an object of <code>StyleHeaderElement</code>.</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/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Header.html#addTable()">addTable</a></strong>()</code>
<div class="block">Add a new Table to this container.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Header.html#addTable(int, int)">addTable</a></strong>(int&nbsp;numRows,
int&nbsp;numCols)</code>
<div class="block">Add a new Table to this container with a specified row number and column
number.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/text/Section.html" title="class in org.odftoolkit.simple.text">Section</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Header.html#appendSection(java.lang.String)">appendSection</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;name)</code>
<div class="block">Create an empty section and append it at the end of the footer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/common/field/VariableField.html" title="class in org.odftoolkit.simple.common.field">VariableField</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Header.html#declareVariable(java.lang.String, org.odftoolkit.simple.common.field.VariableField.VariableType)">declareVariable</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;name,
<a href="../../../../org/odftoolkit/simple/common/field/VariableField.VariableType.html" title="enum in org.odftoolkit.simple.common.field">VariableField.VariableType</a>&nbsp;type)</code>
<div class="block">Declare a new variable field to this container.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.dom.element.style.StyleHeaderElement</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Header.html#getOdfElement()">getOdfElement</a></strong>()</code>
<div class="block">Return an instance of <code>StyleHeaderElement</code> which represents
this feature.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/table/Table.TableBuilder.html" title="class in org.odftoolkit.simple.table">Table.TableBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Header.html#getTableBuilder()">getTableBuilder</a></strong>()</code>
<div class="block">Return the table builder of this document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Header.html#getTableByName(java.lang.String)">getTableByName</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;name)</code>
<div class="block">Return an instance of table feature with the specific table name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.pkg.OdfElement</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Header.html#getTableContainerElement()">getTableContainerElement</a></strong>()</code>
<div class="block">Get the ODF element which can have
<table:table>
as child element directly according to ODF specification.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Header.html#getTableList()">getTableList</a></strong>()</code>
<div class="block">Return a list of table features in this document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.pkg.OdfElement</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Header.html#getVariableContainerElement()">getVariableContainerElement</a></strong>()</code>
<div class="block">Get the ODF element which can have variable declare section as child
element directly according to ODF specification.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/common/field/VariableField.html" title="class in org.odftoolkit.simple.common.field">VariableField</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Header.html#getVariableFieldByName(java.lang.String)">getVariableFieldByName</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;name)</code>
<div class="block">Return the declared variable by name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Header.html#isVisible()">isVisible</a></strong>()</code>
<div class="block">Get this header is visible or not.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Header.html#setVisible(boolean)">setVisible</a></strong>(boolean&nbsp;isVisible)</code>
<div class="block">Set this header visible or not.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.odftoolkit.simple.Component">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.odftoolkit.simple.<a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a></h3>
<code><a href="../../../../org/odftoolkit/simple/Component.html#getComponentByElement(org.odftoolkit.odfdom.pkg.OdfElement)">getComponentByElement</a>, <a href="../../../../org/odftoolkit/simple/Component.html#getOwnerDocument()">getOwnerDocument</a>, <a href="../../../../org/odftoolkit/simple/Component.html#registerComponent(org.odftoolkit.simple.Component, org.odftoolkit.odfdom.pkg.OdfElement)">registerComponent</a>, <a href="../../../../org/odftoolkit/simple/Component.html#unregisterComponent(org.odftoolkit.odfdom.pkg.OdfElement)">unregisterComponent</a></code></li>
</ul>
<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="Header(org.odftoolkit.odfdom.dom.element.style.StyleHeaderElement)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Header</h4>
<pre>public&nbsp;Header(org.odftoolkit.odfdom.dom.element.style.StyleHeaderElement&nbsp;element)</pre>
<div class="block">Create a header instance by an object of <code>StyleHeaderElement</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>element</code> - - an object of <code>StyleHeaderElement</code></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="getOdfElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOdfElement</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.dom.element.style.StyleHeaderElement&nbsp;getOdfElement()</pre>
<div class="block">Return an instance of <code>StyleHeaderElement</code> which represents
this feature.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/Component.html#getOdfElement()">getOdfElement</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>an instance of <code>StyleHeaderElement</code></dd></dl>
</li>
</ul>
<a name="isVisible()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isVisible</h4>
<pre>public&nbsp;boolean&nbsp;isVisible()</pre>
<div class="block">Get this header is visible or not.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>If this header is visible return <code>true</code>, otherwise
return <code>false</code>.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.5.5</dd></dl>
</li>
</ul>
<a name="setVisible(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setVisible</h4>
<pre>public&nbsp;void&nbsp;setVisible(boolean&nbsp;isVisible)</pre>
<div class="block">Set this header visible or not.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>isVisible</code> - If <code>isVisible</code> is true, the header of this document
is visible, otherwise is invisible.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.5.5</dd></dl>
</li>
</ul>
<a name="addTable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTable</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>&nbsp;addTable()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#addTable()">TableContainer</a></code></strong></div>
<div class="block">Add a new Table to this container.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#addTable()">addTable</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>added table.</dd></dl>
</li>
</ul>
<a name="addTable(int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTable</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>&nbsp;addTable(int&nbsp;numRows,
int&nbsp;numCols)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#addTable(int, int)">TableContainer</a></code></strong></div>
<div class="block">Add a new Table to this container with a specified row number and column
number.
<p>
The table will be inserted at the end of the tableContainer. An unique
table name will be given, you may set a custom table name using the
<code>setTableName</code> method.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#addTable(int, int)">addTable</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>numRows</code> - the row number</dd><dd><code>numCols</code> - the column number</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new instance of <code>Table</code></dd></dl>
</li>
</ul>
<a name="getTableByName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTableByName</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>&nbsp;getTableByName(<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;name)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableByName(java.lang.String)">TableContainer</a></code></strong></div>
<div class="block">Return an instance of table feature with the specific table name.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableByName(java.lang.String)">getTableByName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - of the table being searched for.</dd>
<dt><span class="strong">Returns:</span></dt><dd>an instance of table feature with the specific table name.</dd></dl>
</li>
</ul>
<a name="getTableList()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTableList</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>&gt;&nbsp;getTableList()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableList()">TableContainer</a></code></strong></div>
<div class="block">Return a list of table features in this document.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableList()">getTableList</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a list of table features in this document.</dd></dl>
</li>
</ul>
<a name="getTableBuilder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTableBuilder</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/table/Table.TableBuilder.html" title="class in org.odftoolkit.simple.table">Table.TableBuilder</a>&nbsp;getTableBuilder()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableBuilder()">TableContainer</a></code></strong></div>
<div class="block">Return the table builder of this document. Every document has a table
builder, which supplies all of the table creation realization, for
example newTable().</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableBuilder()">getTableBuilder</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the table builder of this document.</dd></dl>
</li>
</ul>
<a name="getTableContainerElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTableContainerElement</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.pkg.OdfElement&nbsp;getTableContainerElement()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableContainerElement()">TableContainer</a></code></strong></div>
<div class="block">Get the ODF element which can have
<table:table>
as child element directly according to ODF specification. This Element
will help to find the position to insert a new Table. For example,
<table:table>
element is usable with <office:text> element, so TextDocument will return
OfficeTextElement. While Presentation Notes is an indirectly
TableContainer, which holds Table with the help of its grand-child
element <draw:text-box>, so for Notes, DrawTextBoxElement should be
return.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableContainerElement()">getTableContainerElement</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>container element which can hold <text:table>.</dd></dl>
</li>
</ul>
<a name="getVariableContainerElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVariableContainerElement</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.pkg.OdfElement&nbsp;getVariableContainerElement()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/common/field/VariableContainer.html#getVariableContainerElement()">VariableContainer</a></code></strong></div>
<div class="block">Get the ODF element which can have variable declare section as child
element directly according to ODF specification. This element will help
to find the position to declare a new variable.
<p>
The variable declare section may be <text:variable-decls>,
<text:user-field-decls> or <text:sequence-decls>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/common/field/VariableContainer.html#getVariableContainerElement()">getVariableContainerElement</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/common/field/VariableContainer.html" title="interface in org.odftoolkit.simple.common.field">VariableContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>container element which can hold variable declare section.</dd></dl>
</li>
</ul>
<a name="declareVariable(java.lang.String, org.odftoolkit.simple.common.field.VariableField.VariableType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>declareVariable</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/common/field/VariableField.html" title="class in org.odftoolkit.simple.common.field">VariableField</a>&nbsp;declareVariable(<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;name,
<a href="../../../../org/odftoolkit/simple/common/field/VariableField.VariableType.html" title="enum in org.odftoolkit.simple.common.field">VariableField.VariableType</a>&nbsp;type)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/common/field/VariableContainer.html#declareVariable(java.lang.String, org.odftoolkit.simple.common.field.VariableField.VariableType)">VariableContainer</a></code></strong></div>
<div class="block">Declare a new variable field to this container.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/common/field/VariableContainer.html#declareVariable(java.lang.String, org.odftoolkit.simple.common.field.VariableField.VariableType)">declareVariable</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/common/field/VariableContainer.html" title="interface in org.odftoolkit.simple.common.field">VariableContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the unique name of this variable field.</dd><dd><code>type</code> - the type of this variable field.</dd>
<dt><span class="strong">Returns:</span></dt><dd>declared variable field.</dd></dl>
</li>
</ul>
<a name="getVariableFieldByName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVariableFieldByName</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/common/field/VariableField.html" title="class in org.odftoolkit.simple.common.field">VariableField</a>&nbsp;getVariableFieldByName(<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;name)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/common/field/VariableContainer.html#getVariableFieldByName(java.lang.String)">VariableContainer</a></code></strong></div>
<div class="block">Return the declared variable by name.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/common/field/VariableContainer.html#getVariableFieldByName(java.lang.String)">getVariableFieldByName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/common/field/VariableContainer.html" title="interface in org.odftoolkit.simple.common.field">VariableContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the unique name of this variable field.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the declared variable.</dd></dl>
</li>
</ul>
<a name="appendSection(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>appendSection</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/text/Section.html" title="class in org.odftoolkit.simple.text">Section</a>&nbsp;appendSection(<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;name)</pre>
<div class="block">Create an empty section and append it at the end of the footer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - - specify the section name</dd>
<dt><span class="strong">Returns:</span></dt><dd>an instance of the section</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a></code> - if content DOM could not be initialized</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/Header.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/text/Footer.html" title="class in org.odftoolkit.simple.text"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/text/Header.html" target="_top">Frames</a></li>
<li><a href="Header.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>