| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_45) on Tue Mar 28 22:15:31 CEST 2017 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| ListContainer (Simple ODF v0.8.2-incubating - http://odftoolkit) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2017-03-28"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ListContainer (Simple ODF v0.8.2-incubating - http://odftoolkit)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ListContainer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/odftoolkit/simple/text/list/ListDecorator.html" title="interface in org.odftoolkit.simple.text.list"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/odftoolkit/simple/text/list/ListContainer.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ListContainer.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.odftoolkit.simple.text.list</FONT> |
| <BR> |
| Interface ListContainer</H2> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/odftoolkit/simple/text/list/AbstractListContainer.html" title="class in org.odftoolkit.simple.text.list">AbstractListContainer</A>, <A HREF="../../../../../org/odftoolkit/simple/table/Cell.html" title="class in org.odftoolkit.simple.table">Cell</A>, <A HREF="../../../../../org/odftoolkit/simple/text/list/ListItem.html" title="class in org.odftoolkit.simple.text.list">ListItem</A>, <A HREF="../../../../../org/odftoolkit/simple/presentation/Notes.html" title="class in org.odftoolkit.simple.presentation">Notes</A>, <A HREF="../../../../../org/odftoolkit/simple/text/Section.html" title="class in org.odftoolkit.simple.text">Section</A>, <A HREF="../../../../../org/odftoolkit/simple/presentation/Slide.html" title="class in org.odftoolkit.simple.presentation">Slide</A>, <A HREF="../../../../../org/odftoolkit/simple/draw/Textbox.html" title="class in org.odftoolkit.simple.draw">Textbox</A>, <A HREF="../../../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>ListContainer</B></DL> |
| </PRE> |
| |
| <P> |
| ListContainer is a container which maintains List(s) as element(s). List(s) |
| can be added, removed and iterated in this container. |
| <p> |
| All of the components which need to hold a List, must implement this |
| interface. For example, <text:list> element is under <office:text> |
| element according to ODF specification. So TextDocument is a type of |
| ListContainer which holds List directly. TextDocument must implement this |
| interface. While Presentation Notes is also a type of ListContainer, although |
| <presentation:notes> is not a element with which the <text:list> element is |
| usable. <presentation:notes> can have child element <draw:frame> and |
| <draw:frame> can have child element <draw:text-box>. <text:list> is usable |
| with the <draw:text-box> element. Notes is an indirectly ListContainer which |
| let user operate List easily. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>0.4</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list"><CODE>List</CODE></A>, |
| <A HREF="../../../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple"><CODE>TextDocument</CODE></A>, |
| <A HREF="../../../../../org/odftoolkit/simple/presentation/Notes.html" title="class in org.odftoolkit.simple.presentation"><CODE>Notes</CODE></A></DL> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/odftoolkit/simple/text/list/ListContainer.html#addList()">addList</A></B>()</CODE> |
| |
| <BR> |
| Add a new List to this container.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/odftoolkit/simple/text/list/ListContainer.html#addList(org.odftoolkit.simple.text.list.ListDecorator)">addList</A></B>(<A HREF="../../../../../org/odftoolkit/simple/text/list/ListDecorator.html" title="interface in org.odftoolkit.simple.text.list">ListDecorator</A> decorator)</CODE> |
| |
| <BR> |
| Add a List with specified ListDecorator to this container.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/odftoolkit/simple/text/list/ListContainer.html#clearList()">clearList</A></B>()</CODE> |
| |
| <BR> |
| Remove all Lists from this container.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfElement</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/odftoolkit/simple/text/list/ListContainer.html#getListContainerElement()">getListContainerElement</A></B>()</CODE> |
| |
| <BR> |
| Get the ODF element which can have <text:list> as child |
| element directly according to ODF specification.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/odftoolkit/simple/text/list/ListContainer.html#getListIterator()">getListIterator</A></B>()</CODE> |
| |
| <BR> |
| Return an Iterator of the Lists in this ListContainer.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/odftoolkit/simple/text/list/ListContainer.html#removeList(org.odftoolkit.simple.text.list.List)">removeList</A></B>(<A HREF="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</A> list)</CODE> |
| |
| <BR> |
| Remove the existing List from this container.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getListContainerElement()"><!-- --></A><H3> |
| getListContainerElement</H3> |
| <PRE> |
| <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfElement</A> <B>getListContainerElement</B>()</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>container element which can hold <text:list>.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addList()"><!-- --></A><H3> |
| addList</H3> |
| <PRE> |
| <A HREF="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</A> <B>addList</B>()</PRE> |
| <DL> |
| <DD>Add a new List to this container. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>added list.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addList(org.odftoolkit.simple.text.list.ListDecorator)"><!-- --></A><H3> |
| addList</H3> |
| <PRE> |
| <A HREF="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</A> <B>addList</B>(<A HREF="../../../../../org/odftoolkit/simple/text/list/ListDecorator.html" title="interface in org.odftoolkit.simple.text.list">ListDecorator</A> decorator)</PRE> |
| <DL> |
| <DD>Add a List with specified ListDecorator to this container. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>decorator</CODE> - the specified ListDecorator |
| <DT><B>Returns:</B><DD>added list.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeList(org.odftoolkit.simple.text.list.List)"><!-- --></A><H3> |
| removeList</H3> |
| <PRE> |
| boolean <B>removeList</B>(<A HREF="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</A> list)</PRE> |
| <DL> |
| <DD>Remove the existing List from this container. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>true, if the container contains this List.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="clearList()"><!-- --></A><H3> |
| clearList</H3> |
| <PRE> |
| void <B>clearList</B>()</PRE> |
| <DL> |
| <DD>Remove all Lists from this container. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getListIterator()"><!-- --></A><H3> |
| getListIterator</H3> |
| <PRE> |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list">List</A>> <B>getListIterator</B>()</PRE> |
| <DL> |
| <DD>Return an Iterator of the Lists in this ListContainer. The Lists are |
| iterated in the same order that they occur in the ListContainer. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>an Iterator of the Lists in this ListContainer<DT><B>See Also:</B><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></DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ListContainer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/odftoolkit/simple/text/list/List.html" title="class in org.odftoolkit.simple.text.list"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/odftoolkit/simple/text/list/ListDecorator.html" title="interface in org.odftoolkit.simple.text.list"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/odftoolkit/simple/text/list/ListContainer.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ListContainer.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2010-2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
