blob: 36a697c612d6fd2f388c4949bae3b2203e1c5c4d [file] [log] [blame]
<!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>
TableContainer (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="TableContainer (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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/TableContainer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/odftoolkit/simple/table/Table.TableBuilder.html" title="class in org.odftoolkit.simple.table"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/odftoolkit/simple/table/TableTemplate.html" title="class in org.odftoolkit.simple.table"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/odftoolkit/simple/table/TableContainer.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="TableContainer.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<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.table</FONT>
<BR>
Interface TableContainer</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/odftoolkit/simple/table/AbstractTableContainer.html" title="class in org.odftoolkit.simple.table">AbstractTableContainer</A>, <A HREF="../../../../org/odftoolkit/simple/ChartDocument.html" title="class in org.odftoolkit.simple">ChartDocument</A>, <A HREF="../../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</A>, <A HREF="../../../../org/odftoolkit/simple/text/Footer.html" title="class in org.odftoolkit.simple.text">Footer</A>, <A HREF="../../../../org/odftoolkit/simple/GraphicsDocument.html" title="class in org.odftoolkit.simple">GraphicsDocument</A>, <A HREF="../../../../org/odftoolkit/simple/text/Header.html" title="class in org.odftoolkit.simple.text">Header</A>, <A HREF="../../../../org/odftoolkit/simple/PresentationDocument.html" title="class in org.odftoolkit.simple">PresentationDocument</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/SpreadsheetDocument.html" title="class in org.odftoolkit.simple">SpreadsheetDocument</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>TableContainer</B></DL>
</PRE>
<P>
TableContainer is a container which maintains Table(s) as element(s).
Table(s) can be added, removed and iterated in this container.
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>0.4.5</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table"><CODE>Table</CODE></A>,
<A HREF="../../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple"><CODE>TextDocument</CODE></A>,
<A HREF="../../../../org/odftoolkit/simple/SpreadsheetDocument.html" title="class in org.odftoolkit.simple"><CODE>SpreadsheetDocument</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>&nbsp;<A HREF="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html#addTable()">addTable</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a new Table to this container.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html#addTable(int, int)">addTable</A></B>(int&nbsp;numRows,
int&nbsp;numCols)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a new Table to this container with a specified row number and column
number.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/odftoolkit/simple/table/Table.TableBuilder.html" title="class in org.odftoolkit.simple.table">Table.TableBuilder</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableBuilder()">getTableBuilder</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the table builder of this document.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableByName(java.lang.String)">getTableByName</A></B>(<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;name)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return an instance of table feature with the specific table name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<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/table/TableContainer.html#getTableContainerElement()">getTableContainerElement</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the ODF element which can have
<table:table>
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>&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/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A>&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableList()">getTableList</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a list of table features in this document.</TD>
</TR>
</TABLE>
&nbsp;
<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="getTableContainerElement()"><!-- --></A><H3>
getTableContainerElement</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>getTableContainerElement</B>()</PRE>
<DL>
<DD>Get the ODF element which can have
<table:table>
as child element directly according to ODF specification. This Element
will help to find the position to insert a new Table. For example,
<table:table>
element is usable with <office:text> element, so TextDocument will return
OfficeTextElement. While Presentation Notes is an indirectly
TableContainer, which holds Table with the help of its grand-child
element <draw:text-box>, so for Notes, DrawTextBoxElement should be
return.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>container element which can hold <text:table>.</DL>
</DD>
</DL>
<HR>
<A NAME="addTable()"><!-- --></A><H3>
addTable</H3>
<PRE>
<A HREF="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A> <B>addTable</B>()</PRE>
<DL>
<DD>Add a new Table to this container.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>added table.</DL>
</DD>
</DL>
<HR>
<A NAME="addTable(int, int)"><!-- --></A><H3>
addTable</H3>
<PRE>
<A HREF="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A> <B>addTable</B>(int&nbsp;numRows,
int&nbsp;numCols)</PRE>
<DL>
<DD>Add a new Table to this container with a specified row number and column
number.
<p>
The table will be inserted at the end of the tableContainer. An unique
table name will be given, you may set a custom table name using the
<code>setTableName</code> method.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>numRows</CODE> - the row number<DD><CODE>numCols</CODE> - the column number
<DT><B>Returns:</B><DD>a new instance of <code>Table</code></DL>
</DD>
</DL>
<HR>
<A NAME="getTableByName(java.lang.String)"><!-- --></A><H3>
getTableByName</H3>
<PRE>
<A HREF="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A> <B>getTableByName</B>(<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;name)</PRE>
<DL>
<DD>Return an instance of table feature with the specific table name.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - of the table being searched for.
<DT><B>Returns:</B><DD>an instance of table feature with the specific table name.</DL>
</DD>
</DL>
<HR>
<A NAME="getTableList()"><!-- --></A><H3>
getTableList</H3>
<PRE>
<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/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A>&gt; <B>getTableList</B>()</PRE>
<DL>
<DD>Return a list of table features in this document.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a list of table features in this document.</DL>
</DD>
</DL>
<HR>
<A NAME="getTableBuilder()"><!-- --></A><H3>
getTableBuilder</H3>
<PRE>
<A HREF="../../../../org/odftoolkit/simple/table/Table.TableBuilder.html" title="class in org.odftoolkit.simple.table">Table.TableBuilder</A> <B>getTableBuilder</B>()</PRE>
<DL>
<DD>Return the table builder of this document. Every document has a table
builder, which supplies all of the table creation realization, for
example newTable().
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the table builder of this document.</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/TableContainer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/odftoolkit/simple/table/Table.TableBuilder.html" title="class in org.odftoolkit.simple.table"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/odftoolkit/simple/table/TableTemplate.html" title="class in org.odftoolkit.simple.table"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/odftoolkit/simple/table/TableContainer.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="TableContainer.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright &#169; 2010-2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
</BODY>
</HTML>