Google Git
Sign in
apache / incubator-odftoolkit-site / d22ef2d53769a0a209d42b84c8275ad1d8522260 / . / content / odftoolkit / mvn-site / 0.8-incubating / simple-odf / apidocs / org / odftoolkit / simple / text / list / List.html
blob: f07f3672c6969c73a2ea3f7827eff8b706cca961 [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>List (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="List (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/List.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/ImageDecorator.html" title="class in org.odftoolkit.simple.text.list"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface 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/List.html" target="_top">Frames</a></li>
<li><a href="List.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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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 List" class="title">Class List</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.List</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">List</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></pre>
<div class="block">This class represents a list. It can contain list header,
followed by list items.</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">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/List.html#List(org.odftoolkit.simple.text.list.ListContainer)">List</a></strong>(<a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a>&nbsp;container)</code>
<div class="block">Constructor with ListContainer only.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/List.html#List(org.odftoolkit.simple.text.list.ListContainer, org.odftoolkit.simple.text.list.ListDecorator)">List</a></strong>(<a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a>&nbsp;container,
<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">Constructor with ListContainer and ListDecorator.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/List.html#List(org.odftoolkit.simple.text.list.ListContainer, java.lang.String, boolean, org.odftoolkit.simple.text.list.ListDecorator)">List</a></strong>(<a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a>&nbsp;container,
<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;header,
boolean&nbsp;isContinueNumbering,
<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">Constructor with ListContainer, ListDecorator, header and numbering setting.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/List.html#List(org.odftoolkit.simple.text.list.ListContainer, java.lang.String, org.odftoolkit.simple.text.list.ListDecorator)">List</a></strong>(<a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a>&nbsp;container,
<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;header,
<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">Constructor with ListContainer, ListDecorator and header.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/List.html#List(org.odftoolkit.simple.text.list.ListContainer, java.lang.String, org.odftoolkit.simple.text.list.List, org.odftoolkit.simple.text.list.ListDecorator)">List</a></strong>(<a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a>&nbsp;container,
<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;header,
<a href="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&nbsp;continueList,
<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">Constructor with ListContainer, ListDecorator, header and continued list</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/List.html#addItem(int, org.odftoolkit.simple.text.list.ListItem)">addItem</a></strong>(int&nbsp;location,
<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&nbsp;item)</code>
<div class="block">Insert a ListItem at the specified location.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/List.html#addItem(int, java.lang.String)">addItem</a></strong>(int&nbsp;location,
<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;itemContent)</code>
<div class="block">Insert the specified ListItem at the specified location.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/List.html#addItem(org.odftoolkit.simple.text.list.ListItem)">addItem</a></strong>(<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&nbsp;item)</code>
<div class="block">Add the specified list item in ListItem object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/List.html#addItem(java.lang.String)">addItem</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;itemContent)</code>
<div class="block">Add a list item by specifying a string value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/List.html#addItems(int, org.odftoolkit.simple.text.list.ListItem[])">addItems</a></strong>(int&nbsp;location,
<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>[]&nbsp;items)</code>
<div class="block">Insert the list items at the certain location
by specifying an array of ListItem.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/List.html#addItems(int, java.lang.String[])">addItems</a></strong>(int&nbsp;location,
<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;items)</code>
<div class="block">Insert the list items at the specified location in this List
by giving an array of string values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/List.html#addItems(org.odftoolkit.simple.text.list.ListItem[])">addItems</a></strong>(<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>[]&nbsp;items)</code>
<div class="block">Add list items by specifying an array of ListItem.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/List.html#addItems(java.lang.String[])">addItems</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;items)</code>
<div class="block">Add list items by specifying an array of string values.</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/List.html#clear()">clear</a></strong>()</code>
<div class="block">Remove all items from this List.</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/List.html#getContinueList()">getContinueList</a></strong>()</code>
<div class="block">Get the preceding list whose numbering is continued by this list.</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/List.html#getHeader()">getHeader</a></strong>()</code>
<div class="block">Get the header of this list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/List.html#getItem(int)">getItem</a></strong>(int&nbsp;location)</code>
<div class="block">Return the item at the specified location in this List.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/List.html#getItems()">getItems</a></strong>()</code>
<div class="block">Get all of the list items.</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/List.html#getLevel()">getLevel</a></strong>()</code>
<div class="block">Get the level of this list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.dom.element.text.TextListElement</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/List.html#getOdfElement()">getOdfElement</a></strong>()</code>
<div class="block">Get the instance of TextListElement which represents this list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/odftoolkit/simple/text/list/ListDecorator.ListType.html" title="enum in org.odftoolkit.simple.text.list">ListDecorator.ListType</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/List.html#getType()">getType</a></strong>()</code>
<div class="block">Get the type of this 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/List.html#isContinueNumbering()">isContinueNumbering</a></strong>()</code>
<div class="block">Return whether the numbering of this list is continuing,
or whether the numbering of the preceding list is continued or not.</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/List.html#remove()">remove</a></strong>()</code>
<div class="block">Remove this list from its 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/list/List.html#removeItem(int)">removeItem</a></strong>(int&nbsp;location)</code>
<div class="block">Remove the item at the specified location from this List.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/List.html#removeItem(org.odftoolkit.simple.text.list.ListItem)">removeItem</a></strong>(<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&nbsp;item)</code>
<div class="block">Remove the specified item from this 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/List.html#removeItems(java.util.List)">removeItems</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&gt;&nbsp;items)</code>
<div class="block">Remove all the items in the collection from this list</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/List.html#set(int, org.odftoolkit.simple.text.list.ListItem)">set</a></strong>(int&nbsp;location,
<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&nbsp;item)</code>
<div class="block">Replace the item at the specified location in this List with the
specified item.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/odftoolkit/simple/text/list/List.html#set(int, java.lang.String)">set</a></strong>(int&nbsp;location,
<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;itemContent)</code>
<div class="block">Replace the item at the specified location in this List with the
specified item 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/List.html#setContinueList(org.odftoolkit.simple.text.list.List)">setContinueList</a></strong>(<a href="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&nbsp;continueList)</code>
<div class="block">Set the list whose numbering is continued by this list.</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/List.html#setContinueNumbering(boolean)">setContinueNumbering</a></strong>(boolean&nbsp;isContinueNumbering)</code>
<div class="block">Set whether the numbering of the preceding list is continued or not.</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/List.html#setDecorator(org.odftoolkit.simple.text.list.ListDecorator)">setDecorator</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">Set the ListDecorator of this list.</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/List.html#setHeader(java.lang.String)">setHeader</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;header)</code>
<div class="block">Set the header of this list.</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/List.html#size()">size</a></strong>()</code>
<div class="block">Return the number of direct child items in this List.</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/List.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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="List(org.odftoolkit.simple.text.list.ListContainer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>List</h4>
<pre>public&nbsp;List(<a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a>&nbsp;container)</pre>
<div class="block">Constructor with ListContainer only. A bullet list with default style
will be created.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>container</code> - the container in where this list will be appended.</dd></dl>
</li>
</ul>
<a name="List(org.odftoolkit.simple.text.list.ListContainer, org.odftoolkit.simple.text.list.ListDecorator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>List</h4>
<pre>public&nbsp;List(<a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a>&nbsp;container,
<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">Constructor with ListContainer and ListDecorator.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>container</code> - the container in where this list will be appended.</dd><dd><code>decorator</code> - the ListDecorator of this list.</dd></dl>
</li>
</ul>
<a name="List(org.odftoolkit.simple.text.list.ListContainer, java.lang.String, org.odftoolkit.simple.text.list.ListDecorator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>List</h4>
<pre>public&nbsp;List(<a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a>&nbsp;container,
<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;header,
<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">Constructor with ListContainer, ListDecorator and header.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>container</code> - the container in where this list will be appended.</dd><dd><code>decorator</code> - the ListDecorator of this list.</dd><dd><code>header</code> - the header of this list.</dd></dl>
</li>
</ul>
<a name="List(org.odftoolkit.simple.text.list.ListContainer, java.lang.String, boolean, org.odftoolkit.simple.text.list.ListDecorator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>List</h4>
<pre>public&nbsp;List(<a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a>&nbsp;container,
<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;header,
boolean&nbsp;isContinueNumbering,
<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">Constructor with ListContainer, ListDecorator, header and numbering setting.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>container</code> - the container in where this list will be appended.</dd><dd><code>decorator</code> - the ListDecorator of this list.</dd><dd><code>isContinueNumbering</code> - If <code>isContinueNumbering</code> is true, the numbering of this list is
continuing, otherwise the numbering of this list starts from the beginning.</dd><dd><code>header</code> - the header of this list.</dd></dl>
</li>
</ul>
<a name="List(org.odftoolkit.simple.text.list.ListContainer, java.lang.String, org.odftoolkit.simple.text.list.List, org.odftoolkit.simple.text.list.ListDecorator)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>List</h4>
<pre>public&nbsp;List(<a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface in org.odftoolkit.simple.text.list">ListContainer</a>&nbsp;container,
<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;header,
<a href="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&nbsp;continueList,
<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">Constructor with ListContainer, ListDecorator, header and continued list</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>container</code> - the container in where this list will be appended.</dd><dd><code>decorator</code> - the ListDecorator of this list.</dd><dd><code>continueList</code> - the continued list of this list.</dd><dd><code>header</code> - the header of this list.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>public&nbsp;<a href="../../../../../org/odftoolkit/simple/text/list/ListDecorator.ListType.html" title="enum in org.odftoolkit.simple.text.list">ListDecorator.ListType</a>&nbsp;getType()</pre>
<div class="block">Get the type of this list. The list type can be BULLET, NUMBER and IMAGE.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the list type.</dd></dl>
</li>
</ul>
<a name="getHeader()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeader</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;getHeader()</pre>
<div class="block">Get the header of this list.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the header of this list.</dd></dl>
</li>
</ul>
<a name="setHeader(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHeader</h4>
<pre>public&nbsp;void&nbsp;setHeader(<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;header)</pre>
<div class="block">Set the header of this list. The exist header will be replaced.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>header</code> - the header to be set.</dd></dl>
</li>
</ul>
<a name="setDecorator(org.odftoolkit.simple.text.list.ListDecorator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDecorator</h4>
<pre>public&nbsp;void&nbsp;setDecorator(<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">Set the ListDecorator of this list. The current ListDecorator will be
replaced.
<p>
This is a useful method which can change the list type and style, even
though it has been created.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>decorator</code> - the ListDecorator to be used.</dd></dl>
</li>
</ul>
<a name="addItem(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addItem</h4>
<pre>public&nbsp;<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&nbsp;addItem(<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;itemContent)</pre>
<div class="block">Add a list item by specifying a string value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>itemContent</code> - the list item content to be added.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the added ListItem.</dd></dl>
</li>
</ul>
<a name="addItem(int, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addItem</h4>
<pre>public&nbsp;<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&nbsp;addItem(int&nbsp;location,
<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;itemContent)</pre>
<div class="block">Insert the specified ListItem at the specified location.
The ListItem is inserted before the ListItem at the specified
location.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - the index to insert. The start number is 0.</dd><dd><code>itemContent</code> - the list item content to be added.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the added ListItem.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</a></code> - when the <code>location</code> is out of the List range.</dd></dl>
</li>
</ul>
<a name="addItem(org.odftoolkit.simple.text.list.ListItem)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addItem</h4>
<pre>public&nbsp;<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&nbsp;addItem(<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&nbsp;item)</pre>
<div class="block">Add the specified list item in ListItem object.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>item</code> - the list item to be added.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the added ListItem.</dd></dl>
</li>
</ul>
<a name="addItem(int, org.odftoolkit.simple.text.list.ListItem)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addItem</h4>
<pre>public&nbsp;<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&nbsp;addItem(int&nbsp;location,
<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&nbsp;item)</pre>
<div class="block">Insert a ListItem at the specified location.
The ListItem is inserted before the ListItem at the specified
location.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - the index to insert.</dd><dd><code>item</code> - the list item to add.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the added ListItem.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</a></code> - when the <code>location</code> is out of the List range.</dd></dl>
</li>
</ul>
<a name="addItems(java.lang.String[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addItems</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&gt;&nbsp;addItems(<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;items)</pre>
<div class="block">Add list items by specifying an array of string values.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>items</code> - the list items to be added.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the added items.</dd></dl>
</li>
</ul>
<a name="addItems(int, java.lang.String[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addItems</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&gt;&nbsp;addItems(int&nbsp;location,
<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;items)</pre>
<div class="block">Insert the list items at the specified location in this List
by giving an array of string values.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - the index to insert.</dd><dd><code>items</code> - the collection of list item contents.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the added items.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</a></code> - when the <code>location</code> is out of the List range.</dd></dl>
</li>
</ul>
<a name="addItems(org.odftoolkit.simple.text.list.ListItem[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addItems</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&gt;&nbsp;addItems(<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>[]&nbsp;items)</pre>
<div class="block">Add list items by specifying an array of ListItem.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>items</code> - the list items to be added.</dd></dl>
</li>
</ul>
<a name="addItems(int, org.odftoolkit.simple.text.list.ListItem[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addItems</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&gt;&nbsp;addItems(int&nbsp;location,
<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>[]&nbsp;items)</pre>
<div class="block">Insert the list items at the certain location
by specifying an array of ListItem.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - the index to insert.</dd><dd><code>items</code> - the collection of items.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the added items</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</a></code> - when the <code>location</code> is out of the List range.</dd></dl>
</li>
</ul>
<a name="getItem(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getItem</h4>
<pre>public&nbsp;<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&nbsp;getItem(int&nbsp;location)</pre>
<div class="block">Return the item at the specified location in this List.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - the index of the element to be returned.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the element at the specified location.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</a></code> - when the <code>location</code> is out of the List range.</dd></dl>
</li>
</ul>
<a name="getItems()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getItems</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&gt;&nbsp;getItems()</pre>
<div class="block">Get all of the list items.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>all of list items.</dd></dl>
</li>
</ul>
<a name="size()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>public&nbsp;int&nbsp;size()</pre>
<div class="block">Return the number of direct child items in this List.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the number of direct child items in this List.</dd></dl>
</li>
</ul>
<a name="set(int, org.odftoolkit.simple.text.list.ListItem)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>set</h4>
<pre>public&nbsp;<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&nbsp;set(int&nbsp;location,
<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&nbsp;item)</pre>
<div class="block">Replace the item at the specified location in this List with the
specified item.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - the index to put the specified item.</dd><dd><code>item</code> - the new item to be added.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the previous element at the index.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</a></code> - when the <code>location</code> is out of the List range.</dd></dl>
</li>
</ul>
<a name="set(int, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>set</h4>
<pre>public&nbsp;<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&nbsp;set(int&nbsp;location,
<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;itemContent)</pre>
<div class="block">Replace the item at the specified location in this List with the
specified item content.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - the index to insert. The start number is 0.</dd><dd><code>itemContent</code> - the list item content to be added.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the previous element at the index.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</a></code> - when the <code>location</code> is out of the List range.</dd></dl>
</li>
</ul>
<a name="removeItem(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeItem</h4>
<pre>public&nbsp;boolean&nbsp;removeItem(int&nbsp;location)</pre>
<div class="block">Remove the item at the specified location from this List.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - the index of the item to be removed.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if this List is modified, false otherwise.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</a></code> - when the <code>location</code> is out of the List range.</dd></dl>
</li>
</ul>
<a name="removeItem(org.odftoolkit.simple.text.list.ListItem)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeItem</h4>
<pre>public&nbsp;boolean&nbsp;removeItem(<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&nbsp;item)</pre>
<div class="block">Remove the specified item from this List.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>item</code> - the item to be removed.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if this List is modified, false otherwise.</dd></dl>
</li>
</ul>
<a name="removeItems(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeItems</h4>
<pre>public&nbsp;boolean&nbsp;removeItems(<a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</a>&gt;&nbsp;items)</pre>
<div class="block">Remove all the items in the collection from this list</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>items</code> - the collection of items to be removed.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if this List is modified, false otherwise.</dd></dl>
</li>
</ul>
<a name="clear()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>public&nbsp;void&nbsp;clear()</pre>
<div class="block">Remove all items from this List.</div>
</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 list from its container.</div>
</li>
</ul>
<a name="isContinueNumbering()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isContinueNumbering</h4>
<pre>public&nbsp;boolean&nbsp;isContinueNumbering()</pre>
<div class="block">Return whether the numbering of this list is continuing,
or whether the numbering of the preceding list is continued or not.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the numbering of this list is continuing,
false if not.</dd></dl>
</li>
</ul>
<a name="setContinueNumbering(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContinueNumbering</h4>
<pre>public&nbsp;void&nbsp;setContinueNumbering(boolean&nbsp;isContinueNumbering)</pre>
<div class="block">Set whether the numbering of the preceding list is continued or not. This
method will set the attribute "text:continue-numbering" of list element.
As ODF specification describes, this attribute is ignored, if attribute
<text:continue-list> is present, the user can call
<code>setContinueList(List)</code> to set this attribute. This method is
a easy way to set a list continue numbering, while
<code>setContinueList(List)</code> is an advance way to set a list
numbering. For example, there are three lists ListA, ListB and ListC in
order. If the user call set ListC.setContinueNumbering, the first list
item in ListC is the number of the last item in ListB incremented by one.
It easy, no need to get the reference of ListB. While if the user need
the first list item in ListC is the number of the last item in ListA
incremented by one, he must use ListC.setContinueList(ListA).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>isContinueNumbering</code> - If <code>isContinueNumbering</code> is true, and
text:continue-list attribute is not present and the numbering
style of the preceding list is the same as the current list,
the number of the first list item in the current list is the
number of the last item in the preceding list incremented by
one.the list is continue numbering, otherwise if the
text:continue-list attribute is not present, the numbering of
the preceding list is not continued.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/odftoolkit/simple/text/list/List.html#setContinueList(org.odftoolkit.simple.text.list.List)"><code>setContinueList(List)</code></a></dd></dl>
</li>
</ul>
<a name="getContinueList()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContinueList</h4>
<pre>public&nbsp;<a href="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&nbsp;getContinueList()</pre>
<div class="block">Get the preceding list whose numbering is continued by this list.
<p>Now only support to get the continued list reference in the same ListContainer and the same Level.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the continued list of this list. If the list has no continued list,
it will return null.</dd></dl>
</li>
</ul>
<a name="setContinueList(org.odftoolkit.simple.text.list.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContinueList</h4>
<pre>public&nbsp;void&nbsp;setContinueList(<a href="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</a>&nbsp;continueList)</pre>
<div class="block">Set the list whose numbering is continued by this list.
This is an advance way to set a list
numbering. For example, there are three lists ListA, ListB and ListC in
order. If the user needs the first list item in ListC is the number of the
last item in ListA incremented by one, he must use
ListC.setContinueList(ListA).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>continueList</code> - the continued list of this list.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/odftoolkit/simple/text/list/List.html#setContinueNumbering(boolean)"><code>setContinueNumbering(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="getLevel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLevel</h4>
<pre>public&nbsp;int&nbsp;getLevel()</pre>
<div class="block">Get the level of this list.
<p>
Every list has a list level. If a list is not contained in another list,
its list level is 1. If a list is contained within another list, the list
level of the contained list is the list level of the list in which it is
contained incremented by one. If a list is contained in a table cell or
text box, its list level returns to 1, even though the table or text box
may be nested in another list. Every list with a list level of 1 defines
a list and the counter domain for its list items and any sub list of that
list. Each sub list starts a counter for its list items and any sub list
it may contain.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>list level.</dd></dl>
</li>
</ul>
<a name="getOdfElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOdfElement</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.dom.element.text.TextListElement&nbsp;getOdfElement()</pre>
<div class="block">Get the instance of TextListElement which represents this list.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the instance of TextListElement.</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<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>
</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/List.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/ImageDecorator.html" title="class in org.odftoolkit.simple.text.list"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/odftoolkit/simple/text/list/ListContainer.html" title="interface 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/List.html" target="_top">Frames</a></li>
<li><a href="List.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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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>