Package org.odftoolkit.odfdom.doc

Class OdfGraphicsDocument

java.lang.Object

org.odftoolkit.odfdom.pkg.OdfPackageDocument

org.odftoolkit.odfdom.dom.OdfSchemaDocument

org.odftoolkit.odfdom.doc.OdfDocument

org.odftoolkit.odfdom.doc.OdfGraphicsDocument

All Implemented Interfaces:

Closeable, AutoCloseable

public class OdfGraphicsDocument
extends OdfDocument

This class represents an empty ODF graphics document.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OdfGraphicsDocument.OdfMediaType	This enum contains all possible media types of OdfGraphicsDocument documents.

Nested classes/interfaces inherited from class org.odftoolkit.odfdom.doc.OdfDocument

OdfDocument.UnicodeGroup

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.doc.OdfDocument

mHasCollaboration

Fields inherited from class org.odftoolkit.odfdom.dom.OdfSchemaDocument

mContentDom, mJsonOperationQueue, mMetaDom, mSettingsDom, mStylesDom

Fields inherited from class org.odftoolkit.odfdom.pkg.OdfPackageDocument

mDocumentMediaType, mDocumentPathInPackage, mPackage, ROOT_DOCUMENT_PATH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OdfGraphicsDocument(OdfPackage pkg, String internalPath, OdfGraphicsDocument.OdfMediaType odfMediaType)	To avoid data duplication a new document is only created, if not already opened.

Method Summary

Modifier and Type	Method	Description
void	changeMode(OdfGraphicsDocument.OdfMediaType mediaType)	Changes the document to the given mediatype.
OfficeDrawingElement	getContentRoot()	Get the content root of a graphics document.
static OdfGraphicsDocument	loadDocument(File file)	Creates an OdfGraphicsDocument from the OpenDocument provided by a File.
static OdfGraphicsDocument	loadDocument(InputStream inputStream)	Creates an OdfGraphicsDocument from the OpenDocument provided by a resource Stream.
static OdfGraphicsDocument	loadDocument(String documentPath)	Loads an OdfGraphicsDocument from the provided path.
static OdfGraphicsDocument	newGraphicsDocument()	Creates an empty graphics document.
static OdfGraphicsDocument	newGraphicsTemplateDocument()	Creates an empty graphics template.

Methods inherited from class org.odftoolkit.odfdom.doc.OdfDocument

addAnnotation, close, getAnnotation, getFontNames, getLocale, getOdfMediaType, getOfficeMetadata, getTableByName, getTableList, getTableList, getUnicodeGroup, getUniqueAnnotationName, hasCollaboration, loadDocument, loadDocument, loadDocument, loadDocument, loadDocument, loadDocument, loadDocument, loadSubDocument, loadSubDocuments, loadSubDocuments, loadTemplate, loadTemplate, newImage, removeAnnotation, removeCachedView, save, save, setLocale, setOdfMediaType, toString, updateMetaData

Methods inherited from class org.odftoolkit.odfdom.dom.OdfSchemaDocument

getBaseURI, getBookmarkRDFMetadata, getContentDom, getContentStream, getDocumentStyles, getFileDom, getInContentMetadata, getInContentMetadataFromCache, getJsonOperationQueue, getManifestRDFMetadata, getMasterPages, getMetaDom, getMetaStream, getOfficeMasterStyles, getOperations, getOrCreateDocumentStyles, getRDFMetadata, getRootComponent, getRootComponentElement, getSettingsDom, getSettingsStream, getStyleByDisplayName, getStyleByName, getStylesDom, getStylesStream, getTables, getTables, getXMLFilePath, setContentDom, setJsonOperationQueue, setMetaDom, setRootComponent, setSettingsDom, setStylesDom

Methods inherited from class org.odftoolkit.odfdom.pkg.OdfPackageDocument

flushDoms, getAbsoluteFilePath, getCachedDom, getDocumentPath, getFileDom, getMediaTypeString, getPackage, getXMLFileMetadata, insertDocument, isExternalReference, isRootDocument, normalizeDocumentPath, removeDocument, save, setMediaTypeString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OdfGraphicsDocument

protected OdfGraphicsDocument(OdfPackage pkg,
                              String internalPath,
                              OdfGraphicsDocument.OdfMediaType odfMediaType)
                       throws SAXException

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.

Throws:

SAXException

Method Detail

newGraphicsDocument

public static OdfGraphicsDocument newGraphicsDocument()
                                               throws Exception

Creates an empty graphics document.

Returns:

ODF graphics document based on a default template

Throws:

Exception - - if the document could not be created

newGraphicsTemplateDocument

public static OdfGraphicsDocument newGraphicsTemplateDocument()
                                                       throws Exception

Creates an empty graphics template.

Returns:

ODF graphics template based on a default

Throws:

Exception - - if the template could not be created

loadDocument

public static OdfGraphicsDocument loadDocument(InputStream inputStream)
                                        throws Exception

Creates an OdfGraphicsDocument from the OpenDocument provided by a resource Stream.

Since an InputStream does not provide the arbitrary (non sequentiell) read access needed by OdfGraphicsDocument, 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 graphics document, ClassCastException might be thrown.

Parameters:

inputStream - - the InputStream of the ODF graphics document.

Returns:

the graphics document created from the given InputStream

Throws:

Exception - - if the document could not be created.

loadDocument

public static OdfGraphicsDocument loadDocument(String documentPath)
                                        throws Exception

Loads an OdfGraphicsDocument from the provided path.

OdfGraphicsDocument relies on the file being available for read access over the whole lifecycle of OdfGraphicsDocument.

If the resource stream is not a ODF graphics document, ClassCastException might be thrown.

Parameters:

documentPath - - the path from where the document can be loaded

Returns:

the graphics document from the given path or NULL if the media type is not supported by ODFDOM.

Throws:

Exception - - if the document could not be created.

loadDocument

public static OdfGraphicsDocument loadDocument(File file)
                                        throws Exception

Creates an OdfGraphicsDocument from the OpenDocument provided by a File.

OdfGraphicsDocument relies on the file being available for read access over the whole lifecycle of OdfGraphicsDocument.

If the resource stream is not a ODF graphics document, ClassCastException might be thrown.

Parameters:

file - - a file representing the ODF graphics document.

Returns:

the graphics document created from the given File

Throws:

Exception - - if the document could not be created.

getContentRoot

public OfficeDrawingElement getContentRoot()
                                    throws Exception

Get the content root of a graphics document.

Overrides:

getContentRoot in class OdfDocument

Returns:

content root, representing the office:drawing tag

Throws:

Exception - if the file DOM could not be created.

changeMode

public void changeMode(OdfGraphicsDocument.OdfMediaType mediaType)

Changes the document to the given mediatype. This method can only be used to convert a document to a related mediatype, e.g. template.

Parameters:

mediaType - the related ODF mimetype