| <!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>Section (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="Section (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/Section.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/ProtectionKeyDigestProvider.html" title="interface in org.odftoolkit.simple.text"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/odftoolkit/simple/text/Span.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/Section.html" target="_top">Frames</a></li> |
| <li><a href="Section.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="Class Section" class="title">Class Section</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.Section</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/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</a>, <a href="../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a>, <a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">Section</span> |
| extends <a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a> |
| implements <a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</a>, <a href="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</a>, <a href="../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a></pre> |
| <div class="block">This class represents section definition in text document. It provides |
| methods to manipulate section in text document, such as getting/setting |
| section name, moving section and so on.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.4</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/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/text/Section.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/text/Section.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> 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/text/Section.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/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Section.html#addTable()">addTable</a></strong>()</code> |
| <div class="block">Add a new Table to this container.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Section.html#addTable(int, int)">addTable</a></strong>(int numRows, |
| int numCols)</code> |
| <div class="block">Add a new Table to this container with a specified row number and column |
| number.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Section.html#clearList()">clearList</a></strong>()</code> |
| <div class="block">Remove all Lists 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/text/Section.html#equals(java.lang.Object)">equals</a></strong>(<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> obj)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/text/ProtectionKeyDigestProvider.html" title="interface in org.odftoolkit.simple.text">ProtectionKeyDigestProvider</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Section.html#getDefaultProtectionKeyDigestProvider()">getDefaultProtectionKeyDigestProvider</a></strong>()</code> |
| <div class="block">Get the default provider which use SHA-1 standard as the protection key |
| digest algorithm.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/odftoolkit/simple/text/Section.html" title="class in org.odftoolkit.simple.text">Section</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Section.html#getInstance(org.odftoolkit.odfdom.dom.element.text.TextSectionElement)">getInstance</a></strong>(org.odftoolkit.odfdom.dom.element.text.TextSectionElement element)</code> |
| <div class="block">Get a section instance by an object of <code>TextSectionElement</code>.</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/Section.html#getListContainerElement()">getListContainerElement</a></strong>()</code> |
| <div class="block">Get the ODF element which can have <text:list> as child |
| element directly according to ODF specification.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<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/text/Section.html#getListIterator()">getListIterator</a></strong>()</code> |
| <div class="block">Return an Iterator of the Lists in this ListContainer.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="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/Section.html#getName()">getName</a></strong>()</code> |
| <div class="block">Return the name of this section</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>org.odftoolkit.odfdom.dom.element.text.TextSectionElement</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Section.html#getOdfElement()">getOdfElement</a></strong>()</code> |
| <div class="block">Return an instance of <code>TextSectionElement</code> which represents |
| this section.</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/Section.html#getOwnerDocument()">getOwnerDocument</a></strong>()</code> |
| <div class="block">Return the ODF document which this section belongs to.</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/Section.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="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/Section.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="altColor"> |
| <td class="colFirst"><code>org.odftoolkit.odfdom.pkg.OdfElement</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Section.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="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><<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/Section.html#getParagraphIterator()">getParagraphIterator</a></strong>()</code> |
| <div class="block">Return an Iterator of the paragraph in this container.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <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/Section.html#getProtectedPassword()">getProtectedPassword</a></strong>()</code> |
| <div class="block">Get the protection key of this section.</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/Section.html#getProtectionKeyDigestAlgorithm()">getProtectionKeyDigestAlgorithm</a></strong>()</code> |
| <div class="block">Get the protection key digest algorithm.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/text/ProtectionKeyDigestProvider.html" title="interface in org.odftoolkit.simple.text">ProtectionKeyDigestProvider</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Section.html#getProtectionKeyDigestProvier()">getProtectionKeyDigestProvier</a></strong>()</code> |
| <div class="block">Get current used provider which provides corresponding protection key |
| digest algorithm.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/table/Table.TableBuilder.html" title="class in org.odftoolkit.simple.table">Table.TableBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Section.html#getTableBuilder()">getTableBuilder</a></strong>()</code> |
| <div class="block">Return the table builder of this document.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Section.html#getTableByName(java.lang.String)">getTableByName</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> name)</code> |
| <div class="block">Return an instance of table feature with the specific table name.</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/Section.html#getTableContainerElement()">getTableContainerElement</a></strong>()</code> |
| <div class="block">Get the ODF element which can have |
| <table:table> |
| as child element directly according to ODF specification.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Section.html#getTableContainerImpl()">getTableContainerImpl</a></strong>()</code> </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><<a href="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Section.html#getTableList()">getTableList</a></strong>()</code> |
| <div class="block">Return a list of table features in this document.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Section.html#isProtected()">isProtected</a></strong>()</code> |
| <div class="block">Return the value of section which specifies whether the section is |
| protected.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Section.html#remove()">remove</a></strong>()</code> |
| <div class="block">Remove this section from the document.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Section.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> list)</code> |
| <div class="block">Remove the existing List from this container.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Section.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> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Section.html#setName(java.lang.String)">setName</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> name)</code> |
| <div class="block">Set the value of this section name</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Section.html#setProtected(boolean)">setProtected</a></strong>(boolean isProtected)</code> |
| <div class="block">Set the value to specify whether the section is protected.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Section.html#setProtectedWithPassword(java.lang.String)">setProtectedWithPassword</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> key)</code> |
| <div class="block">Set the password which specifies that an authorization is required for |
| removing the protection of this section.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/text/Section.html#setProtectionKeyDigestProvider(org.odftoolkit.simple.text.ProtectionKeyDigestProvider)">setProtectionKeyDigestProvider</a></strong>(<a href="../../../../org/odftoolkit/simple/text/ProtectionKeyDigestProvider.html" title="interface in org.odftoolkit.simple.text">ProtectionKeyDigestProvider</a> provider)</code> |
| <div class="block">Set the provider which provides corresponding protection key digest |
| algorithm.</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 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 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#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="getInstance(org.odftoolkit.odfdom.dom.element.text.TextSectionElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInstance</h4> |
| <pre>public static <a href="../../../../org/odftoolkit/simple/text/Section.html" title="class in org.odftoolkit.simple.text">Section</a> getInstance(org.odftoolkit.odfdom.dom.element.text.TextSectionElement element)</pre> |
| <div class="block">Get a section instance by an object of <code>TextSectionElement</code>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>element</code> - - an object of <code>TextSectionElement</code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>an instance of <code>Section</code> that can represent |
| <code>TextSectionElement</code></dd></dl> |
| </li> |
| </ul> |
| <a name="getOwnerDocument()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOwnerDocument</h4> |
| <pre>public <a href="../../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</a> getOwnerDocument()</pre> |
| <div class="block">Return the ODF document which this section belongs to.</div> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/odftoolkit/simple/Component.html#getOwnerDocument()">getOwnerDocument</a></code> in class <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 ODF document which this section belongs to.</dd></dl> |
| </li> |
| </ul> |
| <a name="getName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre>public <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> getName()</pre> |
| <div class="block">Return the name of this section</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>- the name of this section</dd></dl> |
| </li> |
| </ul> |
| <a name="setName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setName</h4> |
| <pre>public void setName(<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> name)</pre> |
| <div class="block">Set the value of this section name</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - - the value of name to be set</dd></dl> |
| </li> |
| </ul> |
| <a name="remove()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remove</h4> |
| <pre>public void remove()</pre> |
| <div class="block">Remove this section from the document. |
| <p> |
| All the linked resources which are only linked to this section will be |
| removed too.</div> |
| </li> |
| </ul> |
| <a name="getOdfElement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOdfElement</h4> |
| <pre>public org.odftoolkit.odfdom.dom.element.text.TextSectionElement getOdfElement()</pre> |
| <div class="block">Return an instance of <code>TextSectionElement</code> which represents |
| this section.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/odftoolkit/simple/Component.html#getOdfElement()">getOdfElement</a></code> in class <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>- an instance of <code>TextSectionElement</code> which represents |
| this section</dd></dl> |
| </li> |
| </ul> |
| <a name="setProtected(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProtected</h4> |
| <pre>public void setProtected(boolean isProtected)</pre> |
| <div class="block">Set the value to specify whether the section is protected. |
| <p> |
| If this value is set to false, the existing password will be removed at |
| the same.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>isProtected</code> - - "true" represents the section cannot be edited through a |
| user interface. "false" represents the section is allowed to |
| be edited.</dd></dl> |
| </li> |
| </ul> |
| <a name="isProtected()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isProtected</h4> |
| <pre>public boolean isProtected()</pre> |
| <div class="block">Return the value of section which specifies whether the section is |
| protected.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>whether the section is protected.</dd></dl> |
| </li> |
| </ul> |
| <a name="setProtectedWithPassword(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProtectedWithPassword</h4> |
| <pre>public void setProtectedWithPassword(<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> key)</pre> |
| <div class="block">Set the password which specifies that an authorization is required for |
| removing the protection of this section. |
| <p> |
| If key is empty or null, the attribute of |
| <code>text:protection-key</code> and |
| <code>text:protection-key-digest-algorithm</code> will be removed. |
| <p> |
| The authentication procedure can be customized by |
| <a href="../../../../org/odftoolkit/simple/text/Section.html#setProtectionKeyDigestProvider(org.odftoolkit.simple.text.ProtectionKeyDigestProvider)"><code>setProtectionKeyDigestProvider(ProtectionKeyDigestProvider)</code></a> |
| . The default digest algorighom of the protection key is SHA-1: |
| <code>http://www.w3.org/2000/09/xmldsig#sha1.</code></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - -the value of the password.</dd></dl> |
| </li> |
| </ul> |
| <a name="getProtectedPassword()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProtectedPassword</h4> |
| <pre>public <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> getProtectedPassword()</pre> |
| <div class="block">Get the protection key of this section.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the protection key of this section</dd></dl> |
| </li> |
| </ul> |
| <a name="getProtectionKeyDigestAlgorithm()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProtectionKeyDigestAlgorithm</h4> |
| <pre>public <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> getProtectionKeyDigestAlgorithm()</pre> |
| <div class="block">Get the protection key digest algorithm. |
| <p> |
| The default value is http://www.w3.org/2000/09/xmldsig#sha1, if no value |
| specified.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>an IRI that identifies an authentication procedure for removing a |
| protection.</dd></dl> |
| </li> |
| </ul> |
| <a name="setProtectionKeyDigestProvider(org.odftoolkit.simple.text.ProtectionKeyDigestProvider)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProtectionKeyDigestProvider</h4> |
| <pre>public void setProtectionKeyDigestProvider(<a href="../../../../org/odftoolkit/simple/text/ProtectionKeyDigestProvider.html" title="interface in org.odftoolkit.simple.text">ProtectionKeyDigestProvider</a> provider)</pre> |
| <div class="block">Set the provider which provides corresponding protection key digest |
| algorithm.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>provider</code> - - an instance of a protection key digest algorithm provider</dd></dl> |
| </li> |
| </ul> |
| <a name="getProtectionKeyDigestProvier()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProtectionKeyDigestProvier</h4> |
| <pre>public <a href="../../../../org/odftoolkit/simple/text/ProtectionKeyDigestProvider.html" title="interface in org.odftoolkit.simple.text">ProtectionKeyDigestProvider</a> getProtectionKeyDigestProvier()</pre> |
| <div class="block">Get current used provider which provides corresponding protection key |
| digest algorithm.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the current used provider.</dd></dl> |
| </li> |
| </ul> |
| <a name="getDefaultProtectionKeyDigestProvider()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultProtectionKeyDigestProvider</h4> |
| <pre>public <a href="../../../../org/odftoolkit/simple/text/ProtectionKeyDigestProvider.html" title="interface in org.odftoolkit.simple.text">ProtectionKeyDigestProvider</a> getDefaultProtectionKeyDigestProvider()</pre> |
| <div class="block">Get the default provider which use SHA-1 standard as the protection key |
| digest algorithm.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the default protection key digest algorithm.</dd></dl> |
| </li> |
| </ul> |
| <a name="equals(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public boolean equals(<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> obj)</pre> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addParagraph(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addParagraph</h4> |
| <pre>public <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"><strong>Description copied from interface: <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> in interface <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 org.odftoolkit.odfdom.pkg.OdfElement getParagraphContainerElement()</pre> |
| <div class="block"><strong>Description copied from interface: <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> in interface <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 boolean removeParagraph(<a href="../../../../org/odftoolkit/simple/text/Paragraph.html" title="class in org.odftoolkit.simple.text">Paragraph</a> para)</pre> |
| <div class="block"><strong>Description copied from interface: <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> in interface <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 <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"><strong>Description copied from interface: <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> in interface <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 <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"><strong>Description copied from interface: <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> in interface <code><a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>reverseIndex</code> - - the index started from 0 in reverse order.</dd><dd><code>isEmptyParagraphSkipped</code> - - whether the empty paragraph is skipped or not</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the paragraph with a given index</dd></dl> |
| </li> |
| </ul> |
| <a name="getParagraphIterator()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParagraphIterator</h4> |
| <pre>public <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"><strong>Description copied from interface: <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> in interface <code><a href="../../../../org/odftoolkit/simple/text/ParagraphContainer.html" title="interface in org.odftoolkit.simple.text">ParagraphContainer</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>an Iterator of the paragraph in this container</dd></dl> |
| </li> |
| </ul> |
| <a name="getTableContainerImpl()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTableContainerImpl</h4> |
| <pre>protected <a href="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</a> getTableContainerImpl()</pre> |
| </li> |
| </ul> |
| <a name="addTable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addTable</h4> |
| <pre>public <a href="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a> addTable()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#addTable()">TableContainer</a></code></strong></div> |
| <div class="block">Add a new Table to this container.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#addTable()">addTable</a></code> in interface <code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>added table.</dd></dl> |
| </li> |
| </ul> |
| <a name="addTable(int, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addTable</h4> |
| <pre>public <a href="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a> addTable(int numRows, |
| int numCols)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#addTable(int, int)">TableContainer</a></code></strong></div> |
| <div class="block">Add a new Table to this container with a specified row number and column |
| number. |
| <p> |
| The table will be inserted at the end of the tableContainer. An unique |
| table name will be given, you may set a custom table name using the |
| <code>setTableName</code> method.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#addTable(int, int)">addTable</a></code> in interface <code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>numRows</code> - the row number</dd><dd><code>numCols</code> - the column number</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a new instance of <code>Table</code></dd></dl> |
| </li> |
| </ul> |
| <a name="getTableBuilder()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTableBuilder</h4> |
| <pre>public <a href="../../../../org/odftoolkit/simple/table/Table.TableBuilder.html" title="class in org.odftoolkit.simple.table">Table.TableBuilder</a> getTableBuilder()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableBuilder()">TableContainer</a></code></strong></div> |
| <div class="block">Return the table builder of this document. Every document has a table |
| builder, which supplies all of the table creation realization, for |
| example newTable().</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableBuilder()">getTableBuilder</a></code> in interface <code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the table builder of this document.</dd></dl> |
| </li> |
| </ul> |
| <a name="getTableByName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTableByName</h4> |
| <pre>public <a href="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a> getTableByName(<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> name)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableByName(java.lang.String)">TableContainer</a></code></strong></div> |
| <div class="block">Return an instance of table feature with the specific table name.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableByName(java.lang.String)">getTableByName</a></code> in interface <code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - of the table being searched for.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>an instance of table feature with the specific table name.</dd></dl> |
| </li> |
| </ul> |
| <a name="getTableContainerElement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTableContainerElement</h4> |
| <pre>public org.odftoolkit.odfdom.pkg.OdfElement getTableContainerElement()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableContainerElement()">TableContainer</a></code></strong></div> |
| <div class="block">Get the ODF element which can have |
| <table:table> |
| as child element directly according to ODF specification. This Element |
| will help to find the position to insert a new Table. For example, |
| <table:table> |
| element is usable with <office:text> element, so TextDocument will return |
| OfficeTextElement. While Presentation Notes is an indirectly |
| TableContainer, which holds Table with the help of its grand-child |
| element <draw:text-box>, so for Notes, DrawTextBoxElement should be |
| return.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableContainerElement()">getTableContainerElement</a></code> in interface <code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>container element which can hold <text:table>.</dd></dl> |
| </li> |
| </ul> |
| <a name="getTableList()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTableList</h4> |
| <pre>public <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><<a href="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>> getTableList()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableList()">TableContainer</a></code></strong></div> |
| <div class="block">Return a list of table features in this document.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableList()">getTableList</a></code> in interface <code><a href="../../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a list of table features in this document.</dd></dl> |
| </li> |
| </ul> |
| <a name="addList()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addList</h4> |
| <pre>public <a href="../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a> addList()</pre> |
| <div class="block"><strong>Description copied from interface: <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> in interface <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 <a href="../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a> addList(<a href="../../../../org/odftoolkit/simple/text/list/ListDecorator.html" title="interface in org.odftoolkit.simple.text.list">ListDecorator</a> decorator)</pre> |
| <div class="block"><strong>Description copied from interface: <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> in interface <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 void clearList()</pre> |
| <div class="block"><strong>Description copied from interface: <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> in interface <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 org.odftoolkit.odfdom.pkg.OdfElement getListContainerElement()</pre> |
| <div class="block"><strong>Description copied from interface: <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> in interface <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 <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/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>> getListIterator()</pre> |
| <div class="block"><strong>Description copied from interface: <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> in interface <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="blockListLast"> |
| <li class="blockList"> |
| <h4>removeList</h4> |
| <pre>public boolean removeList(<a href="../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a> list)</pre> |
| <div class="block"><strong>Description copied from interface: <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> in interface <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> |
| </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/Section.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/ProtectionKeyDigestProvider.html" title="interface in org.odftoolkit.simple.text"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/odftoolkit/simple/text/Span.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/Section.html" target="_top">Frames</a></li> |
| <li><a href="Section.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> |
