| <!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>ParagraphContainer (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="ParagraphContainer (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/ParagraphContainer.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/Paragraph.html" title="class in org.odftoolkit.simple.text"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/odftoolkit/simple/text/ParagraphStyleHandler.html" title="class in org.odftoolkit.simple.text"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/odftoolkit/simple/text/ParagraphContainer.html" target="_top">Frames</a></li> |
| <li><a href="ParagraphContainer.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="Interface ParagraphContainer" class="title">Interface ParagraphContainer</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/odftoolkit/simple/text/AbstractParagraphContainer.html" title="class in org.odftoolkit.simple.text">AbstractParagraphContainer</a>, <a href="../../../../org/odftoolkit/simple/table/Cell.html" title="class in org.odftoolkit.simple.table">Cell</a>, <a href="../../../../org/odftoolkit/simple/text/Section.html" title="class in org.odftoolkit.simple.text">Section</a>, <a href="../../../../org/odftoolkit/simple/draw/Textbox.html" title="class in org.odftoolkit.simple.draw">Textbox</a>, <a href="../../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">ParagraphContainer</span></pre> |
| <div class="block">ParagraphContainer is a container which maintains paragraph(s) as element(s). |
| Paragraph(s) can be added and removed in this container.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.5</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text"><code>Paragraph</code></a>, |
| <a href="../../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple"><code>TextDocument</code></a></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"> </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/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.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> 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><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/ParagraphContainer.html#getParagraphByIndex(int, boolean)">getParagraphByIndex</a></strong>(int index, |
| boolean 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/text/ParagraphContainer.html#getParagraphByReverseIndex(int, boolean)">getParagraphByReverseIndex</a></strong>(int reverseIndex, |
| boolean 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/text/ParagraphContainer.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><<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/ParagraphContainer.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>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.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> para)</code> |
| <div class="block">Remove paragraph from the container</div> |
| </td> |
| </tr> |
| </table> |
| </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="addParagraph(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addParagraph</h4> |
| <pre><a href="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a> 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> textContent)</pre> |
| <div class="block">Add paragraph at the end of the container with specified text content.</div> |
| <dl><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="removeParagraph(org.odftoolkit.simple.text.Paragraph)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeParagraph</h4> |
| <pre>boolean removeParagraph(<a href="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a> para)</pre> |
| <div class="block">Remove paragraph from the container</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>para</code> - - the instance of paragraph</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>true if the paragraph is removed successfully, false if errors |
| happen.</dd></dl> |
| </li> |
| </ul> |
| <a name="getParagraphContainerElement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParagraphContainerElement</h4> |
| <pre>org.odftoolkit.odfdom.pkg.OdfElement getParagraphContainerElement()</pre> |
| <div class="block">Get the ODF element which can have <text:p> as child element directly.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>- an ODF element which can have paragraph as child</dd></dl> |
| </li> |
| </ul> |
| <a name="getParagraphIterator()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParagraphIterator</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><<a href="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a>> getParagraphIterator()</pre> |
| <div class="block">Return an Iterator of the paragraph in this container.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>an Iterator of the paragraph in this container</dd></dl> |
| </li> |
| </ul> |
| <a name="getParagraphByIndex(int, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParagraphByIndex</h4> |
| <pre><a href="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a> getParagraphByIndex(int index, |
| boolean isEmptyParagraphSkipped)</pre> |
| <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><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="blockListLast"> |
| <li class="blockList"> |
| <h4>getParagraphByReverseIndex</h4> |
| <pre><a href="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a> getParagraphByReverseIndex(int reverseIndex, |
| boolean isEmptyParagraphSkipped)</pre> |
| <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><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> |
| </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/ParagraphContainer.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/Paragraph.html" title="class in org.odftoolkit.simple.text"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/odftoolkit/simple/text/ParagraphStyleHandler.html" title="class in org.odftoolkit.simple.text"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/odftoolkit/simple/text/ParagraphContainer.html" target="_top">Frames</a></li> |
| <li><a href="ParagraphContainer.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2010-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |