Google Git
Sign in
apache / incubator-odftoolkit-site / d22ef2d53769a0a209d42b84c8275ad1d8522260 / . / content / odftoolkit / mvn-site / 0.8-incubating / simple-odf / apidocs / org / odftoolkit / simple / ChartDocument.html
blob: 5286ac739fdffb32c6fb0e10aee9fd91ed4d376b [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>ChartDocument (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="ChartDocument (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/ChartDocument.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>Prev Class</li>
<li><a href="../../../org/odftoolkit/simple/ChartDocument.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/ChartDocument.html" target="_top">Frames</a></li>
<li><a href="ChartDocument.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 ChartDocument" class="title">Class ChartDocument</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.ChartDocument</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/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">ChartDocument</span>
extends <a href="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</a></pre>
<div class="block">This class represents an empty ODF document , which will be in general
embedded in an existing 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/ChartDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple">ChartDocument.OdfMediaType</a></strong></code>
<div class="block">This enum contains all possible media types of ChartDocument 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/ChartDocument.html#ChartDocument(org.odftoolkit.odfdom.pkg.OdfPackage, java.lang.String, org.odftoolkit.simple.ChartDocument.OdfMediaType)">ChartDocument</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/ChartDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple">ChartDocument.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>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/ChartDocument.html#changeMode(org.odftoolkit.simple.ChartDocument.OdfMediaType)">changeMode</a></strong>(<a href="../../../org/odftoolkit/simple/ChartDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple">ChartDocument.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>org.odftoolkit.odfdom.dom.element.office.OfficeChartElement</code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/ChartDocument.html#getContentRoot()">getContentRoot</a></strong>()</code>
<div class="block">Get the content root of a chart 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/ChartDocument.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>static <a href="../../../org/odftoolkit/simple/ChartDocument.html" title="class in org.odftoolkit.simple">ChartDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/ChartDocument.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 ChartDocument from the OpenDocument provided by a File.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/odftoolkit/simple/ChartDocument.html" title="class in org.odftoolkit.simple">ChartDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/ChartDocument.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 ChartDocument from the OpenDocument provided by a resource
Stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/odftoolkit/simple/ChartDocument.html" title="class in org.odftoolkit.simple">ChartDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/ChartDocument.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 ChartDocument from the provided path.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/odftoolkit/simple/ChartDocument.html" title="class in org.odftoolkit.simple">ChartDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/ChartDocument.html#newChartDocument()">newChartDocument</a></strong>()</code>
<div class="block">Creates an empty charts document. * <br/>
<em>Note: ODF Chart documents are (with OOo 3.0) only used as embedded document and not used stand-alone.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/odftoolkit/simple/ChartDocument.html" title="class in org.odftoolkit.simple">ChartDocument</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/odftoolkit/simple/ChartDocument.html#newChartTemplateDocument()">newChartTemplateDocument</a></strong>()</code>
<div class="block">Creates an empty charts template. * <br/>
<em>Note: ODF Chart documents are (with OOo 3.0) only used as embedded document and not used stand-alone.</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="ChartDocument(org.odftoolkit.odfdom.pkg.OdfPackage, java.lang.String, org.odftoolkit.simple.ChartDocument.OdfMediaType)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ChartDocument</h4>
<pre>protected&nbsp;ChartDocument(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/ChartDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple">ChartDocument.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="newChartDocument()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newChartDocument</h4>
<pre>public static&nbsp;<a href="../../../org/odftoolkit/simple/ChartDocument.html" title="class in org.odftoolkit.simple">ChartDocument</a>&nbsp;newChartDocument()
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 charts document. * <br/>
<em>Note: ODF Chart documents are (with OOo 3.0) only used as embedded document and not used stand-alone.</em></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>ODF charts 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="newChartTemplateDocument()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newChartTemplateDocument</h4>
<pre>public static&nbsp;<a href="../../../org/odftoolkit/simple/ChartDocument.html" title="class in org.odftoolkit.simple">ChartDocument</a>&nbsp;newChartTemplateDocument()
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 charts template. * <br/>
<em>Note: ODF Chart documents are (with OOo 3.0) only used as embedded document and not used stand-alone.</em></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>ODF charts template 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 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/ChartDocument.html" title="class in org.odftoolkit.simple">ChartDocument</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 ChartDocument from the OpenDocument provided by a resource
Stream.
<p>
Since an InputStream does not provide the arbitrary (non sequentiell)
read access needed by ChartDocument, 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 chart document, ClassCastException
might be thrown.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>inputStream</code> - - the InputStream of the ODF chart document.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the chart 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/ChartDocument.html" title="class in org.odftoolkit.simple">ChartDocument</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 ChartDocument from the provided path.
<p>
ChartDocument relies on the file being available for read access over the
whole lifecycle of ChartDocument.
</p>
<p>
If the resource stream is not a ODF chart 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 chart 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/ChartDocument.html" title="class in org.odftoolkit.simple">ChartDocument</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 ChartDocument from the OpenDocument provided by a File.
<p>
ChartDocument relies on the file being available for read access over the
whole lifecycle of ChartDocument.
</p>
<p>
If the resource stream is not a ODF chart document, ClassCastException
might be thrown.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - - a file representing the ODF chart document.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the chart 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.OfficeChartElement&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 chart 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:chart 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.ChartDocument.OdfMediaType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>changeMode</h4>
<pre>public&nbsp;void&nbsp;changeMode(<a href="../../../org/odftoolkit/simple/ChartDocument.OdfMediaType.html" title="enum in org.odftoolkit.simple">ChartDocument.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="getTableContainerElement()">
<!-- -->
</a>
<ul class="blockListLast">
<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><span class="strong">Returns:</span></dt><dd>container element which can hold <text:table>.</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/ChartDocument.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>Prev Class</li>
<li><a href="../../../org/odftoolkit/simple/ChartDocument.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/ChartDocument.html" target="_top">Frames</a></li>
<li><a href="ChartDocument.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>