blob: d694c23bc54edb7137f92041de61e942b511fb3d [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:26:21 CET 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>OdfSpreadsheetDocument (ODFDOM API v0.8.9-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="OdfSpreadsheetDocument (ODFDOM API v0.8.9-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/OdfSpreadsheetDocument.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/odfdom/doc/OdfPresentationDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/odfdom/doc/OdfSpreadsheetDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/odfdom/doc/OdfSpreadsheetDocument.html" target="_top">Frames</a></li>
<li><a href="OdfSpreadsheetDocument.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.odfdom.doc</div>
<h2 title="Class OdfSpreadsheetDocument" class="title">Class OdfSpreadsheetDocument</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><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">org.odftoolkit.odfdom.pkg.OdfPackageDocument</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html" title="class in org.odftoolkit.odfdom.dom">org.odftoolkit.odfdom.dom.OdfSchemaDocument</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html" title="class in org.odftoolkit.odfdom.doc">org.odftoolkit.odfdom.doc.OdfDocument</a></li>
<li>
<ul class="inheritance">
<li>org.odftoolkit.odfdom.doc.OdfSpreadsheetDocument</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></dd>
</dl>
<hr>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>As of release 0.8.8, replaced by <a href="http://incubator.apache.org/odftoolkit/simple/index.html/apidocs/org/odftoolkit/simple/SpreadsheetDocument.html?is-external=true" title="class or interface in org.odftoolkit.simple"><code>SpreadsheetDocument</code></a> in Simple API.</i></div>
</div>
<br>
<pre>public class <span class="strong">OdfSpreadsheetDocument</span>
extends <a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfDocument</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/odfdom/doc/OdfSpreadsheetDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc">OdfSpreadsheetDocument.OdfMediaType</a></strong></code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">This enum contains all possible media types of OdfSpreadsheetDocument
documents.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_org.odftoolkit.odfdom.doc.OdfDocument">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.odftoolkit.odfdom.doc.<a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfDocument</a></h3>
<code><a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.UnicodeGroup.html" title="enum in org.odftoolkit.odfdom.doc">OdfDocument.UnicodeGroup</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.<a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html" title="class in org.odftoolkit.odfdom.dom">OdfSchemaDocument</a></h3>
<code><a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.OdfXMLFile.html" title="enum in org.odftoolkit.odfdom.dom">OdfSchemaDocument.OdfXMLFile</a></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.<a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument</a></h3>
<code><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.Resource.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument.Resource</a></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.<a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html" title="class in org.odftoolkit.odfdom.dom">OdfSchemaDocument</a></h3>
<code><a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#mContentDom">mContentDom</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#mDocumentStyles">mDocumentStyles</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#mMetaDom">mMetaDom</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#mSettingsDom">mSettingsDom</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#mStylesDom">mStylesDom</a></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.<a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument</a></h3>
<code><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#mDocumentMediaType">mDocumentMediaType</a>, <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#mDocumentPathInPackage">mDocumentPathInPackage</a>, <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#mPackage">mPackage</a>, <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#ROOT_DOCUMENT_PATH">ROOT_DOCUMENT_PATH</a></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/odfdom/doc/OdfSpreadsheetDocument.html#OdfSpreadsheetDocument(org.odftoolkit.odfdom.pkg.OdfPackage, java.lang.String, org.odftoolkit.odfdom.doc.OdfSpreadsheetDocument.OdfMediaType)">OdfSpreadsheetDocument</a></strong>(<a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</a>&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/odfdom/doc/OdfSpreadsheetDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc">OdfSpreadsheetDocument.OdfMediaType</a>&nbsp;odfMediaType)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/doc/OdfSpreadsheetDocument.html#changeMode(org.odftoolkit.odfdom.doc.OdfSpreadsheetDocument.OdfMediaType)">changeMode</a></strong>(<a href="../../../../org/odftoolkit/odfdom/doc/OdfSpreadsheetDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc">OdfSpreadsheetDocument.OdfMediaType</a>&nbsp;mediaType)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">Changes the document to the given mediatype.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/odfdom/dom/element/office/OfficeSpreadsheetElement.html" title="class in org.odftoolkit.odfdom.dom.element.office">OfficeSpreadsheetElement</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/doc/OdfSpreadsheetDocument.html#getContentRoot()">getContentRoot</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">Get the content root of a spreadsheet document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/odftoolkit/odfdom/doc/OdfSpreadsheetDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfSpreadsheetDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/doc/OdfSpreadsheetDocument.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"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">Creates an OdfSpreadsheetDocument from the OpenDocument provided by a File.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/odftoolkit/odfdom/doc/OdfSpreadsheetDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfSpreadsheetDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/doc/OdfSpreadsheetDocument.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"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">Creates an OdfSpreadsheetDocument from the OpenDocument provided by a resource Stream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/odftoolkit/odfdom/doc/OdfSpreadsheetDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfSpreadsheetDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/doc/OdfSpreadsheetDocument.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"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">Loads an OdfSpreadsheetDocument from the provided path.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/odftoolkit/odfdom/doc/OdfSpreadsheetDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfSpreadsheetDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/doc/OdfSpreadsheetDocument.html#newSpreadsheetDocument()">newSpreadsheetDocument</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">Creates an empty spreadsheet document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/odftoolkit/odfdom/doc/OdfSpreadsheetDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfSpreadsheetDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/doc/OdfSpreadsheetDocument.html#newSpreadsheetTemplateDocument()">newSpreadsheetTemplateDocument</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
<div class="block">Creates an empty spreadsheet template.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.odftoolkit.odfdom.doc.OdfDocument">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.odftoolkit.odfdom.doc.<a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfDocument</a></h3>
<code><a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#close()">close</a>, <a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#getLocale(org.odftoolkit.odfdom.doc.OdfDocument.UnicodeGroup)">getLocale</a>, <a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#getOdfMediaType()">getOdfMediaType</a>, <a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#getOfficeMetadata()">getOfficeMetadata</a>, <a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#getTableByName(java.lang.String)">getTableByName</a>, <a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#getTableList()">getTableList</a>, <a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#getUnicodeGroup(java.util.Locale)">getUnicodeGroup</a>, <a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#loadDocument(org.odftoolkit.odfdom.pkg.OdfPackage)">loadDocument</a>, <a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#loadDocument(org.odftoolkit.odfdom.pkg.OdfPackage, java.lang.String)">loadDocument</a>, <a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#loadSubDocument(java.lang.String)">loadSubDocument</a>, <a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#loadSubDocuments()">loadSubDocuments</a>, <a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#loadSubDocuments(org.odftoolkit.odfdom.doc.OdfDocument.OdfMediaType)">loadSubDocuments</a>, <a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#loadTemplate(org.odftoolkit.odfdom.pkg.OdfPackageDocument.Resource, org.odftoolkit.odfdom.doc.OdfDocument.OdfMediaType)">loadTemplate</a>, <a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#newImage(java.net.URI)">newImage</a>, <a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#save(java.io.File)">save</a>, <a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#save(java.io.OutputStream)">save</a>, <a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#setLocale(java.util.Locale)">setLocale</a>, <a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#setOdfMediaType(org.odftoolkit.odfdom.doc.OdfDocument.OdfMediaType)">setOdfMediaType</a>, <a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.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.<a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html" title="class in org.odftoolkit.odfdom.dom">OdfSchemaDocument</a></h3>
<code><a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getBaseURI()">getBaseURI</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getBookmarkRDFMetadata()">getBookmarkRDFMetadata</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getContentDom()">getContentDom</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getContentStream()">getContentStream</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getDocumentStyles()">getDocumentStyles</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getFileDom(org.odftoolkit.odfdom.dom.OdfSchemaDocument.OdfXMLFile)">getFileDom</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getInContentMetadata()">getInContentMetadata</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getInContentMetadataFromCache()">getInContentMetadataFromCache</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getManifestRDFMetadata()">getManifestRDFMetadata</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getMasterPages()">getMasterPages</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getMetaDom()">getMetaDom</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getMetaStream()">getMetaStream</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getOfficeMasterStyles()">getOfficeMasterStyles</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getOrCreateDocumentStyles()">getOrCreateDocumentStyles</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getRDFMetadata()">getRDFMetadata</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getSettingsDom()">getSettingsDom</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getSettingsStream()">getSettingsStream</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getStylesDom()">getStylesDom</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getStylesStream()">getStylesStream</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getTables()">getTables</a>, <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getXMLFilePath(org.odftoolkit.odfdom.dom.OdfSchemaDocument.OdfXMLFile)">getXMLFilePath</a></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.<a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument</a></h3>
<code><a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#flushDoms()">flushDoms</a>, <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#getDocumentPath()">getDocumentPath</a>, <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#getFileDom(java.lang.String)">getFileDom</a>, <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#getMediaTypeString()">getMediaTypeString</a>, <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#getPackage()">getPackage</a>, <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#getXMLFileMetadata(java.lang.String)">getXMLFileMetadata</a>, <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#insertDocument(org.odftoolkit.odfdom.pkg.OdfPackageDocument, java.lang.String)">insertDocument</a>, <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#isExternalReference(java.lang.String)">isExternalReference</a>, <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#isRootDocument()">isRootDocument</a>, <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#normalizeDocumentPath(java.lang.String)">normalizeDocumentPath</a>, <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#removeDocument(java.lang.String)">removeDocument</a>, <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#save(java.lang.String)">save</a>, <a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#setMediaTypeString(java.lang.String)">setMediaTypeString</a></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="OdfSpreadsheetDocument(org.odftoolkit.odfdom.pkg.OdfPackage, java.lang.String, org.odftoolkit.odfdom.doc.OdfSpreadsheetDocument.OdfMediaType)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>OdfSpreadsheetDocument</h4>
<pre>protected&nbsp;OdfSpreadsheetDocument(<a href="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</a>&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/odfdom/doc/OdfSpreadsheetDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc">OdfSpreadsheetDocument.OdfMediaType</a>&nbsp;odfMediaType)
throws <a href="http://download.oracle.com/javase/6/docs/api/org/xml/sax/SAXException.html?is-external=true" title="class or interface in org.xml.sax">SAXException</a></pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<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>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/org/xml/sax/SAXException.html?is-external=true" title="class or interface in org.xml.sax">SAXException</a></code></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="newSpreadsheetDocument()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newSpreadsheetDocument</h4>
<pre>public static&nbsp;<a href="../../../../org/odftoolkit/odfdom/doc/OdfSpreadsheetDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfSpreadsheetDocument</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"><span class="strong">Deprecated.</span>&nbsp;</div>
<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/odfdom/doc/OdfSpreadsheetDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfSpreadsheetDocument</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"><span class="strong">Deprecated.</span>&nbsp;</div>
<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/odfdom/doc/OdfSpreadsheetDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfSpreadsheetDocument</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"><span class="strong">Deprecated.</span>&nbsp;</div>
<div class="block">Creates an OdfSpreadsheetDocument from the OpenDocument provided by a resource Stream.
<p>Since an InputStream does not provide the arbitrary (non sequentiell)
read access needed by OdfSpreadsheetDocument, 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/odfdom/doc/OdfSpreadsheetDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfSpreadsheetDocument</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"><span class="strong">Deprecated.</span>&nbsp;</div>
<div class="block">Loads an OdfSpreadsheetDocument from the provided path.
<p>OdfSpreadsheetDocument relies on the file being available for read access over
the whole lifecycle of OdfSpreadsheetDocument.</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 ODFDOM.</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/odfdom/doc/OdfSpreadsheetDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfSpreadsheetDocument</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"><span class="strong">Deprecated.</span>&nbsp;</div>
<div class="block">Creates an OdfSpreadsheetDocument from the OpenDocument provided by a File.
<p>OdfSpreadsheetDocument relies on the file being available for read access over
the whole lifecycle of OdfSpreadsheetDocument.</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;<a href="../../../../org/odftoolkit/odfdom/dom/element/office/OfficeSpreadsheetElement.html" title="class in org.odftoolkit.odfdom.dom.element.office">OfficeSpreadsheetElement</a>&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"><span class="strong">Deprecated.</span>&nbsp;</div>
<div class="block">Get the content root of a spreadsheet document.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#getContentRoot()">getContentRoot</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfDocument</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.odfdom.doc.OdfSpreadsheetDocument.OdfMediaType)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>changeMode</h4>
<pre>public&nbsp;void&nbsp;changeMode(<a href="../../../../org/odftoolkit/odfdom/doc/OdfSpreadsheetDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc">OdfSpreadsheetDocument.OdfMediaType</a>&nbsp;mediaType)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
<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>
</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/OdfSpreadsheetDocument.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/odfdom/doc/OdfPresentationDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/odfdom/doc/OdfSpreadsheetDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/odfdom/doc/OdfSpreadsheetDocument.html" target="_top">Frames</a></li>
<li><a href="OdfSpreadsheetDocument.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; 2008-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>