Google Git
Sign in
apache / incubator-odftoolkit-site / d22ef2d53769a0a209d42b84c8275ad1d8522260 / . / content / odftoolkit / mvn-site / 0.8-incubating / simple-odf / apidocs / org / odftoolkit / simple / table / TableContainer.html
blob: 260c5be59634327dcca0b65f43333d2abb63dfcb [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:16 CET 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>TableContainer (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="TableContainer (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/TableContainer.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/table/Table.TableBuilder.html" title="class in org.odftoolkit.simple.table"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/table/TableTemplate.html" title="class in org.odftoolkit.simple.table"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/table/TableContainer.html" target="_top">Frames</a></li>
<li><a href="TableContainer.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.table</div>
<h2 title="Interface TableContainer" class="title">Interface TableContainer</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<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>
<br>
<pre>public interface <span class="strong">TableContainer</span></pre>
<div class="block">TableContainer is a container which maintains Table(s) as element(s).
Table(s) can be added, removed and iterated in this container.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>0.4.5</dd>
<dt><span class="strong">See Also:</span></dt><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></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/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#addTable()">addTable</a></strong>()</code>
<div class="block">Add a new Table to this container.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#addTable(int, int)">addTable</a></strong>(int&nbsp;numRows,
int&nbsp;numCols)</code>
<div class="block">Add a new Table to this container with a specified row number and column
number.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/table/Table.TableBuilder.html" title="class in org.odftoolkit.simple.table">Table.TableBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableBuilder()">getTableBuilder</a></strong>()</code>
<div class="block">Return the table builder of this document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableByName(java.lang.String)">getTableByName</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Return an instance of table feature with the specific table name.</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/table/TableContainer.html#getTableContainerElement()">getTableContainerElement</a></strong>()</code>
<div class="block">Get the ODF element which can have
<table:table>
as child element directly according to ODF specification.</div>
</td>
</tr>
<tr class="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/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/table/TableContainer.html#getTableList()">getTableList</a></strong>()</code>
<div class="block">Return a list of table features in this document.</div>
</td>
</tr>
</table>
</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="getTableContainerElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTableContainerElement</h4>
<pre>org.odftoolkit.odfdom.pkg.OdfElement&nbsp;getTableContainerElement()</pre>
<div class="block">Get the ODF element which can have
<table:table>
as child element directly according to ODF specification. This Element
will help to find the position to insert a new Table. For example,
<table:table>
element is usable with <office:text> element, so TextDocument will return
OfficeTextElement. While Presentation Notes is an indirectly
TableContainer, which holds Table with the help of its grand-child
element <draw:text-box>, so for Notes, DrawTextBoxElement should be
return.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>container element which can hold <text:table>.</dd></dl>
</li>
</ul>
<a name="addTable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTable</h4>
<pre><a href="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>&nbsp;addTable()</pre>
<div class="block">Add a new Table to this container.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>added table.</dd></dl>
</li>
</ul>
<a name="addTable(int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTable</h4>
<pre><a href="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>&nbsp;addTable(int&nbsp;numRows,
int&nbsp;numCols)</pre>
<div class="block">Add a new Table to this container with a specified row number and column
number.
<p>
The table will be inserted at the end of the tableContainer. An unique
table name will be given, you may set a custom table name using the
<code>setTableName</code> method.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>numRows</code> - the row number</dd><dd><code>numCols</code> - the column number</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new instance of <code>Table</code></dd></dl>
</li>
</ul>
<a name="getTableByName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTableByName</h4>
<pre><a href="../../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>&nbsp;getTableByName(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Return an instance of table feature with the specific table name.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - of the table being searched for.</dd>
<dt><span class="strong">Returns:</span></dt><dd>an instance of table feature with the specific table name.</dd></dl>
</li>
</ul>
<a name="getTableList()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTableList</h4>
<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;&nbsp;getTableList()</pre>
<div class="block">Return a list of table features in this document.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a list of table features in this document.</dd></dl>
</li>
</ul>
<a name="getTableBuilder()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getTableBuilder</h4>
<pre><a href="../../../../org/odftoolkit/simple/table/Table.TableBuilder.html" title="class in org.odftoolkit.simple.table">Table.TableBuilder</a>&nbsp;getTableBuilder()</pre>
<div class="block">Return the table builder of this document. Every document has a table
builder, which supplies all of the table creation realization, for
example newTable().</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the table builder of this document.</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/TableContainer.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/table/Table.TableBuilder.html" title="class in org.odftoolkit.simple.table"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/table/TableTemplate.html" title="class in org.odftoolkit.simple.table"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/table/TableContainer.html" target="_top">Frames</a></li>
<li><a href="TableContainer.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>