|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.odftoolkit.odfdom.pkg.OdfPackageDocument
org.odftoolkit.odfdom.dom.OdfSchemaDocument
org.odftoolkit.simple.Document
org.odftoolkit.simple.ChartDocument
public class ChartDocument
This class represents an empty ODF document , which will be in general embedded in an existing ODF (Spreadsheet) document.
Nested Class Summary | |
---|---|
static class |
ChartDocument.OdfMediaType
This enum contains all possible media types of ChartDocument documents. |
Nested classes/interfaces inherited from class org.odftoolkit.simple.Document |
---|
Document.ScriptType |
Nested classes/interfaces inherited from class org.odftoolkit.odfdom.dom.OdfSchemaDocument |
---|
OdfSchemaDocument.OdfXMLFile |
Nested classes/interfaces inherited from class org.odftoolkit.odfdom.pkg.OdfPackageDocument |
---|
OdfPackageDocument.Resource |
Field Summary |
---|
Fields inherited from class org.odftoolkit.odfdom.dom.OdfSchemaDocument |
---|
mContentDom, mDocumentStyles, mMetaDom, mSettingsDom, mStylesDom |
Fields inherited from class org.odftoolkit.odfdom.pkg.OdfPackageDocument |
---|
mDocumentMediaType, mDocumentPathInPackage, mPackage, ROOT_DOCUMENT_PATH |
Constructor Summary | |
---|---|
protected |
ChartDocument(OdfPackage pkg,
String internalPath,
ChartDocument.OdfMediaType odfMediaType)
To avoid data duplication a new document is only created, if not already opened. |
Method Summary | |
---|---|
void |
changeMode(ChartDocument.OdfMediaType mediaType)
Changes the document to the given mediatype. |
OfficeChartElement |
getContentRoot()
Get the content root of a chart document. |
OdfElement |
getTableContainerElement()
Get the ODF element which can have |
static ChartDocument |
loadDocument(File file)
Creates an ChartDocument from the OpenDocument provided by a File. |
static ChartDocument |
loadDocument(InputStream inputStream)
Creates an ChartDocument from the OpenDocument provided by a resource Stream. |
static ChartDocument |
loadDocument(String documentPath)
Loads an ChartDocument from the provided path. |
static ChartDocument |
newChartDocument()
Creates an empty charts document. |
static ChartDocument |
newChartTemplateDocument()
Creates an empty charts template. |
Methods inherited from class org.odftoolkit.simple.Document |
---|
addTable, addTable, close, getComponentMap, getContentRoot, getEmbeddedDocument, getEmbeddedDocuments, getEmbeddedDocuments, getLocale, getOdfMediaType, getOfficeMetadata, getScriptType, getSectionByName, getSectionIterator, getTableBuilder, getTableByName, getTableContainerImpl, getTableList, insertDocument, loadDocument, loadDocument, loadTemplate, newImage, removeElementLinkedResource, save, save, setLocale, setLocale, setOdfMediaType, toString |
Methods inherited from class org.odftoolkit.odfdom.dom.OdfSchemaDocument |
---|
getBaseURI, getContentDom, getContentStream, getDocumentStyles, getFileDom, getMasterPages, getMetaDom, getMetaStream, getOfficeMasterStyles, getOrCreateDocumentStyles, getSettingsDom, getSettingsStream, getStylesDom, getStylesStream, getTables, getXMLFilePath |
Methods inherited from class org.odftoolkit.odfdom.pkg.OdfPackageDocument |
---|
flushDoms, getDocumentPath, getFileDom, getMediaTypeString, getPackage, isExternalReference, isRootDocument, loadSubDocument, normalizeDocumentPath, removeDocument, save, setMediaTypeString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected ChartDocument(OdfPackage pkg, String internalPath, ChartDocument.OdfMediaType odfMediaType)
Method Detail |
---|
public static ChartDocument newChartDocument() throws Exception
Exception
- - if the document could not be createdpublic static ChartDocument newChartTemplateDocument() throws Exception
Exception
- - if the template could not be createdpublic static ChartDocument loadDocument(InputStream inputStream) throws Exception
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.
If the resource stream is not a ODF chart document, ClassCastException might be thrown.
inputStream
- - the InputStream of the ODF chart document.
Exception
- - if the document could not be created.public static ChartDocument loadDocument(String documentPath) throws Exception
ChartDocument relies on the file being available for read access over the whole lifecycle of ChartDocument.
If the resource stream is not a ODF chart document, ClassCastException might be thrown.
documentPath
- - the path from where the document can be loaded
Exception
- - if the document could not be created.public static ChartDocument loadDocument(File file) throws Exception
ChartDocument relies on the file being available for read access over the whole lifecycle of ChartDocument.
If the resource stream is not a ODF chart document, ClassCastException might be thrown.
file
- - a file representing the ODF chart document.
Exception
- - if the document could not be created.public OfficeChartElement getContentRoot() throws Exception
getContentRoot
in class Document
Exception
- if the file DOM could not be created.public void changeMode(ChartDocument.OdfMediaType mediaType)
mediaType
- the related ODF mimetypepublic OdfElement getTableContainerElement()
TableContainer
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |