Google Git
Sign in
apache / incubator-odftoolkit-site / d22ef2d53769a0a209d42b84c8275ad1d8522260 / . / content / odftoolkit / mvn-site / 0.8-incubating / simple-odf / apidocs / org / odftoolkit / simple / text / Paragraph.html
blob: e277a31918f7eb1654d2eb49b8607e1f168f0386 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Fri Feb 22 10:35:17 CET 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Paragraph (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="Paragraph (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/Paragraph.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/odftoolkit/simple/text/Header.html" title="class in org.odftoolkit.simple.text"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/text/Paragraph.html" target="_top">Frames</a></li>
<li><a href="Paragraph.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.odftoolkit.simple.text</div>
<h2 title="Class Paragraph" class="title">Class Paragraph</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">org.odftoolkit.simple.Component</a></li>
<li>
<ul class="inheritance">
<li>org.odftoolkit.simple.text.Paragraph</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/odftoolkit/simple/draw/ControlContainer.html" title="interface in org.odftoolkit.simple.draw">ControlContainer</a>, <a href="../../../../org/odftoolkit/simple/draw/FrameContainer.html" title="interface in org.odftoolkit.simple.draw">FrameContainer</a>, <a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.html" title="interface in org.odftoolkit.simple.draw">TextboxContainer</a>, <a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html" title="interface in org.odftoolkit.simple.text">TextHyperlinkContainer</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">Paragraph</span>
extends <a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a>
implements <a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.html" title="interface in org.odftoolkit.simple.draw">TextboxContainer</a>, <a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html" title="interface in org.odftoolkit.simple.text">TextHyperlinkContainer</a>, <a href="../../../../org/odftoolkit/simple/draw/ControlContainer.html" title="interface in org.odftoolkit.simple.draw">ControlContainer</a></pre>
<div class="block">This class presents paragraph element in ODF document. It provides methods to
manipulate text content, and other child component under the paragraph.
Headings and body text paragraphs are collectively referred to as paragraph
elements.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>0.5</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&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/text/Paragraph.html#addComment(java.lang.String, java.lang.String)">addComment</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;content,
<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;creator)</code>
<div class="block">Creates a comment in the front of this paragraph.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/draw/Textbox.html" title="class in org.odftoolkit.simple.draw">Textbox</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#addTextbox()">addTextbox</a></strong>()</code>
<div class="block">Add a text box</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/draw/Textbox.html" title="class in org.odftoolkit.simple.draw">Textbox</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#addTextbox(org.odftoolkit.simple.draw.FrameRectangle)">addTextbox</a></strong>(<a href="../../../../org/odftoolkit/simple/draw/FrameRectangle.html" title="class in org.odftoolkit.simple.draw">FrameRectangle</a>&nbsp;position)</code>
<div class="block">Add a text box with a specific size at a specific position</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/text/TextHyperlink.html" title="class in org.odftoolkit.simple.text">TextHyperlink</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#appendHyperlink(java.lang.String, java.net.URI)">appendHyperlink</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,
<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&nbsp;linkto)</code>
<div class="block">Append a hyperlink at the end of the container</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#appendTextContent(java.lang.String)">appendTextContent</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;content)</code>
<div class="block">Append the text content at the end of this paragraph.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#appendTextContent(java.lang.String, boolean)">appendTextContent</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;content,
boolean&nbsp;isStyleInherited)</code>
<div class="block">Append the text content at the end of this paragraph.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#appendTextContentNotCollapsed(java.lang.String)">appendTextContentNotCollapsed</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;content)</code>
<div class="block">Append the text content at the end of this paragraph.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#applyHeading()">applyHeading</a></strong>()</code>
<div class="block">Formats the paragraph as heading.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#applyHeading(boolean, int)">applyHeading</a></strong>(boolean&nbsp;isHeading,
int&nbsp;level)</code>
<div class="block">Sets the paragraph type, heading or body text paragraph.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/text/TextHyperlink.html" title="class in org.odftoolkit.simple.text">TextHyperlink</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#applyHyperlink(java.net.URI)">applyHyperlink</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&nbsp;linkto)</code>
<div class="block">Hyperlink support</div>
</td>
</tr>
<tr class="altColor">
<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/text/Paragraph.html#createDrawControl()">createDrawControl</a></strong>()</code>
<div class="block">End of Hyperlink support</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.pkg.OdfElement</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.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/style/Font.html" title="class in org.odftoolkit.simple.style">Font</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#getFont()">getFont</a></strong>()</code>
<div class="block">Returns the font definition for this paragraph.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.pkg.OdfElement</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#getFrameContainerElement()">getFrameContainerElement</a></strong>()</code>
<div class="block">Get the ODF element which can have <draw:frame> as child element directly
according to ODF specification.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#getHeadingLevel()">getHeadingLevel</a></strong>()</code>
<div class="block">Returns outline level of this paragraph.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.HorizontalAlignmentType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.HorizontalAlignmentType</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#getHorizontalAlignment()">getHorizontalAlignment</a></strong>()</code>
<div class="block">Return the horizontal alignment setting of this paragraph.</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/TextHyperlink.html" title="class in org.odftoolkit.simple.text">TextHyperlink</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#getHyperlinkIterator()">getHyperlinkIterator</a></strong>()</code>
<div class="block">Get the iterator of hyperlinks within this container element</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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/text/Paragraph.html#getInstanceof(org.odftoolkit.odfdom.dom.element.text.TextParagraphElementBase)">getInstanceof</a></strong>(org.odftoolkit.odfdom.dom.element.text.TextParagraphElementBase&nbsp;paragraphElement)</code>
<div class="block">Gets a paragraph instance by an instance of
<code>TextParagraphElementBase</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.dom.element.text.TextParagraphElementBase</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#getOdfElement()">getOdfElement</a></strong>()</code>
<div class="block">Return the <code>TextParagraphElementBase</code> of this paragraph.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#getOwnerDocument()">getOwnerDocument</a></strong>()</code>
<div class="block">Get the owner document of this paragraph.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/text/ParagraphStyleHandler.html" title="class in org.odftoolkit.simple.text">ParagraphStyleHandler</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#getStyleHandler()">getStyleHandler</a></strong>()</code>
<div class="block">Get the style handler of this paragraph.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#getStyleName()">getStyleName</a></strong>()</code>
<div class="block">Get the style name of this paragraph</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/draw/Textbox.html" title="class in org.odftoolkit.simple.draw">Textbox</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#getTextboxByName(java.lang.String)">getTextboxByName</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 text box whose name is a given value.</div>
</td>
</tr>
<tr class="rowColor">
<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/draw/Textbox.html" title="class in org.odftoolkit.simple.draw">Textbox</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#getTextboxByUsage(org.odftoolkit.simple.PresentationDocument.PresentationClass)">getTextboxByUsage</a></strong>(<a href="../../../../org/odftoolkit/simple/PresentationDocument.PresentationClass.html" title="enum in org.odftoolkit.simple">PresentationDocument.PresentationClass</a>&nbsp;usage)</code>
<div class="block">This method is only useful in presentation slide.</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/draw/Textbox.html" title="class in org.odftoolkit.simple.draw">Textbox</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#getTextboxIterator()">getTextboxIterator</a></strong>()</code>
<div class="block">Return an Iterator of the text objects in this container.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#getTextContent()">getTextContent</a></strong>()</code>
<div class="block">Return the text content of this paragraph.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#isHeading()">isHeading</a></strong>()</code>
<div class="block">Returns the paragraph type, heading or body text paragraph.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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/text/Paragraph.html#newParagraph(org.odftoolkit.simple.text.ParagraphContainer)">newParagraph</a></strong>(<a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</a>&nbsp;container)</code>
<div class="block">Create an instance of paragraph
The paragrah will be added at the end of 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/text/Paragraph.html#remove()">remove</a></strong>()</code>
<div class="block">Remove this paragraph from its container.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#removeHyperlinks()">removeHyperlinks</a></strong>()</code>
<div class="block">Remove all the hyperlinks in this container element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#removeTextbox(org.odftoolkit.simple.draw.Textbox)">removeTextbox</a></strong>(<a href="../../../../org/odftoolkit/simple/draw/Textbox.html" title="class in org.odftoolkit.simple.draw">Textbox</a>&nbsp;box)</code>
<div class="block">Remove the text box</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#removeTextContent()">removeTextContent</a></strong>()</code>
<div class="block">Remove the text content of this paragraph.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#setFont(org.odftoolkit.simple.style.Font)">setFont</a></strong>(<a href="../../../../org/odftoolkit/simple/style/Font.html" title="class in org.odftoolkit.simple.style">Font</a>&nbsp;font)</code>
<div class="block">Sets font style for this paragraph.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#setHorizontalAlignment(org.odftoolkit.simple.style.StyleTypeDefinitions.HorizontalAlignmentType)">setHorizontalAlignment</a></strong>(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.HorizontalAlignmentType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.HorizontalAlignmentType</a>&nbsp;alignType)</code>
<div class="block">Set the horizontal alignment setting of this paragraph.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#setStyleName(java.lang.String)">setStyleName</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;styleName)</code>
<div class="block">Set the style name of this paragraph</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#setTextContent(java.lang.String)">setTextContent</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;content)</code>
<div class="block">Set the text content of this paragraph.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#setTextContentNotCollapsed(java.lang.String)">setTextContentNotCollapsed</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;content)</code>
<div class="block">Set the text content of this paragraph.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.odftoolkit.simple.Component">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.odftoolkit.simple.<a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a></h3>
<code><a href="../../../../org/odftoolkit/simple/Component.html#getComponentByElement(org.odftoolkit.odfdom.pkg.OdfElement)">getComponentByElement</a>, <a href="../../../../org/odftoolkit/simple/Component.html#registerComponent(org.odftoolkit.simple.Component, org.odftoolkit.odfdom.pkg.OdfElement)">registerComponent</a>, <a href="../../../../org/odftoolkit/simple/Component.html#unregisterComponent(org.odftoolkit.odfdom.pkg.OdfElement)">unregisterComponent</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getInstanceof(org.odftoolkit.odfdom.dom.element.text.TextParagraphElementBase)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstanceof</h4>
<pre>public static&nbsp;<a href="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;getInstanceof(org.odftoolkit.odfdom.dom.element.text.TextParagraphElementBase&nbsp;paragraphElement)</pre>
<div class="block">Gets a paragraph instance by an instance of
<code>TextParagraphElementBase</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>paragraphElement</code> - the instance of TextParagraphElementBase.</dd>
<dt><span class="strong">Returns:</span></dt><dd>an instance of paragraph.</dd></dl>
</li>
</ul>
<a name="newParagraph(org.odftoolkit.simple.text.ParagraphContainer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newParagraph</h4>
<pre>public static&nbsp;<a href="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>&nbsp;newParagraph(<a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</a>&nbsp;container)</pre>
<div class="block">Create an instance of paragraph
<p>
The paragrah will be added at the end of this container.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>container</code> - the paragraph container that contains this paragraph.</dd></dl>
</li>
</ul>
<a name="setTextContent(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTextContent</h4>
<pre>public&nbsp;void&nbsp;setTextContent(<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;content)</pre>
<div class="block">Set the text content of this paragraph.
<p>
All the existing text content of this paragraph would be removed, and
then new text content would be set. The style of the last character will
be inherited.
<p>
The white space characters in the content would be collapsed by default.
For example, tab character would be replaced with <text:tab>, break line
character would be replaced with <text:line-break>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>content</code> - - the text content</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#setTextContentNotCollapsed(java.lang.String)"><code>setTextContentNotCollapsed(String content)</code></a></dd></dl>
</li>
</ul>
<a name="removeTextContent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeTextContent</h4>
<pre>public&nbsp;void&nbsp;removeTextContent()</pre>
<div class="block">Remove the text content of this paragraph. The empty hyperlink element
will be removed.
<p>
The other child elements except text content will not be removed.</div>
</li>
</ul>
<a name="getTextContent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTextContent</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getTextContent()</pre>
<div class="block">Return the text content of this paragraph.
<p>
The other child elements except text content will not be returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>- the text content of this paragraph</dd></dl>
</li>
</ul>
<a name="setTextContentNotCollapsed(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTextContentNotCollapsed</h4>
<pre>public&nbsp;void&nbsp;setTextContentNotCollapsed(<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;content)</pre>
<div class="block">Set the text content of this paragraph.
<p>
All the existing text content of this paragraph would be removed, and
then new text content would be set.
<p>
The white space characters in the content would not be collapsed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>content</code> - - the text content</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#setTextContent(java.lang.String)"><code>setTextContent(String content)</code></a></dd></dl>
</li>
</ul>
<a name="appendTextContent(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendTextContent</h4>
<pre>public&nbsp;void&nbsp;appendTextContent(<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;content)</pre>
<div class="block">Append the text content at the end of this paragraph. The appended text
would follow the style of the last character.
<p>
The white space characters in the content would be collapsed by default.
For example, tab character would be replaced with <text:tab>, break line
character would be replaced with <text:line-break>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>content</code> - - the text content</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#appendTextContentNotCollapsed(java.lang.String)"><code>appendTextContentNotCollapsed(String content)</code></a></dd></dl>
</li>
</ul>
<a name="appendTextContent(java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendTextContent</h4>
<pre>public&nbsp;void&nbsp;appendTextContent(<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;content,
boolean&nbsp;isStyleInherited)</pre>
<div class="block">Append the text content at the end of this paragraph. The appended text
would follow the style of the last character if the second parameter is
set to true; Or else, the appended text would follow the default style of
this paragraph.
<p>
The white space characters in the content would be collapsed by default.
For example, tab character would be replaced with <text:tab>, break line
character would be replaced with <text:line-break>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>content</code> - - the text content</dd><dd><code>isStyleInherited</code> - - whether the style would be inherited by the appended text</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#appendTextContentNotCollapsed(java.lang.String)"><code>appendTextContentNotCollapsed(String content)</code></a></dd></dl>
</li>
</ul>
<a name="appendTextContentNotCollapsed(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendTextContentNotCollapsed</h4>
<pre>public&nbsp;void&nbsp;appendTextContentNotCollapsed(<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;content)</pre>
<div class="block">Append the text content at the end of this paragraph. The appended text
would follow the style of the last character.
<p>
The white space characters in the content would not be collapsed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>content</code> - - the text content</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/simple/text/Paragraph.html#appendTextContent(java.lang.String)"><code>appendTextContent(String content)</code></a></dd></dl>
</li>
</ul>
<a name="setStyleName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStyleName</h4>
<pre>public&nbsp;void&nbsp;setStyleName(<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;styleName)</pre>
<div class="block">Set the style name of this paragraph</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>styleName</code> - - the style name</dd></dl>
</li>
</ul>
<a name="getStyleName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStyleName</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getStyleName()</pre>
<div class="block">Get the style name of this paragraph</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>- the style name</dd></dl>
</li>
</ul>
<a name="getOwnerDocument()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOwnerDocument</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</a>&nbsp;getOwnerDocument()</pre>
<div class="block">Get the owner document of this paragraph.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/Component.html#getOwnerDocument()">getOwnerDocument</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the document who owns this paragraph.</dd></dl>
</li>
</ul>
<a name="remove()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>public&nbsp;void&nbsp;remove()</pre>
<div class="block">Remove this paragraph from its container.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>0.6.5</dd></dl>
</li>
</ul>
<a name="getStyleHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStyleHandler</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/text/ParagraphStyleHandler.html" title="class in org.odftoolkit.simple.text">ParagraphStyleHandler</a>&nbsp;getStyleHandler()</pre>
<div class="block">Get the style handler of this paragraph.
<p>
The style handler is an instance of ParagraphStyleHandler</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an instance of ParagraphStyleHandler</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/simple/text/ParagraphStyleHandler.html" title="class in org.odftoolkit.simple.text"><code>ParagraphStyleHandler</code></a></dd></dl>
</li>
</ul>
<a name="getOdfElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOdfElement</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.dom.element.text.TextParagraphElementBase&nbsp;getOdfElement()</pre>
<div class="block">Return the <code>TextParagraphElementBase</code> of this paragraph.
Headings and body text paragraphs are collectively referred to as
paragraph elements, so the <code>TextParagraphElementBase</code> can be
<code>TextHElement</code> element or <code>TextPElement</code> element.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/Component.html#getOdfElement()">getOdfElement</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the <code>TextParagraphElementBase</code> of this paragraph.</dd></dl>
</li>
</ul>
<a name="addComment(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addComment</h4>
<pre>public&nbsp;void&nbsp;addComment(<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;content,
<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;creator)</pre>
<div class="block">Creates a comment in the front of this paragraph.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>content</code> - the content of this comment.</dd><dd><code>creator</code> - the creator of this comment, if <code>creator</code> is null,
the value of <code>System.getProperty("user.name")</code> will
be used.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6.5</dd></dl>
</li>
</ul>
<a name="isHeading()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isHeading</h4>
<pre>public&nbsp;boolean&nbsp;isHeading()</pre>
<div class="block">Returns the paragraph type, heading or body text paragraph.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the paragraph type, if this paragraph is heading, returns
<code>true</code>, otherwise return <code>false</code>.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6.5</dd></dl>
</li>
</ul>
<a name="getHeadingLevel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeadingLevel</h4>
<pre>public&nbsp;int&nbsp;getHeadingLevel()</pre>
<div class="block">Returns outline level of this paragraph.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>outline level, if this paragraph is a body text paragraph, 0 will
be returned.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6.5</dd></dl>
</li>
</ul>
<a name="applyHeading(boolean, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applyHeading</h4>
<pre>public&nbsp;void&nbsp;applyHeading(boolean&nbsp;isHeading,
int&nbsp;level)</pre>
<div class="block">Sets the paragraph type, heading or body text paragraph.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>isHeading</code> - if <code>true</code>, this paragraph would be formatted as
heading, otherwise as a body text paragraph.</dd><dd><code>level</code> - the heading outline level of this paragraph, if
<code>isHeading</code> is <code>true</code>.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6.5</dd></dl>
</li>
</ul>
<a name="applyHeading()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applyHeading</h4>
<pre>public&nbsp;void&nbsp;applyHeading()</pre>
<div class="block">Formats the paragraph as heading. Its outline level is 1.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>0.6.5</dd></dl>
</li>
</ul>
<a name="getFont()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFont</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/style/Font.html" title="class in org.odftoolkit.simple.style">Font</a>&nbsp;getFont()</pre>
<div class="block">Returns the font definition for this paragraph.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>font if there is no style definition for this paragraph,
<code>null</code> will be returned.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6.5</dd></dl>
</li>
</ul>
<a name="setFont(org.odftoolkit.simple.style.Font)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFont</h4>
<pre>public&nbsp;void&nbsp;setFont(<a href="../../../../org/odftoolkit/simple/style/Font.html" title="class in org.odftoolkit.simple.style">Font</a>&nbsp;font)</pre>
<div class="block">Sets font style for this paragraph.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>font</code> - the font definition of this paragraph</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6.5</dd></dl>
</li>
</ul>
<a name="getHorizontalAlignment()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHorizontalAlignment</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.HorizontalAlignmentType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.HorizontalAlignmentType</a>&nbsp;getHorizontalAlignment()</pre>
<div class="block">Return the horizontal alignment setting of this paragraph.
<p>
Null will returned if there is no explicit style definition for this
paragraph.
<p>
Default value will be returned if explicit style definition is found but
no horizontal alignment is set.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the horizontal alignment setting.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6.5</dd></dl>
</li>
</ul>
<a name="setHorizontalAlignment(org.odftoolkit.simple.style.StyleTypeDefinitions.HorizontalAlignmentType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHorizontalAlignment</h4>
<pre>public&nbsp;void&nbsp;setHorizontalAlignment(<a href="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.HorizontalAlignmentType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.HorizontalAlignmentType</a>&nbsp;alignType)</pre>
<div class="block">Set the horizontal alignment setting of this paragraph. If the alignment
is set as Default, the explicit horizontal alignment setting is removed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>alignType</code> - the horizontal alignment setting.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6.5</dd></dl>
</li>
</ul>
<a name="addTextbox()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTextbox</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/draw/Textbox.html" title="class in org.odftoolkit.simple.draw">Textbox</a>&nbsp;addTextbox()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.html#addTextbox()">TextboxContainer</a></code></strong></div>
<div class="block">Add a text box</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.html#addTextbox()">addTextbox</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.html" title="interface in org.odftoolkit.simple.draw">TextboxContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the object of text box</dd></dl>
</li>
</ul>
<a name="getTextboxIterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTextboxIterator</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/draw/Textbox.html" title="class in org.odftoolkit.simple.draw">Textbox</a>&gt;&nbsp;getTextboxIterator()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.html#getTextboxIterator()">TextboxContainer</a></code></strong></div>
<div class="block">Return an Iterator of the text objects in this container.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.html#getTextboxIterator()">getTextboxIterator</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.html" title="interface in org.odftoolkit.simple.draw">TextboxContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>an Iterator of the text objects in this container</dd></dl>
</li>
</ul>
<a name="removeTextbox(org.odftoolkit.simple.draw.Textbox)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeTextbox</h4>
<pre>public&nbsp;boolean&nbsp;removeTextbox(<a href="../../../../org/odftoolkit/simple/draw/Textbox.html" title="class in org.odftoolkit.simple.draw">Textbox</a>&nbsp;box)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.html#removeTextbox(org.odftoolkit.simple.draw.Textbox)">TextboxContainer</a></code></strong></div>
<div class="block">Remove the text box</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.html#removeTextbox(org.odftoolkit.simple.draw.Textbox)">removeTextbox</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.html" title="interface in org.odftoolkit.simple.draw">TextboxContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>box</code> - - the instance of text box</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if success, false if fails</dd></dl>
</li>
</ul>
<a name="getFrameContainerElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFrameContainerElement</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.pkg.OdfElement&nbsp;getFrameContainerElement()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/draw/FrameContainer.html#getFrameContainerElement()">FrameContainer</a></code></strong></div>
<div class="block">Get the ODF element which can have <draw:frame> as child element directly
according to ODF specification. This Element will help to find the
position to insert a new draw:frame element.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/draw/FrameContainer.html#getFrameContainerElement()">getFrameContainerElement</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/draw/FrameContainer.html" title="interface in org.odftoolkit.simple.draw">FrameContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the parent of draw:frame</dd></dl>
</li>
</ul>
<a name="addTextbox(org.odftoolkit.simple.draw.FrameRectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTextbox</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/draw/Textbox.html" title="class in org.odftoolkit.simple.draw">Textbox</a>&nbsp;addTextbox(<a href="../../../../org/odftoolkit/simple/draw/FrameRectangle.html" title="class in org.odftoolkit.simple.draw">FrameRectangle</a>&nbsp;position)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.html#addTextbox(org.odftoolkit.simple.draw.FrameRectangle)">TextboxContainer</a></code></strong></div>
<div class="block">Add a text box with a specific size at a specific position</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.html#addTextbox(org.odftoolkit.simple.draw.FrameRectangle)">addTextbox</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.html" title="interface in org.odftoolkit.simple.draw">TextboxContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>position</code> - - the rectangle (position and size) of this text box</dd>
<dt><span class="strong">Returns:</span></dt><dd>the object of text box</dd></dl>
</li>
</ul>
<a name="getTextboxByName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTextboxByName</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/draw/Textbox.html" title="class in org.odftoolkit.simple.draw">Textbox</a>&nbsp;getTextboxByName(<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/draw/TextboxContainer.html#getTextboxByName(java.lang.String)">TextboxContainer</a></code></strong></div>
<div class="block">Return a text box whose name is a given value.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.html#getTextboxByName(java.lang.String)">getTextboxByName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.html" title="interface in org.odftoolkit.simple.draw">TextboxContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - - the name of the text box</dd>
<dt><span class="strong">Returns:</span></dt><dd>a text box whose name is a given value</dd></dl>
</li>
</ul>
<a name="getTextboxByUsage(org.odftoolkit.simple.PresentationDocument.PresentationClass)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTextboxByUsage</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/draw/Textbox.html" title="class in org.odftoolkit.simple.draw">Textbox</a>&gt;&nbsp;getTextboxByUsage(<a href="../../../../org/odftoolkit/simple/PresentationDocument.PresentationClass.html" title="enum in org.odftoolkit.simple">PresentationDocument.PresentationClass</a>&nbsp;usage)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.html#getTextboxByUsage(org.odftoolkit.simple.PresentationDocument.PresentationClass)">TextboxContainer</a></code></strong></div>
<div class="block">This method is only useful in presentation slide.
<p>
This method will return a list of text boxs by the usage in presentation
slides.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.html#getTextboxByUsage(org.odftoolkit.simple.PresentationDocument.PresentationClass)">getTextboxByUsage</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.html" title="interface in org.odftoolkit.simple.draw">TextboxContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>usage</code> - - the usage description</dd>
<dt><span class="strong">Returns:</span></dt><dd>a list of text box Null will be returned if the owner document is
not a presentation</dd></dl>
</li>
</ul>
<a name="applyHyperlink(java.net.URI)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applyHyperlink</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/text/TextHyperlink.html" title="class in org.odftoolkit.simple.text">TextHyperlink</a>&nbsp;applyHyperlink(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&nbsp;linkto)</pre>
<div class="block">Hyperlink support</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html#applyHyperlink(java.net.URI)">applyHyperlink</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html" title="interface in org.odftoolkit.simple.text">TextHyperlinkContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>linkto</code> - the hyperlink</dd>
<dt><span class="strong">Returns:</span></dt><dd>an instance of TextHyperlink</dd></dl>
</li>
</ul>
<a name="getHyperlinkIterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHyperlinkIterator</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/TextHyperlink.html" title="class in org.odftoolkit.simple.text">TextHyperlink</a>&gt;&nbsp;getHyperlinkIterator()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html#getHyperlinkIterator()">TextHyperlinkContainer</a></code></strong></div>
<div class="block">Get the iterator of hyperlinks within this container element</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html#getHyperlinkIterator()">getHyperlinkIterator</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html" title="interface in org.odftoolkit.simple.text">TextHyperlinkContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the iterator of hyperlinks within this container element</dd></dl>
</li>
</ul>
<a name="removeHyperlinks()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeHyperlinks</h4>
<pre>public&nbsp;void&nbsp;removeHyperlinks()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html#removeHyperlinks()">TextHyperlinkContainer</a></code></strong></div>
<div class="block">Remove all the hyperlinks in this container element.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html#removeHyperlinks()">removeHyperlinks</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html" title="interface in org.odftoolkit.simple.text">TextHyperlinkContainer</a></code></dd>
</dl>
</li>
</ul>
<a name="appendHyperlink(java.lang.String, java.net.URI)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendHyperlink</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/text/TextHyperlink.html" title="class in org.odftoolkit.simple.text">TextHyperlink</a>&nbsp;appendHyperlink(<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,
<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&nbsp;linkto)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html#appendHyperlink(java.lang.String, java.net.URI)">TextHyperlinkContainer</a></code></strong></div>
<div class="block">Append a hyperlink at the end of the container</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html#appendHyperlink(java.lang.String, java.net.URI)">appendHyperlink</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/TextHyperlinkContainer.html" title="interface in org.odftoolkit.simple.text">TextHyperlinkContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>text</code> - - the text content</dd><dd><code>linkto</code> - - the URI of this hyperlink</dd>
<dt><span class="strong">Returns:</span></dt><dd>an instance of TextHyperlink</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">End of Hyperlink support</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/Paragraph.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/odftoolkit/simple/text/Header.html" title="class in org.odftoolkit.simple.text"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/text/Paragraph.html" target="_top">Frames</a></li>
<li><a href="Paragraph.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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>