Google Git
Sign in
apache / incubator-odftoolkit-site / d22ef2d53769a0a209d42b84c8275ad1d8522260 / . / content / odftoolkit / mvn-site / 0.8-incubating / simple-odf / apidocs / org / odftoolkit / simple / TextDocument.html
blob: aefcd39b910052b8bb5c5d5aa064a0677301102a [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>TextDocument (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="TextDocument (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/TextDocument.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/SpreadsheetDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/odftoolkit/simple/TextDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/odftoolkit/simple/TextDocument.html" target="_top">Frames</a></li>
<li><a href="TextDocument.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><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields_inherited_from_class_org.odftoolkit.odfdom.dom.OdfSchemaDocument">Field</a>&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</div>
<h2 title="Class TextDocument" class="title">Class TextDocument</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.odfdom.pkg.OdfPackageDocument</li>
<li>
<ul class="inheritance">
<li>org.odftoolkit.odfdom.dom.OdfSchemaDocument</li>
<li>
<ul class="inheritance">
<li><a href="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">org.odftoolkit.simple.Document</a></li>
<li>
<ul class="inheritance">
<li>org.odftoolkit.simple.TextDocument</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="../../../org/odftoolkit/simple/chart/ChartContainer.html" title="interface in org.odftoolkit.simple.chart">ChartContainer</a>, <a href="../../../org/odftoolkit/simple/common/field/VariableContainer.html" title="interface in org.odftoolkit.simple.common.field">VariableContainer</a>, <a href="../../../org/odftoolkit/simple/draw/ControlContainer.html" title="interface in org.odftoolkit.simple.draw">ControlContainer</a>, <a href="../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</a>, <a href="../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</a>, <a href="../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a>, <a href="../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">TextDocument</span>
extends <a href="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</a>
implements <a href="../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a>, <a href="../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</a>, <a href="../../../org/odftoolkit/simple/common/field/VariableContainer.html" title="interface in org.odftoolkit.simple.common.field">VariableContainer</a>, <a href="../../../org/odftoolkit/simple/chart/ChartContainer.html" title="interface in org.odftoolkit.simple.chart">ChartContainer</a>, <a href="../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</a>, <a href="../../../org/odftoolkit/simple/draw/ControlContainer.html" title="interface in org.odftoolkit.simple.draw">ControlContainer</a></pre>
<div class="block">This class represents an empty ODF text document.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple">TextDocument.OdfMediaType</a></strong></code>
<div class="block">This enum contains all possible media types of SpreadsheetDocument
documents.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_org.odftoolkit.simple.Document">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.odftoolkit.simple.<a href="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</a></h3>
<code><a href="../../../org/odftoolkit/simple/Document.ScriptType.html" title="enum in org.odftoolkit.simple">Document.ScriptType</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_org.odftoolkit.odfdom.dom.OdfSchemaDocument">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.odftoolkit.odfdom.dom.OdfSchemaDocument</h3>
<code>org.odftoolkit.odfdom.dom.OdfSchemaDocument.OdfXMLFile</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_org.odftoolkit.odfdom.pkg.OdfPackageDocument">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.odftoolkit.odfdom.pkg.OdfPackageDocument</h3>
<code>org.odftoolkit.odfdom.pkg.OdfPackageDocument.Resource</code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.odftoolkit.odfdom.dom.OdfSchemaDocument">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.odftoolkit.odfdom.dom.OdfSchemaDocument</h3>
<code>mContentDom, mDocumentStyles, mMetaDom, mSettingsDom, mStylesDom</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.odftoolkit.odfdom.pkg.OdfPackageDocument">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.odftoolkit.odfdom.pkg.OdfPackageDocument</h3>
<code>mDocumentMediaType, mDocumentPathInPackage, mPackage, ROOT_DOCUMENT_PATH</code></li>
</ul>
</li>
</ul>
<!-- ======== 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/TextDocument.html#TextDocument(org.odftoolkit.odfdom.pkg.OdfPackage, java.lang.String, org.odftoolkit.simple.TextDocument.OdfMediaType)">TextDocument</a></strong>(org.odftoolkit.odfdom.pkg.OdfPackage&nbsp;pkg,
<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;internalPath,
<a href="../../../org/odftoolkit/simple/TextDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple">TextDocument.OdfMediaType</a>&nbsp;odfMediaType)</code>
<div class="block">To avoid data duplication a new document is only created, if not already
opened.</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#addColumnBreak()">addColumnBreak</a></strong>()</code>
<div class="block">Appends a new column break to this document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#addColumnBreak(org.odftoolkit.simple.text.Paragraph)">addColumnBreak</a></strong>(<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;refParagraph)</code>
<div class="block">Appends a new column break to this document after the reference paragraph.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#addList()">addList</a></strong>()</code>
<div class="block">Add a new List to this container.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#addList(org.odftoolkit.simple.text.list.ListDecorator)">addList</a></strong>(<a href="../../../org/odftoolkit/simple/text/list/ListDecorator.html" title="interface in org.odftoolkit.simple.text.list">ListDecorator</a>&nbsp;decorator)</code>
<div class="block">Add a List with specified ListDecorator to this container.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#addPageBreak()">addPageBreak</a></strong>()</code>
<div class="block">Appends a new page break to this document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#addPageBreak(org.odftoolkit.simple.text.Paragraph)">addPageBreak</a></strong>(<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;refParagraph)</code>
<div class="block">Appends a new page break to this document after the reference paragraph.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#addPageBreak(org.odftoolkit.simple.text.Paragraph, org.odftoolkit.simple.style.MasterPage)">addPageBreak</a></strong>(<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;refParagraph,
<a href="../../../org/odftoolkit/simple/style/MasterPage.html" title="class in org.odftoolkit.simple.style">MasterPage</a>&nbsp;master)</code>
<div class="block">Appends a new page break to this document after the reference paragraph,
and the master page style will be applied to the new page.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#addParagraph(java.lang.String)">addParagraph</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;text)</code>
<div class="block">Creates a new paragraph and append text.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.incubator.doc.text.OdfTextParagraph</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#addText(java.lang.String)">addText</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;text)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>As of Simple version 0.5, replaced by
<code>Paragraph.appendTextContent(String content)</code></i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<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/TextDocument.html#appendSection(org.odftoolkit.simple.text.Section, boolean)">appendSection</a></strong>(<a href="../../../org/odftoolkit/simple/text/Section.html" title="class in org.odftoolkit.simple.text">Section</a>&nbsp;section,
boolean&nbsp;isResourceCopied)</code>
<div class="block">Copy a section and append it at the end of the text document, whether the
section is in this document or in a different document.</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/TextDocument.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 text document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#changeMode(org.odftoolkit.simple.TextDocument.OdfMediaType)">changeMode</a></strong>(<a href="../../../org/odftoolkit/simple/TextDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple">TextDocument.OdfMediaType</a>&nbsp;mediaType)</code>
<div class="block">Changes the document to the given mediatype.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#clearList()">clearList</a></strong>()</code>
<div class="block">Remove all Lists from this container.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#createChart(java.lang.String, org.odftoolkit.simple.chart.DataSet, java.awt.Rectangle)">createChart</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;title,
<a href="../../../org/odftoolkit/simple/chart/DataSet.html" title="class in org.odftoolkit.simple.chart">DataSet</a>&nbsp;dataset,
<a href="http://download.oracle.com/javase/6/docs/api/java/awt/Rectangle.html?is-external=true" title="class or interface in java.awt">Rectangle</a>&nbsp;rect)</code>
<div class="block">Creates a new Chart for this container.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#createChart(java.lang.String, org.odftoolkit.simple.SpreadsheetDocument, org.odftoolkit.odfdom.type.CellRangeAddressList, boolean, boolean, boolean, java.awt.Rectangle)">createChart</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;title,
<a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html" title="class in org.odftoolkit.simple">SpreadsheetDocument</a>&nbsp;document,
org.odftoolkit.odfdom.type.CellRangeAddressList&nbsp;cellRangeAddr,
boolean&nbsp;firstRowAsLabel,
boolean&nbsp;firstColumnAsLabel,
boolean&nbsp;rowAsDataSeries,
<a href="http://download.oracle.com/javase/6/docs/api/java/awt/Rectangle.html?is-external=true" title="class or interface in java.awt">Rectangle</a>&nbsp;rect)</code>
<div class="block">Creates a new Chart for this container.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#createChart(java.lang.String, java.lang.String[], java.lang.String[], double[][], java.awt.Rectangle)">createChart</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;title,
<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;labels,
<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;legends,
double[][]&nbsp;data,
<a href="http://download.oracle.com/javase/6/docs/api/java/awt/Rectangle.html?is-external=true" title="class or interface in java.awt">Rectangle</a>&nbsp;rect)</code>
<div class="block">Creates a new Chart for this container.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.dom.element.text.TextTableOfContentElement</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#createDefaultTOC(org.odftoolkit.simple.text.Paragraph, boolean)">createDefaultTOC</a></strong>(<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;refParagraph,
boolean&nbsp;before)</code>
<div class="block">Create a new Table Of Content to this document before the reference
paragraph.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/odftoolkit/simple/draw/Control.html" title="class in org.odftoolkit.simple.draw">Control</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#createDrawControl()">createDrawControl</a></strong>()</code>
<div class="block">Create an instance of control and and append it at the end of this
container.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/odftoolkit/simple/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#createForm(java.lang.String)">createForm</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 a form with specified name in this text document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.dom.element.text.TextTableOfContentElement</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#createTOCwithStyle(org.odftoolkit.simple.text.Paragraph, org.odftoolkit.simple.style.TOCStyle, boolean)">createTOCwithStyle</a></strong>(<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;refParagraph,
<a href="../../../org/odftoolkit/simple/style/TOCStyle.html" title="class in org.odftoolkit.simple.style">TOCStyle</a>&nbsp;additionalStyle,
boolean&nbsp;before)</code>
<div class="block">Create a new Table Of Content to this document before the reference
paragraph.</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/TextDocument.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="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#deleteChartById(java.lang.String)">deleteChartById</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;chartId)</code>
<div class="block">Deletes chart by chart id.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#deleteChartByTitle(java.lang.String)">deleteChartByTitle</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;title)</code>
<div class="block">Deletes chart(s) by chart title.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#getApplyDesignMode()">getApplyDesignMode</a></strong>()</code>
<div class="block">Get the attribute <code>form:apply-design-mode</code> which specifies
whether forms are presented in editable or non-editable state.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#getAutomaticFocus()">getAutomaticFocus</a></strong>()</code>
<div class="block">Get the attribute <code>form:automatic-focus</code> which specifies
whether the consumer loading the document should set the focus to a form
control.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#getChartById(java.lang.String)">getChartById</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;chartId)</code>
<div class="block">Gets chart with specified id.</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/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#getChartByTitle(java.lang.String)">getChartByTitle</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;title)</code>
<div class="block">Gets chart list with specified title.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#getChartCount()">getChartCount</a></strong>()</code>
<div class="block">Returns the chart count of this container</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.dom.element.office.OfficeTextElement</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#getContentRoot()">getContentRoot</a></strong>()</code>
<div class="block">Get the content root of a text 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/TextDocument.html#getDrawControlContainerElement()">getDrawControlContainerElement</a></strong>()</code>
<div class="block">Get the ODF element which can have DrawControlElement as child element
directly.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/odftoolkit/simple/text/Footer.html" title="class in org.odftoolkit.simple.text">Footer</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#getFooter()">getFooter</a></strong>()</code>
<div class="block">Get the Standard Page footer of this text document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/odftoolkit/simple/text/Footer.html" title="class in org.odftoolkit.simple.text">Footer</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#getFooter(boolean)">getFooter</a></strong>(boolean&nbsp;isFirstPage)</code>
<div class="block">Get the footer of this text document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/odftoolkit/simple/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#getFormByName(java.lang.String)">getFormByName</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 a form whose name is a given value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.dom.element.office.OfficeFormsElement</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#getFormContainerElement()">getFormContainerElement</a></strong>()</code>
<div class="block">Get the ODF element <code>OfficeFormsElement</code> which can have
<code>FormFormElement</code> 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/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../org/odftoolkit/simple/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#getFormIterator()">getFormIterator</a></strong>()</code>
<div class="block">Get a form iterator to traverse all the forms in this document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/odftoolkit/simple/text/Header.html" title="class in org.odftoolkit.simple.text">Header</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#getHeader()">getHeader</a></strong>()</code>
<div class="block">Get the Standard Page header of this text document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/odftoolkit/simple/text/Header.html" title="class in org.odftoolkit.simple.text">Header</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#getHeader(boolean)">getHeader</a></strong>(boolean&nbsp;isFirstPage)</code>
<div class="block">Get the header of this text 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/TextDocument.html#getListContainerElement()">getListContainerElement</a></strong>()</code>
<div class="block">Get the ODF element which can have <text:list> 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/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#getListIterator()">getListIterator</a></strong>()</code>
<div class="block">Return an Iterator of the Lists in this ListContainer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#getParagraphByIndex(int, boolean)">getParagraphByIndex</a></strong>(int&nbsp;index,
boolean&nbsp;isEmptyParagraphSkipped)</code>
<div class="block">Return a paragraph with a given index.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#getParagraphByReverseIndex(int, boolean)">getParagraphByReverseIndex</a></strong>(int&nbsp;reverseIndex,
boolean&nbsp;isEmptyParagraphSkipped)</code>
<div class="block">Return a paragraph with a given index.</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/TextDocument.html#getParagraphContainerElement()">getParagraphContainerElement</a></strong>()</code>
<div class="block">Get the ODF element which can have <text:p> as child element directly.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#getParagraphIterator()">getParagraphIterator</a></strong>()</code>
<div class="block">Return an Iterator of the paragraph in this container.</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/TextDocument.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>org.odftoolkit.odfdom.pkg.OdfElement</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.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="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/TextDocument.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="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#insertContentFromDocumentAfter(org.odftoolkit.simple.TextDocument, org.odftoolkit.simple.text.Paragraph, boolean)">insertContentFromDocumentAfter</a></strong>(<a href="../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a>&nbsp;sourceDocument,
<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;referenceParagraph,
boolean&nbsp;isCopyStyle)</code>
<div class="block">Copy text content of the source TextDocument and insert it to the current TextDocument
after the reference Paragraph, with Styles or without Styles.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#insertContentFromDocumentBefore(org.odftoolkit.simple.TextDocument, org.odftoolkit.simple.text.Paragraph, boolean)">insertContentFromDocumentBefore</a></strong>(<a href="../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a>&nbsp;sourceDocument,
<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;referenceParagraph,
boolean&nbsp;isCopyStyle)</code>
<div class="block">Copy text content of the source TextDocument and insert it to the current TextDocument
before the reference Paragraph, with Styles or without Styles.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.pkg.OdfElement</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#insertOdfElement(org.odftoolkit.odfdom.pkg.OdfElement, org.odftoolkit.simple.Document, org.odftoolkit.odfdom.pkg.OdfElement, boolean)">insertOdfElement</a></strong>(org.odftoolkit.odfdom.pkg.OdfElement&nbsp;referenceOdfElement,
<a href="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</a>&nbsp;sourceDocument,
org.odftoolkit.odfdom.pkg.OdfElement&nbsp;sourceOdfElement,
boolean&nbsp;before)</code>
<div class="block">Copy a OdfElement and insert it before or after the Reference OdfElement in the TextDocument, whether the
OdfElement is in this TextDocument or in a different Document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#insertParagraph(org.odftoolkit.simple.text.Paragraph, org.odftoolkit.simple.text.Paragraph, boolean)">insertParagraph</a></strong>(<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;referenceParagraph,
<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;sourceParagraph,
boolean&nbsp;before)</code>
<div class="block">Copy a Paragraph and insert it before or after the Reference Paragraph in the text document, whether the
Paragraph is in this document or in a different 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/TextDocument.html#insertTable(org.odftoolkit.simple.text.Paragraph, org.odftoolkit.simple.table.Table, boolean)">insertTable</a></strong>(<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;referenceParagraph,
<a href="../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>&nbsp;sourceTable,
boolean&nbsp;before)</code>
<div class="block">Copy a Table and insert it before or after the Reference Paragraph in the text document, whether the
Table is in this TextDocument or in a different Document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#loadDocument(java.io.File)">loadDocument</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file)</code>
<div class="block">Creates an TextDocument from the OpenDocument provided by a File.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#loadDocument(java.io.InputStream)">loadDocument</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;inputStream)</code>
<div class="block">Creates an TextDocument from the OpenDocument provided by a resource
Stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#loadDocument(java.lang.String)">loadDocument</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;documentPath)</code>
<div class="block">Loads an TextDocument from the provided path.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.incubator.doc.text.OdfTextParagraph</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#newParagraph()">newParagraph</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>As of Simple version 0.5, replaced by
<code>Paragraph.newParagraph(ParagraphContainer)</code></i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.incubator.doc.text.OdfTextParagraph</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#newParagraph(java.lang.String)">newParagraph</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;text)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>As of Simple version 0.5, replaced by
<code>addParagraph(String text)</code></i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#newTextDocument()">newTextDocument</a></strong>()</code>
<div class="block">Creates an empty text document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#newTextDocument(org.odftoolkit.simple.TextDocument.OdfMediaType)">newTextDocument</a></strong>(<a href="../../../org/odftoolkit/simple/TextDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple">TextDocument.OdfMediaType</a>&nbsp;mimeType)</code>
<div class="block">Creates an empty text document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#newTextMasterDocument()">newTextMasterDocument</a></strong>()</code>
<div class="block">Creates an empty text master document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#newTextTemplateDocument()">newTextTemplateDocument</a></strong>()</code>
<div class="block">Creates an empty text template.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#newTextWebDocument()">newTextWebDocument</a></strong>()</code>
<div class="block">Creates an empty text web.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#removeForm(org.odftoolkit.simple.form.Form)">removeForm</a></strong>(<a href="../../../org/odftoolkit/simple/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</a>&nbsp;form)</code>
<div class="block">Remove a form with the specified name in this document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#removeList(org.odftoolkit.simple.text.list.List)">removeList</a></strong>(<a href="../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&nbsp;list)</code>
<div class="block">Remove the existing List from this container.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#removeParagraph(org.odftoolkit.simple.text.Paragraph)">removeParagraph</a></strong>(<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;para)</code>
<div class="block">Remove paragraph from this document</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#setApplyDesignMode(boolean)">setApplyDesignMode</a></strong>(boolean&nbsp;isDesignMode)</code>
<div class="block">Set the attribute <code>form:apply-design-mode</code> which specifies
whether forms are presented in editable or non-editable state.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#setAutomaticFocus(boolean)">setAutomaticFocus</a></strong>(boolean&nbsp;isAutoFocus)</code>
<div class="block">Set the attribute <code>form:automatic-focus</code> which specifies
whether the consumer loading the document should set the focus to a form
control.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/TextDocument.html#setPageColumns(int, double)">setPageColumns</a></strong>(int&nbsp;columnsNumber,
double&nbsp;spacing)</code>
<div class="block">Defines several columns to the page whose style is specified.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.odftoolkit.simple.Document">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.odftoolkit.simple.<a href="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</a></h3>
<code><a href="../../../org/odftoolkit/simple/Document.html#addTable()">addTable</a>, <a href="../../../org/odftoolkit/simple/Document.html#addTable(int, int)">addTable</a>, <a href="../../../org/odftoolkit/simple/Document.html#close()">close</a>, <a href="../../../org/odftoolkit/simple/Document.html#getComponentMap()">getComponentMap</a>, <a href="../../../org/odftoolkit/simple/Document.html#getContentRoot(java.lang.Class)">getContentRoot</a>, <a href="../../../org/odftoolkit/simple/Document.html#getEmbeddedDocument(java.lang.String)">getEmbeddedDocument</a>, <a href="../../../org/odftoolkit/simple/Document.html#getEmbeddedDocuments()">getEmbeddedDocuments</a>, <a href="../../../org/odftoolkit/simple/Document.html#getEmbeddedDocuments(org.odftoolkit.simple.Document.OdfMediaType)">getEmbeddedDocuments</a>, <a href="../../../org/odftoolkit/simple/Document.html#getLocale(org.odftoolkit.simple.Document.ScriptType)">getLocale</a>, <a href="../../../org/odftoolkit/simple/Document.html#getOdfMediaType()">getOdfMediaType</a>, <a href="../../../org/odftoolkit/simple/Document.html#getOfficeMetadata()">getOfficeMetadata</a>, <a href="../../../org/odftoolkit/simple/Document.html#getScriptType(java.util.Locale)">getScriptType</a>, <a href="../../../org/odftoolkit/simple/Document.html#getSectionByName(java.lang.String)">getSectionByName</a>, <a href="../../../org/odftoolkit/simple/Document.html#getSectionIterator()">getSectionIterator</a>, <a href="../../../org/odftoolkit/simple/Document.html#getTableBuilder()">getTableBuilder</a>, <a href="../../../org/odftoolkit/simple/Document.html#getTableByName(java.lang.String)">getTableByName</a>, <a href="../../../org/odftoolkit/simple/Document.html#getTableContainerImpl()">getTableContainerImpl</a>, <a href="../../../org/odftoolkit/simple/Document.html#getTableList()">getTableList</a>, <a href="../../../org/odftoolkit/simple/Document.html#insertDocument(org.odftoolkit.odfdom.pkg.OdfPackageDocument, java.lang.String)">insertDocument</a>, <a href="../../../org/odftoolkit/simple/Document.html#loadDocument(java.io.File, java.lang.String)">loadDocument</a>, <a href="../../../org/odftoolkit/simple/Document.html#loadDocument(org.odftoolkit.odfdom.pkg.OdfPackage)">loadDocument</a>, <a href="../../../org/odftoolkit/simple/Document.html#loadDocument(org.odftoolkit.odfdom.pkg.OdfPackage, java.lang.String)">loadDocument</a>, <a href="../../../org/odftoolkit/simple/Document.html#loadDocument(java.lang.String, java.lang.String)">loadDocument</a>, <a href="../../../org/odftoolkit/simple/Document.html#LoadTableTemplateFromForeignTable(java.io.InputStream, java.lang.String)">LoadTableTemplateFromForeignTable</a>, <a href="../../../org/odftoolkit/simple/Document.html#loadTemplate(org.odftoolkit.odfdom.pkg.OdfPackageDocument.Resource, org.odftoolkit.simple.Document.OdfMediaType)">loadTemplate</a>, <a href="../../../org/odftoolkit/simple/Document.html#newImage(java.net.URI)">newImage</a>, <a href="../../../org/odftoolkit/simple/Document.html#removeElementLinkedResource(org.odftoolkit.odfdom.pkg.OdfElement)">removeElementLinkedResource</a>, <a href="../../../org/odftoolkit/simple/Document.html#save(java.io.File)">save</a>, <a href="../../../org/odftoolkit/simple/Document.html#save(java.io.File, java.lang.String)">save</a>, <a href="../../../org/odftoolkit/simple/Document.html#save(java.io.OutputStream)">save</a>, <a href="../../../org/odftoolkit/simple/Document.html#setLocale(java.util.Locale)">setLocale</a>, <a href="../../../org/odftoolkit/simple/Document.html#setLocale(java.util.Locale, org.odftoolkit.simple.Document.ScriptType)">setLocale</a>, <a href="../../../org/odftoolkit/simple/Document.html#setOdfMediaType(org.odftoolkit.simple.Document.OdfMediaType)">setOdfMediaType</a>, <a href="../../../org/odftoolkit/simple/Document.html#setPassword(java.lang.String)">setPassword</a>, <a href="../../../org/odftoolkit/simple/Document.html#toString()">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.odftoolkit.odfdom.dom.OdfSchemaDocument">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.odftoolkit.odfdom.dom.OdfSchemaDocument</h3>
<code>getBaseURI, getBookmarkRDFMetadata, getContentDom, getContentStream, getDocumentStyles, getFileDom, getInContentMetadata, getInContentMetadataFromCache, getManifestRDFMetadata, getMasterPages, getMetaDom, getMetaStream, getOfficeMasterStyles, getOrCreateDocumentStyles, getRDFMetadata, getSettingsDom, getSettingsStream, getStylesDom, getStylesStream, getTables, getXMLFilePath</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.odftoolkit.odfdom.pkg.OdfPackageDocument">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.odftoolkit.odfdom.pkg.OdfPackageDocument</h3>
<code>flushDoms, getDocumentPath, getFileDom, getMediaTypeString, getPackage, getXMLFileMetadata, isExternalReference, isRootDocument, loadSubDocument, normalizeDocumentPath, removeDocument, save, setMediaTypeString</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#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="TextDocument(org.odftoolkit.odfdom.pkg.OdfPackage, java.lang.String, org.odftoolkit.simple.TextDocument.OdfMediaType)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TextDocument</h4>
<pre>protected&nbsp;TextDocument(org.odftoolkit.odfdom.pkg.OdfPackage&nbsp;pkg,
<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;internalPath,
<a href="../../../org/odftoolkit/simple/TextDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple">TextDocument.OdfMediaType</a>&nbsp;odfMediaType)</pre>
<div class="block">To avoid data duplication a new document is only created, if not already
opened. A document is cached by this constructor using the internalpath
as key.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="newTextDocument()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newTextDocument</h4>
<pre>public static&nbsp;<a href="../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a>&nbsp;newTextDocument()
throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Creates an empty text document.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>ODF text document based on a default template</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - - if the document could not be created</dd></dl>
</li>
</ul>
<a name="newTextDocument(org.odftoolkit.simple.TextDocument.OdfMediaType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newTextDocument</h4>
<pre>public static&nbsp;<a href="../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a>&nbsp;newTextDocument(<a href="../../../org/odftoolkit/simple/TextDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple">TextDocument.OdfMediaType</a>&nbsp;mimeType)
throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Creates an empty text document.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>ODF text document based on a default template</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - - if the document could not be created</dd></dl>
</li>
</ul>
<a name="newTextTemplateDocument()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newTextTemplateDocument</h4>
<pre>public static&nbsp;<a href="../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a>&nbsp;newTextTemplateDocument()
throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Creates an empty text template.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>ODF text template based on a default</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - - if the template could not be created</dd></dl>
</li>
</ul>
<a name="newTextMasterDocument()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newTextMasterDocument</h4>
<pre>public static&nbsp;<a href="../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a>&nbsp;newTextMasterDocument()
throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Creates an empty text master document.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>ODF text master based on a default</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - - if the document could not be created</dd></dl>
</li>
</ul>
<a name="newTextWebDocument()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newTextWebDocument</h4>
<pre>public static&nbsp;<a href="../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a>&nbsp;newTextWebDocument()
throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Creates an empty text web.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>ODF text web based on a default</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - - if the document could not be created</dd></dl>
</li>
</ul>
<a name="loadDocument(java.io.InputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadDocument</h4>
<pre>public static&nbsp;<a href="../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a>&nbsp;loadDocument(<a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;inputStream)
throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Creates an TextDocument from the OpenDocument provided by a resource
Stream.
<p>
Since an InputStream does not provide the arbitrary (non sequentiell)
read access needed by TextDocument, the InputStream is cached. This
usually takes more time compared to the other createInternalDocument
methods. An advantage of caching is that there are no problems
overwriting an input file.
</p>
<p>
If the resource stream is not a ODF text document, ClassCastException
might be thrown.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>inputStream</code> - - the InputStream of the ODF text document.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the text document created from the given InputStream</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - - if the document could not be created.</dd></dl>
</li>
</ul>
<a name="loadDocument(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadDocument</h4>
<pre>public static&nbsp;<a href="../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a>&nbsp;loadDocument(<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;documentPath)
throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Loads an TextDocument from the provided path.
<p>
TextDocument relies on the file being available for read access over the
whole lifecycle of TextDocument.
</p>
<p>
If the resource stream is not a ODF text document, ClassCastException
might be thrown.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>documentPath</code> - - the path from where the document can be loaded</dd>
<dt><span class="strong">Returns:</span></dt><dd>the text document from the given path or NULL if the media type
is not supported by SIMPLE.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - - if the document could not be created.</dd></dl>
</li>
</ul>
<a name="loadDocument(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadDocument</h4>
<pre>public static&nbsp;<a href="../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a>&nbsp;loadDocument(<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file)
throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Creates an TextDocument from the OpenDocument provided by a File.
<p>
TextDocument relies on the file being available for read access over the
whole lifecycle of TextDocument.
</p>
<p>
If the resource stream is not a ODF text document, ClassCastException
might be thrown.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - - a file representing the ODF text document.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the text document created from the given File</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - - if the document could not be created.</dd></dl>
</li>
</ul>
<a name="getContentRoot()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContentRoot</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.dom.element.office.OfficeTextElement&nbsp;getContentRoot()
throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Get the content root of a text document. Start here to get or create new
elements of a text document like paragraphs, headings, tables or lists.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/Document.html#getContentRoot()">getContentRoot</a></code>&nbsp;in class&nbsp;<code><a href="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>content root, representing the office:text tag</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the file DOM could not be created.</dd></dl>
</li>
</ul>
<a name="newParagraph(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newParagraph</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.incubator.doc.text.OdfTextParagraph&nbsp;newParagraph(<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;text)
throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>As of Simple version 0.5, replaced by
<code>addParagraph(String text)</code></i></div>
<div class="block">Creates a new paragraph and append text</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>text</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>the new paragraph</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the file DOM could not be created.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/odftoolkit/simple/TextDocument.html#addParagraph(java.lang.String)"><code>addParagraph(String)</code></a></dd></dl>
</li>
</ul>
<a name="newParagraph()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newParagraph</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.incubator.doc.text.OdfTextParagraph&nbsp;newParagraph()
throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>As of Simple version 0.5, replaced by
<code>Paragraph.newParagraph(ParagraphContainer)</code></i></div>
<div class="block">Creates a new paragraph</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The new paragraph</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the file DOM could not be created.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/odftoolkit/simple/text/Paragraph.html#newParagraph(org.odftoolkit.simple.text.ParagraphContainer)"><code>Paragraph.newParagraph(ParagraphContainer)</code></a>,
<a href="../../../org/odftoolkit/simple/TextDocument.html#addParagraph(java.lang.String)"><code>addParagraph(String)</code></a></dd></dl>
</li>
</ul>
<a name="addText(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addText</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.incubator.doc.text.OdfTextParagraph&nbsp;addText(<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;text)
throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>As of Simple version 0.5, replaced by
<code>Paragraph.appendTextContent(String content)</code></i></div>
<div class="block">Append text to the end of a text document. If there is no paragraph at
the end of a document, a new one will be created.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>text</code> - initial text for the paragraph.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The paragraph at the end of the text document, where the text has
been added to.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the file DOM could not be created.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/odftoolkit/simple/text/Paragraph.html#appendTextContent(java.lang.String)"><code>Paragraph.appendTextContent(String)</code></a>,
<a href="../../../org/odftoolkit/simple/text/Paragraph.html#appendTextContentNotCollapsed(java.lang.String)"><code>Paragraph.appendTextContentNotCollapsed(String)</code></a>,
<a href="../../../org/odftoolkit/simple/TextDocument.html#getParagraphByIndex(int, boolean)"><code>getParagraphByIndex(int, boolean)</code></a>,
<a href="../../../org/odftoolkit/simple/TextDocument.html#getParagraphByReverseIndex(int, boolean)"><code>getParagraphByReverseIndex(int, boolean)</code></a></dd></dl>
</li>
</ul>
<a name="changeMode(org.odftoolkit.simple.TextDocument.OdfMediaType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>changeMode</h4>
<pre>public&nbsp;void&nbsp;changeMode(<a href="../../../org/odftoolkit/simple/TextDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple">TextDocument.OdfMediaType</a>&nbsp;mediaType)</pre>
<div class="block">Changes the document to the given mediatype. This method can only be used
to convert a document to a related mediatype, e.g. template.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mediaType</code> - the related ODF mimetype</dd></dl>
</li>
</ul>
<a name="appendSection(org.odftoolkit.simple.text.Section, boolean)">
<!-- -->
</a>
<ul class="blockList">
<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="../../../org/odftoolkit/simple/text/Section.html" title="class in org.odftoolkit.simple.text">Section</a>&nbsp;section,
boolean&nbsp;isResourceCopied)</pre>
<div class="block">Copy a section and append it at the end of the text document, whether the
section is in this document or in a different document.
<p>
The IDs and names in this section would be changed to ensure unique.
<p>
If the section contains a linked resource, <code>isResourceCopied</code>
would specify whether the linked resource would be copied or not, when
the copy and append happens within a same document.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>section</code> - - the section object</dd><dd><code>isResourceCopied</code> - - whether the linked resource is copied or not.</dd></dl>
</li>
</ul>
<a name="appendSection(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<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 text document.</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>
<a name="getHeader()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeader</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/text/Header.html" title="class in org.odftoolkit.simple.text">Header</a>&nbsp;getHeader()</pre>
<div class="block">Get the Standard Page header of this text document.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the Standard Page header of this text document.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.4.5</dd></dl>
</li>
</ul>
<a name="getHeader(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeader</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/text/Header.html" title="class in org.odftoolkit.simple.text">Header</a>&nbsp;getHeader(boolean&nbsp;isFirstPage)</pre>
<div class="block">Get the header of this text document.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>isFirstPage</code> - if <code>isFirstPage</code> is true, return the First Page
header, otherwise return Standard Page header.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the header of this text document.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.5</dd></dl>
</li>
</ul>
<a name="getFooter()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFooter</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/text/Footer.html" title="class in org.odftoolkit.simple.text">Footer</a>&nbsp;getFooter()</pre>
<div class="block">Get the Standard Page footer of this text document.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the Standard Page footer of this text document.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.4.5</dd></dl>
</li>
</ul>
<a name="getFooter(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFooter</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/text/Footer.html" title="class in org.odftoolkit.simple.text">Footer</a>&nbsp;getFooter(boolean&nbsp;isFirstPage)</pre>
<div class="block">Get the footer of this text document.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>isFirstPage</code> - if <code>isFirstPage</code> is true, return the First Page
footer, otherwise return Standard Page footer.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the footer of this text document.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.5</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="getListContainerElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getListContainerElement</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.pkg.OdfElement&nbsp;getListContainerElement()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/text/list/ListContainer.html#getListContainerElement()">ListContainer</a></code></strong></div>
<div class="block">Get the ODF element which can have <text:list> as child
element directly according to ODF specification. This Element will help to find the
position to insert a new List. For example, <text:list> element is
usable with <office:text> element, so TextDocument will return
OfficeTextElement. While Presentation Notes is an indirectly
ListContainer, which holds List 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/text/list/ListContainer.html#getListContainerElement()">getListContainerElement</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>container element which can hold <text:list>.</dd></dl>
</li>
</ul>
<a name="addList()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addList</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&nbsp;addList()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/text/list/ListContainer.html#addList()">ListContainer</a></code></strong></div>
<div class="block">Add a new List to this container.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/text/list/ListContainer.html#addList()">addList</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>added list.</dd></dl>
</li>
</ul>
<a name="addList(org.odftoolkit.simple.text.list.ListDecorator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addList</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&nbsp;addList(<a href="../../../org/odftoolkit/simple/text/list/ListDecorator.html" title="interface in org.odftoolkit.simple.text.list">ListDecorator</a>&nbsp;decorator)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/text/list/ListContainer.html#addList(org.odftoolkit.simple.text.list.ListDecorator)">ListContainer</a></code></strong></div>
<div class="block">Add a List with specified ListDecorator to this container.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/text/list/ListContainer.html#addList(org.odftoolkit.simple.text.list.ListDecorator)">addList</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>decorator</code> - the specified ListDecorator</dd>
<dt><span class="strong">Returns:</span></dt><dd>added list.</dd></dl>
</li>
</ul>
<a name="clearList()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearList</h4>
<pre>public&nbsp;void&nbsp;clearList()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/text/list/ListContainer.html#clearList()">ListContainer</a></code></strong></div>
<div class="block">Remove all Lists from this container.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/text/list/ListContainer.html#clearList()">clearList</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a></code></dd>
</dl>
</li>
</ul>
<a name="getListIterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getListIterator</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&gt;&nbsp;getListIterator()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/text/list/ListContainer.html#getListIterator()">ListContainer</a></code></strong></div>
<div class="block">Return an Iterator of the Lists in this ListContainer. The Lists are
iterated in the same order that they occur in the ListContainer.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/text/list/ListContainer.html#getListIterator()">getListIterator</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>an Iterator of the Lists in this ListContainer</dd><dt><span class="strong">See Also:</span></dt><dd><a href="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a></dd></dl>
</li>
</ul>
<a name="removeList(org.odftoolkit.simple.text.list.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeList</h4>
<pre>public&nbsp;boolean&nbsp;removeList(<a href="../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&nbsp;list)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/text/list/ListContainer.html#removeList(org.odftoolkit.simple.text.list.List)">ListContainer</a></code></strong></div>
<div class="block">Remove the existing List from this container.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/text/list/ListContainer.html#removeList(org.odftoolkit.simple.text.list.List)">removeList</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>true, if the container contains this List.</dd></dl>
</li>
</ul>
<a name="addPageBreak()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPageBreak</h4>
<pre>public&nbsp;void&nbsp;addPageBreak()</pre>
<div class="block">Appends a new page break to this document.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>0.6.5</dd></dl>
</li>
</ul>
<a name="addPageBreak(org.odftoolkit.simple.text.Paragraph)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPageBreak</h4>
<pre>public&nbsp;void&nbsp;addPageBreak(<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;refParagraph)</pre>
<div class="block">Appends a new page break to this document after the reference paragraph.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>refParagraph</code> - the reference paragraph after where the page break inserted.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6.5</dd></dl>
</li>
</ul>
<a name="setPageColumns(int, double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPageColumns</h4>
<pre>public&nbsp;void&nbsp;setPageColumns(int&nbsp;columnsNumber,
double&nbsp;spacing)</pre>
<div class="block">Defines several columns to the page whose style is specified.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>columnsNumber</code> - the number of columns (are of width identical)</dd><dd><code>spacing</code> - column spacing in cm (ex. 2.40 for 2,4 cm)</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6.6</dd></dl>
</li>
</ul>
<a name="addColumnBreak()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addColumnBreak</h4>
<pre>public&nbsp;void&nbsp;addColumnBreak()</pre>
<div class="block">Appends a new column break to this document.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>0.6.6</dd></dl>
</li>
</ul>
<a name="addColumnBreak(org.odftoolkit.simple.text.Paragraph)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addColumnBreak</h4>
<pre>public&nbsp;void&nbsp;addColumnBreak(<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;refParagraph)</pre>
<div class="block">Appends a new column break to this document after the reference paragraph.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>refParagraph</code> - the reference paragraph after where the column break inserted.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6.6</dd></dl>
</li>
</ul>
<a name="addPageBreak(org.odftoolkit.simple.text.Paragraph, org.odftoolkit.simple.style.MasterPage)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPageBreak</h4>
<pre>public&nbsp;void&nbsp;addPageBreak(<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;refParagraph,
<a href="../../../org/odftoolkit/simple/style/MasterPage.html" title="class in org.odftoolkit.simple.style">MasterPage</a>&nbsp;master)</pre>
<div class="block">Appends a new page break to this document after the reference paragraph,
and the master page style will be applied to the new page.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>refParagraph</code> - the reference paragraph after where the page break inserted.</dd><dd><code>master</code> - the master page style applied to the new page.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.8</dd></dl>
</li>
</ul>
<a name="addParagraph(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addParagraph</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;addParagraph(<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;text)</pre>
<div class="block">Creates a new paragraph and append text.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/text/ParagraphContainer.html#addParagraph(java.lang.String)">addParagraph</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>text</code> - the text content of this paragraph</dd>
<dt><span class="strong">Returns:</span></dt><dd>the new paragraph</dd></dl>
</li>
</ul>
<a name="removeParagraph(org.odftoolkit.simple.text.Paragraph)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeParagraph</h4>
<pre>public&nbsp;boolean&nbsp;removeParagraph(<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;para)</pre>
<div class="block">Remove paragraph from this document</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/text/ParagraphContainer.html#removeParagraph(org.odftoolkit.simple.text.Paragraph)">removeParagraph</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>para</code> - the instance of paragraph</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the paragraph is removed successfully, false if errors
happen.</dd></dl>
</li>
</ul>
<a name="getParagraphContainerElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParagraphContainerElement</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.pkg.OdfElement&nbsp;getParagraphContainerElement()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/text/ParagraphContainer.html#getParagraphContainerElement()">ParagraphContainer</a></code></strong></div>
<div class="block">Get the ODF element which can have <text:p> as child element directly.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/text/ParagraphContainer.html#getParagraphContainerElement()">getParagraphContainerElement</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>- an ODF element which can have paragraph as child</dd></dl>
</li>
</ul>
<a name="getParagraphByIndex(int, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParagraphByIndex</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;getParagraphByIndex(int&nbsp;index,
boolean&nbsp;isEmptyParagraphSkipped)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/text/ParagraphContainer.html#getParagraphByIndex(int, boolean)">ParagraphContainer</a></code></strong></div>
<div class="block">Return a paragraph with a given index.
<p>
An index of zero represents the first paragraph.
<p>
If empty paragraph is skipped, the empty paragraph won't be counted.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/text/ParagraphContainer.html#getParagraphByIndex(int, boolean)">getParagraphByIndex</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - - the index started from 0.</dd><dd><code>isEmptyParagraphSkipped</code> - - whether the empty paragraph is skipped or not</dd>
<dt><span class="strong">Returns:</span></dt><dd>the paragraph with a given index</dd></dl>
</li>
</ul>
<a name="getParagraphByReverseIndex(int, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParagraphByReverseIndex</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;getParagraphByReverseIndex(int&nbsp;reverseIndex,
boolean&nbsp;isEmptyParagraphSkipped)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/text/ParagraphContainer.html#getParagraphByReverseIndex(int, boolean)">ParagraphContainer</a></code></strong></div>
<div class="block">Return a paragraph with a given index. The index is in reverse order.
<p>
An index of zero represents the last paragraph.
<p>
If empty paragraph is skipped, the empty paragraph won't be counted.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/text/ParagraphContainer.html#getParagraphByReverseIndex(int, boolean)">getParagraphByReverseIndex</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>reverseIndex</code> - - the index started from 0 in reverse order.</dd><dd><code>isEmptyParagraphSkipped</code> - - whether the empty paragraph is skipped or not</dd>
<dt><span class="strong">Returns:</span></dt><dd>the paragraph with a given index</dd></dl>
</li>
</ul>
<a name="getParagraphIterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParagraphIterator</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&gt;&nbsp;getParagraphIterator()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/text/ParagraphContainer.html#getParagraphIterator()">ParagraphContainer</a></code></strong></div>
<div class="block">Return an Iterator of the paragraph in this container.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/text/ParagraphContainer.html#getParagraphIterator()">getParagraphIterator</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>an Iterator of the paragraph in this container</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="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="createChart(java.lang.String, org.odftoolkit.simple.chart.DataSet, java.awt.Rectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createChart</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a>&nbsp;createChart(<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;title,
<a href="../../../org/odftoolkit/simple/chart/DataSet.html" title="class in org.odftoolkit.simple.chart">DataSet</a>&nbsp;dataset,
<a href="http://download.oracle.com/javase/6/docs/api/java/awt/Rectangle.html?is-external=true" title="class or interface in java.awt">Rectangle</a>&nbsp;rect)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#createChart(java.lang.String, org.odftoolkit.simple.chart.DataSet, java.awt.Rectangle)">ChartContainer</a></code></strong></div>
<div class="block">Creates a new Chart for this container.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#createChart(java.lang.String, org.odftoolkit.simple.chart.DataSet, java.awt.Rectangle)">createChart</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html" title="interface in org.odftoolkit.simple.chart">ChartContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>title</code> - chart title.</dd><dd><code>dataset</code> - chart data set.</dd><dd><code>rect</code> - chart rectangle.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the created chart.</dd></dl>
</li>
</ul>
<a name="createChart(java.lang.String, org.odftoolkit.simple.SpreadsheetDocument, org.odftoolkit.odfdom.type.CellRangeAddressList, boolean, boolean, boolean, java.awt.Rectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createChart</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a>&nbsp;createChart(<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;title,
<a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html" title="class in org.odftoolkit.simple">SpreadsheetDocument</a>&nbsp;document,
org.odftoolkit.odfdom.type.CellRangeAddressList&nbsp;cellRangeAddr,
boolean&nbsp;firstRowAsLabel,
boolean&nbsp;firstColumnAsLabel,
boolean&nbsp;rowAsDataSeries,
<a href="http://download.oracle.com/javase/6/docs/api/java/awt/Rectangle.html?is-external=true" title="class or interface in java.awt">Rectangle</a>&nbsp;rect)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#createChart(java.lang.String, org.odftoolkit.simple.SpreadsheetDocument, org.odftoolkit.odfdom.type.CellRangeAddressList, boolean, boolean, boolean, java.awt.Rectangle)">ChartContainer</a></code></strong></div>
<div class="block">Creates a new Chart for this container.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#createChart(java.lang.String, org.odftoolkit.simple.SpreadsheetDocument, org.odftoolkit.odfdom.type.CellRangeAddressList, boolean, boolean, boolean, java.awt.Rectangle)">createChart</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html" title="interface in org.odftoolkit.simple.chart">ChartContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>title</code> - chart title.</dd><dd><code>document</code> - the data source spreadsheet document.</dd><dd><code>cellRangeAddr</code> - the cell range address list which is used as chart data set.</dd><dd><code>firstRowAsLabel</code> - whether uses first row as label.</dd><dd><code>firstColumnAsLabel</code> - whether uses first column as label.</dd><dd><code>rowAsDataSeries</code> - whether uses data as series.</dd><dd><code>rect</code> - chart rectangle.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the created chart.</dd></dl>
</li>
</ul>
<a name="createChart(java.lang.String, java.lang.String[], java.lang.String[], double[][], java.awt.Rectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createChart</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a>&nbsp;createChart(<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;title,
<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;labels,
<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;legends,
double[][]&nbsp;data,
<a href="http://download.oracle.com/javase/6/docs/api/java/awt/Rectangle.html?is-external=true" title="class or interface in java.awt">Rectangle</a>&nbsp;rect)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#createChart(java.lang.String, java.lang.String[], java.lang.String[], double[][], java.awt.Rectangle)">ChartContainer</a></code></strong></div>
<div class="block">Creates a new Chart for this container.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#createChart(java.lang.String, java.lang.String[], java.lang.String[], double[][], java.awt.Rectangle)">createChart</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html" title="interface in org.odftoolkit.simple.chart">ChartContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>title</code> - chart rectangle.</dd><dd><code>labels</code> - label strings</dd><dd><code>legends</code> - legend strings</dd><dd><code>data</code> - chart data set.</dd><dd><code>rect</code> - chart rectangle.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the created chart.</dd></dl>
</li>
</ul>
<a name="deleteChartById(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteChartById</h4>
<pre>public&nbsp;void&nbsp;deleteChartById(<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;chartId)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#deleteChartById(java.lang.String)">ChartContainer</a></code></strong></div>
<div class="block">Deletes chart by chart id.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#deleteChartById(java.lang.String)">deleteChartById</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html" title="interface in org.odftoolkit.simple.chart">ChartContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>chartId</code> - the id of specified chart.</dd></dl>
</li>
</ul>
<a name="deleteChartByTitle(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteChartByTitle</h4>
<pre>public&nbsp;void&nbsp;deleteChartByTitle(<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;title)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#deleteChartByTitle(java.lang.String)">ChartContainer</a></code></strong></div>
<div class="block">Deletes chart(s) by chart title.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#deleteChartByTitle(java.lang.String)">deleteChartByTitle</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html" title="interface in org.odftoolkit.simple.chart">ChartContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>title</code> - the title of specified chart(s).</dd></dl>
</li>
</ul>
<a name="getChartById(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChartById</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a>&nbsp;getChartById(<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;chartId)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#getChartById(java.lang.String)">ChartContainer</a></code></strong></div>
<div class="block">Gets chart with specified id.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#getChartById(java.lang.String)">getChartById</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html" title="interface in org.odftoolkit.simple.chart">ChartContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>chartId</code> - the id of this chart.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the chart with specified id.</dd></dl>
</li>
</ul>
<a name="getChartByTitle(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChartByTitle</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/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a>&gt;&nbsp;getChartByTitle(<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;title)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#getChartByTitle(java.lang.String)">ChartContainer</a></code></strong></div>
<div class="block">Gets chart list with specified title.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#getChartByTitle(java.lang.String)">getChartByTitle</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html" title="interface in org.odftoolkit.simple.chart">ChartContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>title</code> - the title of specified chart(s).</dd>
<dt><span class="strong">Returns:</span></dt><dd>the chart(s) with specified title.</dd></dl>
</li>
</ul>
<a name="getChartCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChartCount</h4>
<pre>public&nbsp;int&nbsp;getChartCount()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#getChartCount()">ChartContainer</a></code></strong></div>
<div class="block">Returns the chart count of this container</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#getChartCount()">getChartCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html" title="interface in org.odftoolkit.simple.chart">ChartContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the chart count of this container</dd></dl>
</li>
</ul>
<a name="createDefaultTOC(org.odftoolkit.simple.text.Paragraph, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createDefaultTOC</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.dom.element.text.TextTableOfContentElement&nbsp;createDefaultTOC(<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;refParagraph,
boolean&nbsp;before)</pre>
<div class="block">Create a new Table Of Content to this document before the reference
paragraph. Because until you do a full layout of the document, taking
into account font metrics,line breaking algorithms, hyphenation, image
positioning, "orphan and widow" rules, etc., you don't know what content
is on which page. So all the page numbers in TOC are be set value "1".
Please update the page numbers from AOO Menus: Tools->Update->All Indexes
and Tables</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>refParagraph</code> - the reference paragraph where the TOC be inserted.</dd><dd><code>before</code> - true:insert TOC before the reference paragraph. false:insert
TOC after the reference paragraph.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.8.6</dd></dl>
</li>
</ul>
<a name="createTOCwithStyle(org.odftoolkit.simple.text.Paragraph, org.odftoolkit.simple.style.TOCStyle, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTOCwithStyle</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.dom.element.text.TextTableOfContentElement&nbsp;createTOCwithStyle(<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;refParagraph,
<a href="../../../org/odftoolkit/simple/style/TOCStyle.html" title="class in org.odftoolkit.simple.style">TOCStyle</a>&nbsp;additionalStyle,
boolean&nbsp;before)</pre>
<div class="block">Create a new Table Of Content to this document before the reference
paragraph. The additional paragraph styles list will be included in the
TOC. Because until you do a full layout of the document, taking into
account font metrics,line breaking algorithms, hyphenation, image
positioning, "orphan and widow" rules, etc., you don't know what content
is on which page. So all the page numbers in TOC are be set value "1".
Please update the page numbers from AOO Menus: Tools->Update->All Indexes
and Tables. If additionalStyle is null then call createDefaultTOC().</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>refParagraph</code> - the reference paragraph before where the TOC inserted.</dd><dd><code>additionalStyle</code> - the additional paragraph styles that you want to include in
the TOC</dd><dd><code>before</code> - true:insert TOC before the reference paragraph.
false:insert TOC after the reference paragraph.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.8.6</dd></dl>
</li>
</ul>
<a name="insertParagraph(org.odftoolkit.simple.text.Paragraph, org.odftoolkit.simple.text.Paragraph, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>insertParagraph</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;insertParagraph(<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;referenceParagraph,
<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;sourceParagraph,
boolean&nbsp;before)</pre>
<div class="block">Copy a Paragraph and insert it before or after the Reference Paragraph in the text document, whether the
Paragraph is in this document or in a different document.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>referenceParagraph</code> - - where the Paragraph be inserted</dd><dd><code>sourceParagraph</code> - - the Paragraph which will be copied</dd><dd><code>before</code> - true:insert Paragraph before the reference paragraph.
false:insert Paragraph after the reference paragraph.</dd></dl>
</li>
</ul>
<a name="insertTable(org.odftoolkit.simple.text.Paragraph, org.odftoolkit.simple.table.Table, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>insertTable</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>&nbsp;insertTable(<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;referenceParagraph,
<a href="../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>&nbsp;sourceTable,
boolean&nbsp;before)</pre>
<div class="block">Copy a Table and insert it before or after the Reference Paragraph in the text document, whether the
Table is in this TextDocument or in a different Document.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>referenceParagraph</code> - - where the Paragraph be inserted</dd><dd><code>sourceParagraph</code> - - the Paragraph which will be copied</dd><dd><code>before</code> - true:insert Paragraph before the reference paragraph.
false:insert Paragraph after the reference paragraph.</dd></dl>
</li>
</ul>
<a name="insertOdfElement(org.odftoolkit.odfdom.pkg.OdfElement, org.odftoolkit.simple.Document, org.odftoolkit.odfdom.pkg.OdfElement, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>insertOdfElement</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.pkg.OdfElement&nbsp;insertOdfElement(org.odftoolkit.odfdom.pkg.OdfElement&nbsp;referenceOdfElement,
<a href="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</a>&nbsp;sourceDocument,
org.odftoolkit.odfdom.pkg.OdfElement&nbsp;sourceOdfElement,
boolean&nbsp;before)</pre>
<div class="block">Copy a OdfElement and insert it before or after the Reference OdfElement in the TextDocument, whether the
OdfElement is in this TextDocument or in a different Document.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>referenceOdfElement</code> - - where the OdfElement be inserted</dd><dd><code>sourceDocument</code> - - the source Document which contain the sourceOdfElement</dd><dd><code>sourceOdfElement</code> - - the OdfElement which will be copied</dd><dd><code>before</code> - true:insert OdfElement before the reference OdfElement.
false:insert OdfElement after the reference OdfElement.</dd></dl>
</li>
</ul>
<a name="insertContentFromDocumentAfter(org.odftoolkit.simple.TextDocument, org.odftoolkit.simple.text.Paragraph, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>insertContentFromDocumentAfter</h4>
<pre>public&nbsp;void&nbsp;insertContentFromDocumentAfter(<a href="../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a>&nbsp;sourceDocument,
<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;referenceParagraph,
boolean&nbsp;isCopyStyle)</pre>
<div class="block">Copy text content of the source TextDocument and insert it to the current TextDocument
after the reference Paragraph, with Styles or without Styles.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sourceDocument</code> - the source TextDocument</dd><dd><code>referenceParagraph</code> - where the text content of the source TextDocument be inserted</dd><dd><code>isCopyStyle</code> - true:copy the styles in source document to current TextDocment.
false:don't copy the styles in source document to current TextDocment.</dd></dl>
</li>
</ul>
<a name="insertContentFromDocumentBefore(org.odftoolkit.simple.TextDocument, org.odftoolkit.simple.text.Paragraph, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>insertContentFromDocumentBefore</h4>
<pre>public&nbsp;void&nbsp;insertContentFromDocumentBefore(<a href="../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a>&nbsp;sourceDocument,
<a href="../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;referenceParagraph,
boolean&nbsp;isCopyStyle)</pre>
<div class="block">Copy text content of the source TextDocument and insert it to the current TextDocument
before the reference Paragraph, with Styles or without Styles.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>srcDoc</code> - the source TextDocument</dd><dd><code>referenceParagraph</code> - where the text content of the source TextDocument be inserted</dd><dd><code>isCopyStyle</code> - true:copy the styles in source document to current TextDocment.
false:don't copy the styles in source document to current TextDocment.</dd></dl>
</li>
</ul>
<a name="createForm(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createForm</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</a>&nbsp;createForm(<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 a form with specified name in this text document.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/form/FormContainer.html#createForm(java.lang.String)">createForm</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - - form name, represents attribute <code>form:name</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>an instance of Form</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/odftoolkit/simple/form/FormContainer.html#createForm(java.lang.String)"><code>FormContainer.createForm(String)</code></a></dd></dl>
</li>
</ul>
<a name="getFormIterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormIterator</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../org/odftoolkit/simple/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</a>&gt;&nbsp;getFormIterator()</pre>
<div class="block">Get a form iterator to traverse all the forms in this document.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/form/FormContainer.html#getFormIterator()">getFormIterator</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>form iterator</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/odftoolkit/simple/form/FormContainer.html#getFormIterator()"><code>FormContainer.getFormIterator()</code></a></dd></dl>
</li>
</ul>
<a name="removeForm(org.odftoolkit.simple.form.Form)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeForm</h4>
<pre>public&nbsp;boolean&nbsp;removeForm(<a href="../../../org/odftoolkit/simple/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</a>&nbsp;form)</pre>
<div class="block">Remove a form with the specified name in this document.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/form/FormContainer.html#removeForm(org.odftoolkit.simple.form.Form)">removeForm</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>form</code> - - the form to be removed</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the form is removed successfully, false if errors happen.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/odftoolkit/simple/form/FormContainer.html#removeForm(org.odftoolkit.simple.form.Form)"><code>FormContainer.removeForm(Form)</code></a></dd></dl>
</li>
</ul>
<a name="getFormByName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormByName</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</a>&nbsp;getFormByName(<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/form/FormContainer.html#getFormByName(java.lang.String)">FormContainer</a></code></strong></div>
<div class="block">Return a form whose name is a given value.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/form/FormContainer.html#getFormByName(java.lang.String)">getFormByName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - - the name of the form</dd>
<dt><span class="strong">Returns:</span></dt><dd>a form whose name is a given value</dd></dl>
</li>
</ul>
<a name="getFormContainerElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormContainerElement</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.dom.element.office.OfficeFormsElement&nbsp;getFormContainerElement()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/form/FormContainer.html#getFormContainerElement()">FormContainer</a></code></strong></div>
<div class="block">Get the ODF element <code>OfficeFormsElement</code> which can have
<code>FormFormElement</code> as child element directly according to ODF
specification. This element will help to find the position to insert a
new <code>FormFormElement</code> element.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/form/FormContainer.html#getFormContainerElement()">getFormContainerElement</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the element of office:forms</dd></dl>
</li>
</ul>
<a name="getApplyDesignMode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getApplyDesignMode</h4>
<pre>public&nbsp;boolean&nbsp;getApplyDesignMode()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/form/FormContainer.html#getApplyDesignMode()">FormContainer</a></code></strong></div>
<div class="block">Get the attribute <code>form:apply-design-mode</code> which specifies
whether forms are presented in editable or non-editable state.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/form/FormContainer.html#getApplyDesignMode()">getApplyDesignMode</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>true if forms in document are presented in editable state;false
if forms in document are presented in completed state</dd></dl>
</li>
</ul>
<a name="getAutomaticFocus()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAutomaticFocus</h4>
<pre>public&nbsp;boolean&nbsp;getAutomaticFocus()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/form/FormContainer.html#getAutomaticFocus()">FormContainer</a></code></strong></div>
<div class="block">Get the attribute <code>form:automatic-focus</code> which specifies
whether the consumer loading the document should set the focus to a form
control.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/form/FormContainer.html#getAutomaticFocus()">getAutomaticFocus</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>true if sets the focus to a form control after loading the
document; false if else.</dd></dl>
</li>
</ul>
<a name="setApplyDesignMode(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setApplyDesignMode</h4>
<pre>public&nbsp;void&nbsp;setApplyDesignMode(boolean&nbsp;isDesignMode)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/form/FormContainer.html#setApplyDesignMode(boolean)">FormContainer</a></code></strong></div>
<div class="block">Set the attribute <code>form:apply-design-mode</code> which specifies
whether forms are presented in editable or non-editable state.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/form/FormContainer.html#setApplyDesignMode(boolean)">setApplyDesignMode</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>isDesignMode</code> - - true if forms in document are presented in editable state;
false if forms in document are presented in completed state</dd></dl>
</li>
</ul>
<a name="setAutomaticFocus(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAutomaticFocus</h4>
<pre>public&nbsp;void&nbsp;setAutomaticFocus(boolean&nbsp;isAutoFocus)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/form/FormContainer.html#setAutomaticFocus(boolean)">FormContainer</a></code></strong></div>
<div class="block">Set the attribute <code>form:automatic-focus</code> which specifies
whether the consumer loading the document should set the focus to a form
control.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/form/FormContainer.html#setAutomaticFocus(boolean)">setAutomaticFocus</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/form/FormContainer.html" title="interface in org.odftoolkit.simple.form">FormContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>isAutoFocus</code> - -true if sets the focus to a form control after loading the
document; false if else.</dd></dl>
</li>
</ul>
<a name="createDrawControl()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createDrawControl</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/draw/Control.html" title="class in org.odftoolkit.simple.draw">Control</a>&nbsp;createDrawControl()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/draw/ControlContainer.html#createDrawControl()">ControlContainer</a></code></strong></div>
<div class="block">Create an instance of control and and append it at the end of this
container.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/draw/ControlContainer.html#createDrawControl()">createDrawControl</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/draw/ControlContainer.html" title="interface in org.odftoolkit.simple.draw">ControlContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a control instance</dd></dl>
</li>
</ul>
<a name="getDrawControlContainerElement()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDrawControlContainerElement</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.pkg.OdfElement&nbsp;getDrawControlContainerElement()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/draw/ControlContainer.html#getDrawControlContainerElement()">ControlContainer</a></code></strong></div>
<div class="block">Get the ODF element which can have DrawControlElement as child element
directly.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/draw/ControlContainer.html#getDrawControlContainerElement()">getDrawControlContainerElement</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/draw/ControlContainer.html" title="interface in org.odftoolkit.simple.draw">ControlContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>- an ODF element which can have control as child</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/TextDocument.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/SpreadsheetDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/odftoolkit/simple/TextDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/odftoolkit/simple/TextDocument.html" target="_top">Frames</a></li>
<li><a href="TextDocument.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><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields_inherited_from_class_org.odftoolkit.odfdom.dom.OdfSchemaDocument">Field</a>&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>