Google Git
Sign in
apache / incubator-odftoolkit-site / d22ef2d53769a0a209d42b84c8275ad1d8522260 / . / content / odftoolkit / mvn-site / 0.8-incubating / simple-odf / apidocs / org / odftoolkit / simple / text / list / ListItem.html
blob: cfb22b08e2a26309c22d74a09b386daa94f0e99f [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Fri Feb 22 10:35:17 CET 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>ListItem (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="ListItem (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/ListItem.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/list/ListDecorator.ListType.html" title="enum in org.odftoolkit.simple.text.list"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/odftoolkit/simple/text/list/NumberDecorator.html" title="class in org.odftoolkit.simple.text.list"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/odftoolkit/simple/text/list/ListItem.html" target="_top">Frames</a></li>
<li><a href="ListItem.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.odftoolkit.simple.text.list</div>
<h2 title="Class ListItem" class="title">Class ListItem</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>org.odftoolkit.simple.text.list.ListItem</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">ListItem</span>
extends <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>
implements <a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a></pre>
<div class="block">ListItem represents an item in a list. ListItem can have text content or sub
List.</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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/ListItem.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/list/ListItem.html#addList(org.odftoolkit.simple.text.list.ListDecorator)">addList</a></strong>(<a href="../../../../../org/odftoolkit/simple/text/list/ListDecorator.html" title="interface in org.odftoolkit.simple.text.list">ListDecorator</a>&nbsp;decorator)</code>
<div class="block">Add a List with specified ListDecorator to this container.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html#clearList()">clearList</a></strong>()</code>
<div class="block">Remove all Lists from this container.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html#getIndex()">getIndex</a></strong>()</code>
<div class="block">Answers the index of the item in its owner list.</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/list/ListItem.html#getListContainerElement()">getListContainerElement</a></strong>()</code>
<div class="block">Get the ODF element which can have <text:list> as child
element directly according to ODF specification.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html#getListIterator()">getListIterator</a></strong>()</code>
<div class="block">Return an Iterator of the Lists in this ListContainer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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/list/ListItem.html#getNumberFormat()">getNumberFormat</a></strong>()</code>
<div class="block">Get the number format of this item.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.dom.element.text.TextListItemElement</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html#getOdfElement()">getOdfElement</a></strong>()</code>
<div class="block">Get the instance of TextListItemElement which represents this list item.</div>
</td>
</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/list/ListItem.html#getOwnerList()">getOwnerList</a></strong>()</code>
<div class="block">Get the List which contains this ListItem.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html#getStartNumber()">getStartNumber</a></strong>()</code>
<div class="block">Get the start number of this item.</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/list/ListItem.html#getTextContent()">getTextContent</a></strong>()</code>
<div class="block">Get item text content.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html#remove()">remove</a></strong>()</code>
<div class="block">Remove this item from its owner list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html#removeList(org.odftoolkit.simple.text.list.List)">removeList</a></strong>(<a href="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&nbsp;list)</code>
<div class="block">Remove the existing List from this container.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html#setNumberFormat(java.lang.String)">setNumberFormat</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;format)</code>
<div class="block">Set the number format of this item.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html#setStartNumber(java.lang.Integer)">setStartNumber</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;number)</code>
<div class="block">Set the start number of this item.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html#setTextContent(java.lang.String)">setTextContent</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;content)</code>
<div class="block">Set item text content.</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/list/ListItem.html#toString()">toString</a></strong>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#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="getOdfElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOdfElement</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.dom.element.text.TextListItemElement&nbsp;getOdfElement()</pre>
<div class="block">Get the instance of TextListItemElement which represents this list item.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the instance of TextListItemElement</dd></dl>
</li>
</ul>
<a name="getTextContent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTextContent</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getTextContent()</pre>
<div class="block">Get item text content. If this item has a List, its content is not
included.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the text content of this item</dd></dl>
</li>
</ul>
<a name="setTextContent(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTextContent</h4>
<pre>public&nbsp;void&nbsp;setTextContent(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;content)</pre>
<div class="block">Set item text content.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>content</code> - item text content.</dd></dl>
</li>
</ul>
<a name="remove()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>public&nbsp;void&nbsp;remove()</pre>
<div class="block">Remove this item from its owner list.</div>
</li>
</ul>
<a name="getStartNumber()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStartNumber</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;getStartNumber()</pre>
<div class="block">Get the start number of this item.
<p>
A value can be specified that restarts numbering of a list at the current
item. This feature can only be applied to items in a list with a
numbering list style.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the start number of this item. If there is no start number
setting on this item or the owner list is not a numbering list,
<code>null</code> will be returned.</dd></dl>
</li>
</ul>
<a name="setStartNumber(java.lang.Integer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStartNumber</h4>
<pre>public&nbsp;void&nbsp;setStartNumber(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;number)</pre>
<div class="block">Set the start number of this item.
<p>
A value can be specified that restarts numbering of a list at the current
item. This feature can only be applied to items in a list with a
numbering list style.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>number</code> - the start number to be set.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>number < 0</code>.</dd></dl>
</li>
</ul>
<a name="getNumberFormat()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumberFormat</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getNumberFormat()</pre>
<div class="block">Get the number format of this item.
<p>
List item can contain the text of a formatted number which is present
when a list style is applied to an element whose corresponding list level
style specifies that the list label is a number. This text may be used by
consumers that do not support the automatic generation of numbering but
should be ignored by consumers that do support it.</div>
</li>
</ul>
<a name="setNumberFormat(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNumberFormat</h4>
<pre>public&nbsp;void&nbsp;setNumberFormat(<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;format)</pre>
<div class="block">Set the number format of this item.
<p>
List item can contain the text of a formatted number which is present
when a list style is applied to an element whose corresponding list level
style specifies that the list label is a number. This text may be used by
consumers that do not support the automatic generation of numbering but
should be ignored by consumers that do support it.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>format</code> - the number format to be set.</dd></dl>
</li>
</ul>
<a name="getIndex()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIndex</h4>
<pre>public&nbsp;int&nbsp;getIndex()</pre>
<div class="block">Answers the index of the item in its owner list.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>index of the item.</dd></dl>
</li>
</ul>
<a name="getOwnerList()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOwnerList</h4>
<pre>public&nbsp;<a href="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&nbsp;getOwnerList()</pre>
<div class="block">Get the List which contains this ListItem.</div>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</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#toString()" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<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="getListContainerElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getListContainerElement</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.pkg.OdfElement&nbsp;getListContainerElement()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html#getListContainerElement()">ListContainer</a></code></strong></div>
<div class="block">Get the ODF element which can have <text:list> as child
element directly according to ODF specification. This Element will help to find the
position to insert a new List. For example, <text:list> element is
usable with <office:text> element, so TextDocument will return
OfficeTextElement. While Presentation Notes is an indirectly
ListContainer, which holds List with the help of its grand-child element
<draw:text-box>, so for Notes, DrawTextBoxElement should be return.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html#getListContainerElement()">getListContainerElement</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>container element which can hold <text:list>.</dd></dl>
</li>
</ul>
<a name="addList()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addList</h4>
<pre>public&nbsp;<a href="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&nbsp;addList()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html#addList()">ListContainer</a></code></strong></div>
<div class="block">Add a new List to this container.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html#addList()">addList</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>added list.</dd></dl>
</li>
</ul>
<a name="addList(org.odftoolkit.simple.text.list.ListDecorator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addList</h4>
<pre>public&nbsp;<a href="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&nbsp;addList(<a href="../../../../../org/odftoolkit/simple/text/list/ListDecorator.html" title="interface in org.odftoolkit.simple.text.list">ListDecorator</a>&nbsp;decorator)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html#addList(org.odftoolkit.simple.text.list.ListDecorator)">ListContainer</a></code></strong></div>
<div class="block">Add a List with specified ListDecorator to this container.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html#addList(org.odftoolkit.simple.text.list.ListDecorator)">addList</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>decorator</code> - the specified ListDecorator</dd>
<dt><span class="strong">Returns:</span></dt><dd>added list.</dd></dl>
</li>
</ul>
<a name="clearList()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearList</h4>
<pre>public&nbsp;void&nbsp;clearList()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html#clearList()">ListContainer</a></code></strong></div>
<div class="block">Remove all Lists from this container.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html#clearList()">clearList</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a></code></dd>
</dl>
</li>
</ul>
<a name="getListIterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getListIterator</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&gt;&nbsp;getListIterator()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html#getListIterator()">ListContainer</a></code></strong></div>
<div class="block">Return an Iterator of the Lists in this ListContainer. The Lists are
iterated in the same order that they occur in the ListContainer.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html#getListIterator()">getListIterator</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>an Iterator of the Lists in this ListContainer</dd><dt><span class="strong">See Also:</span></dt><dd><a href="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a></dd></dl>
</li>
</ul>
<a name="removeList(org.odftoolkit.simple.text.list.List)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removeList</h4>
<pre>public&nbsp;boolean&nbsp;removeList(<a href="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&nbsp;list)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html#removeList(org.odftoolkit.simple.text.list.List)">ListContainer</a></code></strong></div>
<div class="block">Remove the existing List from this container.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html#removeList(org.odftoolkit.simple.text.list.List)">removeList</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>true, if the container contains this List.</dd></dl>
</li>
</ul>
</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/ListItem.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/list/ListDecorator.ListType.html" title="enum in org.odftoolkit.simple.text.list"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/odftoolkit/simple/text/list/NumberDecorator.html" title="class in org.odftoolkit.simple.text.list"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/odftoolkit/simple/text/list/ListItem.html" target="_top">Frames</a></li>
<li><a href="ListItem.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>