Google Git
Sign in
apache / incubator-odftoolkit-site / d22ef2d53769a0a209d42b84c8275ad1d8522260 / . / content / odftoolkit / mvn-site / 0.8-incubating / simple-odf / apidocs / org / odftoolkit / simple / draw / Textbox.html
blob: fb40067a58b335e5c0986727cecb3c6ac33b9f57 [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>Textbox (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="Textbox (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/Textbox.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/draw/Image.html" title="class in org.odftoolkit.simple.draw"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.html" title="interface in org.odftoolkit.simple.draw"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/draw/Textbox.html" target="_top">Frames</a></li>
<li><a href="Textbox.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><a href="#fields_inherited_from_class_org.odftoolkit.simple.draw.Frame">Field</a>&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.draw</div>
<h2 title="Class Textbox" class="title">Class Textbox</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><a href="../../../../org/odftoolkit/simple/draw/Frame.html" title="class in org.odftoolkit.simple.draw">org.odftoolkit.simple.draw.Frame</a></li>
<li>
<ul class="inheritance">
<li>org.odftoolkit.simple.draw.Textbox</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="../../../../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">Textbox</span>
extends <a href="../../../../org/odftoolkit/simple/draw/Frame.html" title="class in org.odftoolkit.simple.draw">Frame</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></pre>
<div class="block">This class provides method to set the content, properties and style of text
box.</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">
<!-- =========== 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.simple.draw.Frame">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.odftoolkit.simple.draw.<a href="../../../../org/odftoolkit/simple/draw/Frame.html" title="class in org.odftoolkit.simple.draw">Frame</a></h3>
<code><a href="../../../../org/odftoolkit/simple/draw/Frame.html#mElement">mElement</a>, <a href="../../../../org/odftoolkit/simple/draw/Frame.html#mFrameContainer">mFrameContainer</a>, <a href="../../../../org/odftoolkit/simple/draw/Frame.html#mOwnerDocument">mOwnerDocument</a>, <a href="../../../../org/odftoolkit/simple/draw/Frame.html#mStyleHandler">mStyleHandler</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/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/draw/Textbox.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/draw/Textbox.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><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/draw/Textbox.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;textContent)</code>
<div class="block">Add paragraph at the end of the container with specified text content.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/Textbox.html#clearContent()">clearContent</a></strong>()</code>
<div class="block">Remove all the content of this text box.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/Textbox.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>static <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/draw/Textbox.html#getInstanceof(org.odftoolkit.odfdom.dom.element.draw.DrawTextBoxElement)">getInstanceof</a></strong>(org.odftoolkit.odfdom.dom.element.draw.DrawTextBoxElement&nbsp;element)</code>
<div class="block">Get a text box instance by an instance of <code>DrawTextBoxElement</code>
.</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/draw/Textbox.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="rowColor">
<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/draw/Textbox.html#getListIterator()">getListIterator</a></strong>()</code>
<div class="block">Return an Iterator of the Lists in this ListContainer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.dom.element.draw.DrawTextBoxElement</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/Textbox.html#getOdfElement()">getOdfElement</a></strong>()</code>
<div class="block">Get the instance of <code>DrawTextBoxElement</code> which represents this
frame.</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/draw/Textbox.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/draw/Textbox.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/draw/Textbox.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/draw/Textbox.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><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/draw/Textbox.html#getTextContent()">getTextContent</a></strong>()</code>
<div class="block">Get the text content of this text box.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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/draw/Textbox.html#newTextbox(org.odftoolkit.simple.draw.TextboxContainer)">newTextbox</a></strong>(<a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.html" title="interface in org.odftoolkit.simple.draw">TextboxContainer</a>&nbsp;container)</code>
<div class="block">Create an instance of frame
The frame will be added at the end of 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/draw/Textbox.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="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/Textbox.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 the container</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/Textbox.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 text box.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.odftoolkit.simple.draw.Frame">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.odftoolkit.simple.draw.<a href="../../../../org/odftoolkit/simple/draw/Frame.html" title="class in org.odftoolkit.simple.draw">Frame</a></h3>
<code><a href="../../../../org/odftoolkit/simple/draw/Frame.html#getDesciption()">getDesciption</a>, <a href="../../../../org/odftoolkit/simple/draw/Frame.html#getDrawFrameElement()">getDrawFrameElement</a>, <a href="../../../../org/odftoolkit/simple/draw/Frame.html#getHyperlink()">getHyperlink</a>, <a href="../../../../org/odftoolkit/simple/draw/Frame.html#getInstanceof(org.odftoolkit.odfdom.dom.element.draw.DrawFrameElement)">getInstanceof</a>, <a href="../../../../org/odftoolkit/simple/draw/Frame.html#getName()">getName</a>, <a href="../../../../org/odftoolkit/simple/draw/Frame.html#getRectangle()">getRectangle</a>, <a href="../../../../org/odftoolkit/simple/draw/Frame.html#getStyleHandler()">getStyleHandler</a>, <a href="../../../../org/odftoolkit/simple/draw/Frame.html#getTitle()">getTitle</a>, <a href="../../../../org/odftoolkit/simple/draw/Frame.html#newFrame(org.odftoolkit.simple.draw.FrameContainer)">newFrame</a>, <a href="../../../../org/odftoolkit/simple/draw/Frame.html#setBackgroundColor(org.odftoolkit.odfdom.type.Color)">setBackgroundColor</a>, <a href="../../../../org/odftoolkit/simple/draw/Frame.html#setDescription(java.lang.String)">setDescription</a>, <a href="../../../../org/odftoolkit/simple/draw/Frame.html#setHyperlink(java.net.URI)">setHyperlink</a>, <a href="../../../../org/odftoolkit/simple/draw/Frame.html#setImage(java.net.URI)">setImage</a>, <a href="../../../../org/odftoolkit/simple/draw/Frame.html#setName(java.lang.String)">setName</a>, <a href="../../../../org/odftoolkit/simple/draw/Frame.html#setRectangle(org.odftoolkit.simple.draw.FrameRectangle)">setRectangle</a>, <a href="../../../../org/odftoolkit/simple/draw/Frame.html#setTitle(java.lang.String)">setTitle</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.odftoolkit.simple.Component">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.odftoolkit.simple.<a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a></h3>
<code><a href="../../../../org/odftoolkit/simple/Component.html#getComponentByElement(org.odftoolkit.odfdom.pkg.OdfElement)">getComponentByElement</a>, <a href="../../../../org/odftoolkit/simple/Component.html#getOwnerDocument()">getOwnerDocument</a>, <a href="../../../../org/odftoolkit/simple/Component.html#registerComponent(org.odftoolkit.simple.Component, org.odftoolkit.odfdom.pkg.OdfElement)">registerComponent</a>, <a href="../../../../org/odftoolkit/simple/Component.html#unregisterComponent(org.odftoolkit.odfdom.pkg.OdfElement)">unregisterComponent</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ 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.draw.DrawTextBoxElement)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstanceof</h4>
<pre>public static&nbsp;<a href="../../../../org/odftoolkit/simple/draw/Textbox.html" title="class in org.odftoolkit.simple.draw">Textbox</a>&nbsp;getInstanceof(org.odftoolkit.odfdom.dom.element.draw.DrawTextBoxElement&nbsp;element)</pre>
<div class="block">Get a text box instance by an instance of <code>DrawTextBoxElement</code>
.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>element</code> - - the instance of DrawTextBoxElement</dd>
<dt><span class="strong">Returns:</span></dt><dd>an instance of text box</dd></dl>
</li>
</ul>
<a name="newTextbox(org.odftoolkit.simple.draw.TextboxContainer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newTextbox</h4>
<pre>public static&nbsp;<a href="../../../../org/odftoolkit/simple/draw/Textbox.html" title="class in org.odftoolkit.simple.draw">Textbox</a>&nbsp;newTextbox(<a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.html" title="interface in org.odftoolkit.simple.draw">TextboxContainer</a>&nbsp;container)</pre>
<div class="block">Create an instance of frame
<p>
The frame will be added at the end of this container.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>container</code> - - the frame container that contains this frame.</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 text box.
<p>
This method will clear the content at first, and then create a paragraph
with the given content.</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/draw/Textbox.html#clearContent()"><code>clearContent()</code></a>,
<a href="../../../../org/odftoolkit/simple/draw/Textbox.html#addParagraph(java.lang.String)"><code>addParagraph(String textContent)</code></a></dd></dl>
</li>
</ul>
<a name="clearContent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearContent</h4>
<pre>public&nbsp;void&nbsp;clearContent()</pre>
<div class="block">Remove all the content of this text box.</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">Get the text content of this text box.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>- the text content</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/simple/common/TextExtractor.html#getText(org.odftoolkit.odfdom.pkg.OdfElement)"><code>TextExtractor.getText(OdfElement)</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.draw.DrawTextBoxElement&nbsp;getOdfElement()</pre>
<div class="block">Get the instance of <code>DrawTextBoxElement</code> which represents this
frame.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/simple/draw/Frame.html#getOdfElement()">getOdfElement</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/odftoolkit/simple/draw/Frame.html" title="class in org.odftoolkit.simple.draw">Frame</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the instance of <code>DrawTextBoxElement</code></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="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="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="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;textContent)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.html#addParagraph(java.lang.String)">ParagraphContainer</a></code></strong></div>
<div class="block">Add paragraph at the end of the container with specified text content.</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>textContent</code> - - the text content</dd>
<dt><span class="strong">Returns:</span></dt><dd>an instance of paragraph</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="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"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.html#removeParagraph(org.odftoolkit.simple.text.Paragraph)">ParagraphContainer</a></code></strong></div>
<div class="block">Remove paragraph from the container</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="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="blockListLast">
<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>
</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/Textbox.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/draw/Image.html" title="class in org.odftoolkit.simple.draw"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.html" title="interface in org.odftoolkit.simple.draw"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/draw/Textbox.html" target="_top">Frames</a></li>
<li><a href="Textbox.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><a href="#fields_inherited_from_class_org.odftoolkit.simple.draw.Frame">Field</a>&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>