Google Git
Sign in
apache / incubator-odftoolkit-site / d22ef2d53769a0a209d42b84c8275ad1d8522260 / . / content / odftoolkit / mvn-site / 0.8-incubating / simple-odf / apidocs / org / odftoolkit / simple / SpreadsheetDocument.html
blob: d7d1fa91a5d8d9cc7d1af28176d48fe54f613ec5 [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>SpreadsheetDocument (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="SpreadsheetDocument (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/SpreadsheetDocument.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/PresentationDocument.PresentationClass.html" title="enum in org.odftoolkit.simple"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/odftoolkit/simple/SpreadsheetDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/odftoolkit/simple/SpreadsheetDocument.html" target="_top">Frames</a></li>
<li><a href="SpreadsheetDocument.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><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields_inherited_from_class_org.odftoolkit.odfdom.dom.OdfSchemaDocument">Field</a>&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</div>
<h2 title="Class SpreadsheetDocument" class="title">Class SpreadsheetDocument</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.odfdom.pkg.OdfPackageDocument</li>
<li>
<ul class="inheritance">
<li>org.odftoolkit.odfdom.dom.OdfSchemaDocument</li>
<li>
<ul class="inheritance">
<li><a href="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">org.odftoolkit.simple.Document</a></li>
<li>
<ul class="inheritance">
<li>org.odftoolkit.simple.SpreadsheetDocument</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="../../../org/odftoolkit/simple/chart/ChartContainer.html" title="interface in org.odftoolkit.simple.chart">ChartContainer</a>, <a href="../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">SpreadsheetDocument</span>
extends <a href="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</a>
implements <a href="../../../org/odftoolkit/simple/chart/ChartContainer.html" title="interface in org.odftoolkit.simple.chart">ChartContainer</a></pre>
<div class="block">This class represents an empty ODF spreadsheet document.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/SpreadsheetDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple">SpreadsheetDocument.OdfMediaType</a></strong></code>
<div class="block">This enum contains all possible media types of SpreadsheetDocument
documents.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_org.odftoolkit.simple.Document">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.odftoolkit.simple.<a href="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</a></h3>
<code><a href="../../../org/odftoolkit/simple/Document.ScriptType.html" title="enum in org.odftoolkit.simple">Document.ScriptType</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_org.odftoolkit.odfdom.dom.OdfSchemaDocument">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.odftoolkit.odfdom.dom.OdfSchemaDocument</h3>
<code>org.odftoolkit.odfdom.dom.OdfSchemaDocument.OdfXMLFile</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_org.odftoolkit.odfdom.pkg.OdfPackageDocument">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.odftoolkit.odfdom.pkg.OdfPackageDocument</h3>
<code>org.odftoolkit.odfdom.pkg.OdfPackageDocument.Resource</code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.odftoolkit.odfdom.dom.OdfSchemaDocument">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.odftoolkit.odfdom.dom.OdfSchemaDocument</h3>
<code>mContentDom, mDocumentStyles, mMetaDom, mSettingsDom, mStylesDom</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.odftoolkit.odfdom.pkg.OdfPackageDocument">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.odftoolkit.odfdom.pkg.OdfPackageDocument</h3>
<code>mDocumentMediaType, mDocumentPathInPackage, mPackage, ROOT_DOCUMENT_PATH</code></li>
</ul>
</li>
</ul>
<!-- ======== 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="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html#SpreadsheetDocument(org.odftoolkit.odfdom.pkg.OdfPackage, java.lang.String, org.odftoolkit.simple.SpreadsheetDocument.OdfMediaType)">SpreadsheetDocument</a></strong>(org.odftoolkit.odfdom.pkg.OdfPackage&nbsp;pkg,
<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;internalPath,
<a href="../../../org/odftoolkit/simple/SpreadsheetDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple">SpreadsheetDocument.OdfMediaType</a>&nbsp;odfMediaType)</code>
<div class="block">To avoid data duplication a new document is only created, if not already
opened.</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/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html#appendSheet(java.lang.String)">appendSheet</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">Adds a new blank sheet with the specified <code>name</code> to 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/SpreadsheetDocument.html#appendSheet(org.odftoolkit.simple.table.Table, java.lang.String)">appendSheet</a></strong>(<a href="../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>&nbsp;refTable,
<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">Adds a new sheet with data from existing table.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html#changeMode(org.odftoolkit.simple.SpreadsheetDocument.OdfMediaType)">changeMode</a></strong>(<a href="../../../org/odftoolkit/simple/SpreadsheetDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple">SpreadsheetDocument.OdfMediaType</a>&nbsp;mediaType)</code>
<div class="block">Changes the document to the given mediatype.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html#createChart(java.lang.String, org.odftoolkit.simple.chart.DataSet, java.awt.Rectangle)">createChart</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;title,
<a href="../../../org/odftoolkit/simple/chart/DataSet.html" title="class in org.odftoolkit.simple.chart">DataSet</a>&nbsp;dataset,
<a href="http://download.oracle.com/javase/6/docs/api/java/awt/Rectangle.html?is-external=true" title="class or interface in java.awt">Rectangle</a>&nbsp;rect)</code>
<div class="block">Creates a new Chart for this spreadsheet document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html#createChart(java.lang.String, org.odftoolkit.simple.SpreadsheetDocument, org.odftoolkit.odfdom.type.CellRangeAddressList, boolean, boolean, boolean, java.awt.Rectangle)">createChart</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;title,
<a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html" title="class in org.odftoolkit.simple">SpreadsheetDocument</a>&nbsp;document,
org.odftoolkit.odfdom.type.CellRangeAddressList&nbsp;cellRangeAddr,
boolean&nbsp;firstRowAsLabel,
boolean&nbsp;firstColumnAsLabel,
boolean&nbsp;rowAsDataSeries,
<a href="http://download.oracle.com/javase/6/docs/api/java/awt/Rectangle.html?is-external=true" title="class or interface in java.awt">Rectangle</a>&nbsp;rect)</code>
<div class="block">Creates a new Chart for this spreadsheet document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html#createChart(java.lang.String, org.odftoolkit.simple.SpreadsheetDocument, org.odftoolkit.odfdom.type.CellRangeAddressList, boolean, boolean, boolean, java.awt.Rectangle, org.odftoolkit.simple.table.Cell)">createChart</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;title,
<a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html" title="class in org.odftoolkit.simple">SpreadsheetDocument</a>&nbsp;document,
org.odftoolkit.odfdom.type.CellRangeAddressList&nbsp;cellRangeAddr,
boolean&nbsp;firstRowAsLabel,
boolean&nbsp;firstColumnAsLabel,
boolean&nbsp;rowAsDataSeries,
<a href="http://download.oracle.com/javase/6/docs/api/java/awt/Rectangle.html?is-external=true" title="class or interface in java.awt">Rectangle</a>&nbsp;rect,
<a href="../../../org/odftoolkit/simple/table/Cell.html" title="class in org.odftoolkit.simple.table">Cell</a>&nbsp;cell)</code>
<div class="block">Creates a new Chart for this spreadsheet document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html#createChart(java.lang.String, java.lang.String[], java.lang.String[], double[][], java.awt.Rectangle)">createChart</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;title,
<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;labels,
<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;legends,
double[][]&nbsp;data,
<a href="http://download.oracle.com/javase/6/docs/api/java/awt/Rectangle.html?is-external=true" title="class or interface in java.awt">Rectangle</a>&nbsp;rect)</code>
<div class="block">Creates a new Chart for this spreadsheet document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html#deleteChartById(java.lang.String)">deleteChartById</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;chartId)</code>
<div class="block">Deletes chart by chart id.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html#deleteChartByTitle(java.lang.String)">deleteChartByTitle</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;title)</code>
<div class="block">Deletes chart(s) by chart title.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html#getChartById(java.lang.String)">getChartById</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;chartId)</code>
<div class="block">Gets chart with specified id.</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/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html#getChartByTitle(java.lang.String)">getChartByTitle</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;title)</code>
<div class="block">Gets chart list with specified title.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html#getChartCount()">getChartCount</a></strong>()</code>
<div class="block">Returns the chart count of this container</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.odftoolkit.odfdom.dom.element.office.OfficeSpreadsheetElement</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html#getContentRoot()">getContentRoot</a></strong>()</code>
<div class="block">Get the content root of a spreadsheet 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/SpreadsheetDocument.html#getSheetByIndex(int)">getSheetByIndex</a></strong>(int&nbsp;index)</code>
<div class="block">Retrieves sheet by index.</div>
</td>
</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/SpreadsheetDocument.html#getSheetByName(java.lang.String)">getSheetByName</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">Retrieves sheet by name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html#getSheetCount()">getSheetCount</a></strong>()</code>
<div class="block">Returns the sheet count of this document.</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/SpreadsheetDocument.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="../../../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/SpreadsheetDocument.html#insertSheet(int)">insertSheet</a></strong>(int&nbsp;before)</code>
<div class="block">Inserts a new blank sheet before the reference index.</div>
</td>
</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/SpreadsheetDocument.html#insertSheet(org.odftoolkit.simple.table.Table, int)">insertSheet</a></strong>(<a href="../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>&nbsp;refTable,
int&nbsp;before)</code>
<div class="block">Inserts a new sheet with data from existing table.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html" title="class in org.odftoolkit.simple">SpreadsheetDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html#loadDocument(java.io.File)">loadDocument</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file)</code>
<div class="block">Creates an SpreadsheetDocument from the OpenDocument provided by a File.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html" title="class in org.odftoolkit.simple">SpreadsheetDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html#loadDocument(java.io.InputStream)">loadDocument</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;inputStream)</code>
<div class="block">Creates an SpreadsheetDocument from the OpenDocument provided by a
resource Stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html" title="class in org.odftoolkit.simple">SpreadsheetDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html#loadDocument(java.lang.String)">loadDocument</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;documentPath)</code>
<div class="block">Loads an SpreadsheetDocument from the provided path.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html" title="class in org.odftoolkit.simple">SpreadsheetDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html#newSpreadsheetDocument()">newSpreadsheetDocument</a></strong>()</code>
<div class="block">Creates an empty spreadsheet document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html" title="class in org.odftoolkit.simple">SpreadsheetDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html#newSpreadsheetTemplateDocument()">newSpreadsheetTemplateDocument</a></strong>()</code>
<div class="block">Creates an empty spreadsheet template.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html#removeSheet(int)">removeSheet</a></strong>(int&nbsp;index)</code>
<div class="block">Removes the sheet in the specified <code>index</code>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.odftoolkit.simple.Document">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.odftoolkit.simple.<a href="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</a></h3>
<code><a href="../../../org/odftoolkit/simple/Document.html#addTable()">addTable</a>, <a href="../../../org/odftoolkit/simple/Document.html#addTable(int, int)">addTable</a>, <a href="../../../org/odftoolkit/simple/Document.html#close()">close</a>, <a href="../../../org/odftoolkit/simple/Document.html#getComponentMap()">getComponentMap</a>, <a href="../../../org/odftoolkit/simple/Document.html#getContentRoot(java.lang.Class)">getContentRoot</a>, <a href="../../../org/odftoolkit/simple/Document.html#getEmbeddedDocument(java.lang.String)">getEmbeddedDocument</a>, <a href="../../../org/odftoolkit/simple/Document.html#getEmbeddedDocuments()">getEmbeddedDocuments</a>, <a href="../../../org/odftoolkit/simple/Document.html#getEmbeddedDocuments(org.odftoolkit.simple.Document.OdfMediaType)">getEmbeddedDocuments</a>, <a href="../../../org/odftoolkit/simple/Document.html#getLocale(org.odftoolkit.simple.Document.ScriptType)">getLocale</a>, <a href="../../../org/odftoolkit/simple/Document.html#getOdfMediaType()">getOdfMediaType</a>, <a href="../../../org/odftoolkit/simple/Document.html#getOfficeMetadata()">getOfficeMetadata</a>, <a href="../../../org/odftoolkit/simple/Document.html#getScriptType(java.util.Locale)">getScriptType</a>, <a href="../../../org/odftoolkit/simple/Document.html#getSectionByName(java.lang.String)">getSectionByName</a>, <a href="../../../org/odftoolkit/simple/Document.html#getSectionIterator()">getSectionIterator</a>, <a href="../../../org/odftoolkit/simple/Document.html#getTableBuilder()">getTableBuilder</a>, <a href="../../../org/odftoolkit/simple/Document.html#getTableByName(java.lang.String)">getTableByName</a>, <a href="../../../org/odftoolkit/simple/Document.html#getTableContainerImpl()">getTableContainerImpl</a>, <a href="../../../org/odftoolkit/simple/Document.html#getTableList()">getTableList</a>, <a href="../../../org/odftoolkit/simple/Document.html#insertDocument(org.odftoolkit.odfdom.pkg.OdfPackageDocument, java.lang.String)">insertDocument</a>, <a href="../../../org/odftoolkit/simple/Document.html#loadDocument(java.io.File, java.lang.String)">loadDocument</a>, <a href="../../../org/odftoolkit/simple/Document.html#loadDocument(org.odftoolkit.odfdom.pkg.OdfPackage)">loadDocument</a>, <a href="../../../org/odftoolkit/simple/Document.html#loadDocument(org.odftoolkit.odfdom.pkg.OdfPackage, java.lang.String)">loadDocument</a>, <a href="../../../org/odftoolkit/simple/Document.html#loadDocument(java.lang.String, java.lang.String)">loadDocument</a>, <a href="../../../org/odftoolkit/simple/Document.html#LoadTableTemplateFromForeignTable(java.io.InputStream, java.lang.String)">LoadTableTemplateFromForeignTable</a>, <a href="../../../org/odftoolkit/simple/Document.html#loadTemplate(org.odftoolkit.odfdom.pkg.OdfPackageDocument.Resource, org.odftoolkit.simple.Document.OdfMediaType)">loadTemplate</a>, <a href="../../../org/odftoolkit/simple/Document.html#newImage(java.net.URI)">newImage</a>, <a href="../../../org/odftoolkit/simple/Document.html#removeElementLinkedResource(org.odftoolkit.odfdom.pkg.OdfElement)">removeElementLinkedResource</a>, <a href="../../../org/odftoolkit/simple/Document.html#save(java.io.File)">save</a>, <a href="../../../org/odftoolkit/simple/Document.html#save(java.io.File, java.lang.String)">save</a>, <a href="../../../org/odftoolkit/simple/Document.html#save(java.io.OutputStream)">save</a>, <a href="../../../org/odftoolkit/simple/Document.html#setLocale(java.util.Locale)">setLocale</a>, <a href="../../../org/odftoolkit/simple/Document.html#setLocale(java.util.Locale, org.odftoolkit.simple.Document.ScriptType)">setLocale</a>, <a href="../../../org/odftoolkit/simple/Document.html#setOdfMediaType(org.odftoolkit.simple.Document.OdfMediaType)">setOdfMediaType</a>, <a href="../../../org/odftoolkit/simple/Document.html#setPassword(java.lang.String)">setPassword</a>, <a href="../../../org/odftoolkit/simple/Document.html#toString()">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.odftoolkit.odfdom.dom.OdfSchemaDocument">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.odftoolkit.odfdom.dom.OdfSchemaDocument</h3>
<code>getBaseURI, getBookmarkRDFMetadata, getContentDom, getContentStream, getDocumentStyles, getFileDom, getInContentMetadata, getInContentMetadataFromCache, getManifestRDFMetadata, getMasterPages, getMetaDom, getMetaStream, getOfficeMasterStyles, getOrCreateDocumentStyles, getRDFMetadata, getSettingsDom, getSettingsStream, getStylesDom, getStylesStream, getTables, getXMLFilePath</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.odftoolkit.odfdom.pkg.OdfPackageDocument">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.odftoolkit.odfdom.pkg.OdfPackageDocument</h3>
<code>flushDoms, getDocumentPath, getFileDom, getMediaTypeString, getPackage, getXMLFileMetadata, isExternalReference, isRootDocument, loadSubDocument, normalizeDocumentPath, removeDocument, save, setMediaTypeString</code></li>
</ul>
<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="SpreadsheetDocument(org.odftoolkit.odfdom.pkg.OdfPackage, java.lang.String, org.odftoolkit.simple.SpreadsheetDocument.OdfMediaType)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SpreadsheetDocument</h4>
<pre>protected&nbsp;SpreadsheetDocument(org.odftoolkit.odfdom.pkg.OdfPackage&nbsp;pkg,
<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;internalPath,
<a href="../../../org/odftoolkit/simple/SpreadsheetDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple">SpreadsheetDocument.OdfMediaType</a>&nbsp;odfMediaType)</pre>
<div class="block">To avoid data duplication a new document is only created, if not already
opened. A document is cached by this constructor using the internalpath
as key.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="newSpreadsheetDocument()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newSpreadsheetDocument</h4>
<pre>public static&nbsp;<a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html" title="class in org.odftoolkit.simple">SpreadsheetDocument</a>&nbsp;newSpreadsheetDocument()
throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Creates an empty spreadsheet document.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>ODF spreadsheet document based on a default template*</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - - if the document could not be created</dd></dl>
</li>
</ul>
<a name="newSpreadsheetTemplateDocument()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newSpreadsheetTemplateDocument</h4>
<pre>public static&nbsp;<a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html" title="class in org.odftoolkit.simple">SpreadsheetDocument</a>&nbsp;newSpreadsheetTemplateDocument()
throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Creates an empty spreadsheet template.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>ODF spreadsheet template based on a default</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - - if the template could not be created</dd></dl>
</li>
</ul>
<a name="loadDocument(java.io.InputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadDocument</h4>
<pre>public static&nbsp;<a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html" title="class in org.odftoolkit.simple">SpreadsheetDocument</a>&nbsp;loadDocument(<a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;inputStream)
throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Creates an SpreadsheetDocument from the OpenDocument provided by a
resource Stream.
<p>
Since an InputStream does not provide the arbitrary (non sequentiell)
read access needed by SpreadsheetDocument, the InputStream is cached.
This usually takes more time compared to the other createInternalDocument
methods. An advantage of caching is that there are no problems
overwriting an input file.
</p>
<p>
If the resource stream is not a ODF spreadsheet document,
ClassCastException might be thrown.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>inputStream</code> - - the InputStream of the ODF spreadsheet document.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the spreadsheet document created from the given InputStream</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - - if the document could not be created.</dd></dl>
</li>
</ul>
<a name="loadDocument(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadDocument</h4>
<pre>public static&nbsp;<a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html" title="class in org.odftoolkit.simple">SpreadsheetDocument</a>&nbsp;loadDocument(<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;documentPath)
throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Loads an SpreadsheetDocument from the provided path.
<p>
SpreadsheetDocument relies on the file being available for read access
over the whole lifecycle of SpreadsheetDocument.
</p>
<p>
If the resource stream is not a ODF spreadsheet document,
ClassCastException might be thrown.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>documentPath</code> - - the path from where the document can be loaded</dd>
<dt><span class="strong">Returns:</span></dt><dd>the spreadsheet document from the given path or NULL if the media
type is not supported by SIMPLE.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - - if the document could not be created.</dd></dl>
</li>
</ul>
<a name="loadDocument(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadDocument</h4>
<pre>public static&nbsp;<a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html" title="class in org.odftoolkit.simple">SpreadsheetDocument</a>&nbsp;loadDocument(<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file)
throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Creates an SpreadsheetDocument from the OpenDocument provided by a File.
<p>
SpreadsheetDocument relies on the file being available for read access
over the whole lifecycle of SpreadsheetDocument.
</p>
<p>
If the resource stream is not a ODF spreadsheet document,
ClassCastException might be thrown.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - - a file representing the ODF spreadsheet document.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the spreadsheet document created from the given File</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - - if the document could not be created.</dd></dl>
</li>
</ul>
<a name="getContentRoot()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContentRoot</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.dom.element.office.OfficeSpreadsheetElement&nbsp;getContentRoot()
throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Get the content root of a spreadsheet document.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/Document.html#getContentRoot()">getContentRoot</a></code>&nbsp;in class&nbsp;<code><a href="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>content root, representing the office:spreadsheet tag</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the file DOM could not be created.</dd></dl>
</li>
</ul>
<a name="changeMode(org.odftoolkit.simple.SpreadsheetDocument.OdfMediaType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>changeMode</h4>
<pre>public&nbsp;void&nbsp;changeMode(<a href="../../../org/odftoolkit/simple/SpreadsheetDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple">SpreadsheetDocument.OdfMediaType</a>&nbsp;mediaType)</pre>
<div class="block">Changes the document to the given mediatype. This method can only be used
to convert a document to a related mediatype, e.g. template.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mediaType</code> - the related ODF mimetype</dd></dl>
</li>
</ul>
<a name="getSheetByIndex(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSheetByIndex</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>&nbsp;getSheetByIndex(int&nbsp;index)</pre>
<div class="block">Retrieves sheet by index.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - the index of the retrieved sheet, which starts from 0. If the
index value is out of range (index >= sheet count or index <
0), this method would return <code>null</code>.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd></dl>
</li>
</ul>
<a name="getSheetByName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSheetByName</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>&nbsp;getSheetByName(<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">Retrieves sheet by name.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the retrieved sheet.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd></dl>
</li>
</ul>
<a name="appendSheet(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendSheet</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>&nbsp;appendSheet(<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">Adds a new blank sheet with the specified <code>name</code> to this
document.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the new sheet.</dd>
<dt><span class="strong">Returns:</span></dt><dd>added sheet.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd></dl>
</li>
</ul>
<a name="appendSheet(org.odftoolkit.simple.table.Table, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendSheet</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>&nbsp;appendSheet(<a href="../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>&nbsp;refTable,
<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">Adds a new sheet with data from existing table.
<p>
NOTE: This method copies data from existing table, including linked
resources and styles, if the source table is not in the target document.
If these data has dependencies to other data of the source document, the
data dependencies will not be copied. For example, document A has two
sheets, "Sheet1" and "Sheet2". In "Sheet2", there is a cell with formula,
"=sum(Sheet1.A1:Sheet1.A10)". After copy the data of "Sheet2" to the new
sheet in document B, the result of this formula would be different or
even invalid in document B.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>refTable</code> - the reference table, which is the data source of the new
sheet.</dd><dd><code>name</code> - the name of the new sheet.</dd>
<dt><span class="strong">Returns:</span></dt><dd>added sheet.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd></dl>
</li>
</ul>
<a name="insertSheet(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>insertSheet</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>&nbsp;insertSheet(int&nbsp;before)</pre>
<div class="block">Inserts a new blank sheet before the reference index.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>before</code> - the reference index, which starts from 0. If the index value
is out of range (index >= sheet count or index < 0), this
method would return <code>null</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>inserted sheet.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd></dl>
</li>
</ul>
<a name="insertSheet(org.odftoolkit.simple.table.Table, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>insertSheet</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>&nbsp;insertSheet(<a href="../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</a>&nbsp;refTable,
int&nbsp;before)</pre>
<div class="block">Inserts a new sheet with data from existing table.
<p>
NOTE: This method copies data from existing table, including linked
resources and styles, if the source table is not in the target document.
If these data has dependencies to other data of the source document, the
data dependencies will not be copied. For example, document A has two
sheets, "Sheet1" and "Sheet2". In "Sheet2", there is a cell with formula,
"=sum(Sheet1.A1:Sheet1.A10)". After copy the data of "Sheet2" to the new
sheet in document B, the result of this formula would be different or
even invalid in document B.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>refTable</code> - the reference table, which is the data source of the new
sheet.</dd><dd><code>before</code> - the reference index, which starts from 0 and new sheet would
be inserted before it. If the index value is out of range
(index >= sheet count or index < 0), this method would return
<code>null</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>inserted sheet.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd></dl>
</li>
</ul>
<a name="removeSheet(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeSheet</h4>
<pre>public&nbsp;void&nbsp;removeSheet(int&nbsp;index)</pre>
<div class="block">Removes the sheet in the specified <code>index</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - the index of the removed sheet, which starts from 0. If the
index value is out of range (index >= sheet count or index <
0), this method would do nothing.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd></dl>
</li>
</ul>
<a name="getSheetCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSheetCount</h4>
<pre>public&nbsp;int&nbsp;getSheetCount()</pre>
<div class="block">Returns the sheet count of this document.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the sheet count of this document.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd></dl>
</li>
</ul>
<a name="getTableContainerElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTableContainerElement</h4>
<pre>public&nbsp;org.odftoolkit.odfdom.pkg.OdfElement&nbsp;getTableContainerElement()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/table/TableContainer.html#getTableContainerElement()">TableContainer</a></code></strong></div>
<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><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/table/TableContainer.html#getTableContainerElement()">getTableContainerElement</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>container element which can hold <text:table>.</dd></dl>
</li>
</ul>
<a name="createChart(java.lang.String, org.odftoolkit.simple.chart.DataSet, java.awt.Rectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createChart</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a>&nbsp;createChart(<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;title,
<a href="../../../org/odftoolkit/simple/chart/DataSet.html" title="class in org.odftoolkit.simple.chart">DataSet</a>&nbsp;dataset,
<a href="http://download.oracle.com/javase/6/docs/api/java/awt/Rectangle.html?is-external=true" title="class or interface in java.awt">Rectangle</a>&nbsp;rect)</pre>
<div class="block">Creates a new Chart for this spreadsheet document.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#createChart(java.lang.String, org.odftoolkit.simple.chart.DataSet, java.awt.Rectangle)">createChart</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html" title="interface in org.odftoolkit.simple.chart">ChartContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>title</code> - chart title.</dd><dd><code>dataset</code> - chart data set.</dd><dd><code>rect</code> - chart rectangle.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the created chart.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd></dl>
</li>
</ul>
<a name="createChart(java.lang.String, org.odftoolkit.simple.SpreadsheetDocument, org.odftoolkit.odfdom.type.CellRangeAddressList, boolean, boolean, boolean, java.awt.Rectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createChart</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a>&nbsp;createChart(<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;title,
<a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html" title="class in org.odftoolkit.simple">SpreadsheetDocument</a>&nbsp;document,
org.odftoolkit.odfdom.type.CellRangeAddressList&nbsp;cellRangeAddr,
boolean&nbsp;firstRowAsLabel,
boolean&nbsp;firstColumnAsLabel,
boolean&nbsp;rowAsDataSeries,
<a href="http://download.oracle.com/javase/6/docs/api/java/awt/Rectangle.html?is-external=true" title="class or interface in java.awt">Rectangle</a>&nbsp;rect)</pre>
<div class="block">Creates a new Chart for this spreadsheet document.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#createChart(java.lang.String, org.odftoolkit.simple.SpreadsheetDocument, org.odftoolkit.odfdom.type.CellRangeAddressList, boolean, boolean, boolean, java.awt.Rectangle)">createChart</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html" title="interface in org.odftoolkit.simple.chart">ChartContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>title</code> - chart title.</dd><dd><code>document</code> - the data source spreadsheet document.</dd><dd><code>cellRangeAddr</code> - the cell range address list which is used as chart data set.</dd><dd><code>firstRowAsLabel</code> - whether uses first row as label.</dd><dd><code>firstColumnAsLabel</code> - whether uses first column as label.</dd><dd><code>rowAsDataSeries</code> - whether uses data as series.</dd><dd><code>rect</code> - chart rectangle.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the created chart.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd></dl>
</li>
</ul>
<a name="createChart(java.lang.String, java.lang.String[], java.lang.String[], double[][], java.awt.Rectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createChart</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a>&nbsp;createChart(<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;title,
<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;labels,
<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;legends,
double[][]&nbsp;data,
<a href="http://download.oracle.com/javase/6/docs/api/java/awt/Rectangle.html?is-external=true" title="class or interface in java.awt">Rectangle</a>&nbsp;rect)</pre>
<div class="block">Creates a new Chart for this spreadsheet document.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#createChart(java.lang.String, java.lang.String[], java.lang.String[], double[][], java.awt.Rectangle)">createChart</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html" title="interface in org.odftoolkit.simple.chart">ChartContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>title</code> - chart rectangle.</dd><dd><code>labels</code> - label strings</dd><dd><code>legends</code> - legend strings</dd><dd><code>data</code> - chart data set.</dd><dd><code>rect</code> - chart rectangle.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the created chart.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd></dl>
</li>
</ul>
<a name="createChart(java.lang.String, org.odftoolkit.simple.SpreadsheetDocument, org.odftoolkit.odfdom.type.CellRangeAddressList, boolean, boolean, boolean, java.awt.Rectangle, org.odftoolkit.simple.table.Cell)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createChart</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a>&nbsp;createChart(<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;title,
<a href="../../../org/odftoolkit/simple/SpreadsheetDocument.html" title="class in org.odftoolkit.simple">SpreadsheetDocument</a>&nbsp;document,
org.odftoolkit.odfdom.type.CellRangeAddressList&nbsp;cellRangeAddr,
boolean&nbsp;firstRowAsLabel,
boolean&nbsp;firstColumnAsLabel,
boolean&nbsp;rowAsDataSeries,
<a href="http://download.oracle.com/javase/6/docs/api/java/awt/Rectangle.html?is-external=true" title="class or interface in java.awt">Rectangle</a>&nbsp;rect,
<a href="../../../org/odftoolkit/simple/table/Cell.html" title="class in org.odftoolkit.simple.table">Cell</a>&nbsp;cell)</pre>
<div class="block">Creates a new Chart for this spreadsheet document.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>title</code> - chart rectangle.</dd><dd><code>document</code> - the data source spreadsheet document.</dd><dd><code>cellRangeAddr</code> - the cell range list to be used as chart data.</dd><dd><code>firstRowAsLabel</code> - whether use first row as label.</dd><dd><code>firstColumnAsLabel</code> - whether use first column as label.</dd><dd><code>rowAsDataSeries</code> - whether use row as data series.</dd><dd><code>rect</code> - chart rectangle.</dd><dd><code>cell</code> - the position cell where the new chart is inserted.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the created chart.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd></dl>
</li>
</ul>
<a name="deleteChartById(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteChartById</h4>
<pre>public&nbsp;void&nbsp;deleteChartById(<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;chartId)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#deleteChartById(java.lang.String)">ChartContainer</a></code></strong></div>
<div class="block">Deletes chart by chart id.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#deleteChartById(java.lang.String)">deleteChartById</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html" title="interface in org.odftoolkit.simple.chart">ChartContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>chartId</code> - the id of specified chart.</dd></dl>
</li>
</ul>
<a name="deleteChartByTitle(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteChartByTitle</h4>
<pre>public&nbsp;void&nbsp;deleteChartByTitle(<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;title)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#deleteChartByTitle(java.lang.String)">ChartContainer</a></code></strong></div>
<div class="block">Deletes chart(s) by chart title.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#deleteChartByTitle(java.lang.String)">deleteChartByTitle</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html" title="interface in org.odftoolkit.simple.chart">ChartContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>title</code> - the title of specified chart(s).</dd></dl>
</li>
</ul>
<a name="getChartById(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChartById</h4>
<pre>public&nbsp;<a href="../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a>&nbsp;getChartById(<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;chartId)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#getChartById(java.lang.String)">ChartContainer</a></code></strong></div>
<div class="block">Gets chart with specified id.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#getChartById(java.lang.String)">getChartById</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html" title="interface in org.odftoolkit.simple.chart">ChartContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>chartId</code> - the id of this chart.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the chart with specified id.</dd></dl>
</li>
</ul>
<a name="getChartByTitle(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChartByTitle</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/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a>&gt;&nbsp;getChartByTitle(<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;title)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#getChartByTitle(java.lang.String)">ChartContainer</a></code></strong></div>
<div class="block">Gets chart list with specified title.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#getChartByTitle(java.lang.String)">getChartByTitle</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html" title="interface in org.odftoolkit.simple.chart">ChartContainer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>title</code> - the title of specified chart(s).</dd>
<dt><span class="strong">Returns:</span></dt><dd>the chart(s) with specified title.</dd></dl>
</li>
</ul>
<a name="getChartCount()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getChartCount</h4>
<pre>public&nbsp;int&nbsp;getChartCount()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#getChartCount()">ChartContainer</a></code></strong></div>
<div class="block">Returns the chart count of this container</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html#getChartCount()">getChartCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/odftoolkit/simple/chart/ChartContainer.html" title="interface in org.odftoolkit.simple.chart">ChartContainer</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the chart count of this container</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/SpreadsheetDocument.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/PresentationDocument.PresentationClass.html" title="enum in org.odftoolkit.simple"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/odftoolkit/simple/SpreadsheetDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/odftoolkit/simple/SpreadsheetDocument.html" target="_top">Frames</a></li>
<li><a href="SpreadsheetDocument.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><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields_inherited_from_class_org.odftoolkit.odfdom.dom.OdfSchemaDocument">Field</a>&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>