Google Git
Sign in
apache / incubator-odftoolkit-site / d22ef2d53769a0a209d42b84c8275ad1d8522260 / . / content / odftoolkit / mvn-site / 0.8-incubating / simple-odf / apidocs / org / odftoolkit / simple / draw / TextboxContainer.html
blob: 3cf56b61fd0ac61f03514ee45033036d8e8fc9de [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>TextboxContainer (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="TextboxContainer (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/TextboxContainer.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/Textbox.html" title="class in org.odftoolkit.simple.draw"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/draw/TextboxContainer.html" target="_top">Frames</a></li>
<li><a href="TextboxContainer.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.draw</div>
<h2 title="Interface TextboxContainer" class="title">Interface TextboxContainer</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../org/odftoolkit/simple/draw/FrameContainer.html" title="interface in org.odftoolkit.simple.draw">FrameContainer</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/odftoolkit/simple/draw/AbstractTextboxContainer.html" title="class in org.odftoolkit.simple.draw">AbstractTextboxContainer</a>, <a href="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>, <a href="../../../../org/odftoolkit/simple/presentation/Slide.html" title="class in org.odftoolkit.simple.presentation">Slide</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">TextboxContainer</span>
extends <a href="../../../../org/odftoolkit/simple/draw/FrameContainer.html" title="interface in org.odftoolkit.simple.draw">FrameContainer</a></pre>
<div class="block">TextboxContainer is a container which maintains TextBox(s) as element(s).
TextBox(s) can be added, removed and iterated in this container.</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><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/TextboxContainer.html#addTextbox()">addTextbox</a></strong>()</code>
<div class="block">Add a text box</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/draw/TextboxContainer.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="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/draw/TextboxContainer.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/draw/TextboxContainer.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/draw/TextboxContainer.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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/draw/TextboxContainer.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>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.odftoolkit.simple.draw.FrameContainer">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.odftoolkit.simple.draw.<a href="../../../../org/odftoolkit/simple/draw/FrameContainer.html" title="interface in org.odftoolkit.simple.draw">FrameContainer</a></h3>
<code><a href="../../../../org/odftoolkit/simple/draw/FrameContainer.html#getFrameContainerElement()">getFrameContainerElement</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="addTextbox()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTextbox</h4>
<pre><a href="../../../../org/odftoolkit/simple/draw/Textbox.html" title="class in org.odftoolkit.simple.draw">Textbox</a>&nbsp;addTextbox()</pre>
<div class="block">Add a text box</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the object of text box</dd></dl>
</li>
</ul>
<a name="addTextbox(org.odftoolkit.simple.draw.FrameRectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTextbox</h4>
<pre><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">Add a text box with a specific size at a specific position</div>
<dl><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="removeTextbox(org.odftoolkit.simple.draw.Textbox)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeTextbox</h4>
<pre>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">Remove the text box</div>
<dl><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="getTextboxIterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTextboxIterator</h4>
<pre><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">Return an Iterator of the text objects in this container.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an Iterator of the text objects in this container</dd></dl>
</li>
</ul>
<a name="getTextboxByName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTextboxByName</h4>
<pre><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">Return a text box whose name is a given value.</div>
<dl><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="blockListLast">
<li class="blockList">
<h4>getTextboxByUsage</h4>
<pre><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">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><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>
</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/TextboxContainer.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/Textbox.html" title="class in org.odftoolkit.simple.draw"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/draw/TextboxContainer.html" target="_top">Frames</a></li>
<li><a href="TextboxContainer.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>