org.odftoolkit.simple
Class GraphicsDocument

java.lang.Object
  extended by org.odftoolkit.odfdom.pkg.OdfPackageDocument
      extended by org.odftoolkit.odfdom.dom.OdfSchemaDocument
          extended by org.odftoolkit.simple.Document
              extended by org.odftoolkit.simple.GraphicsDocument
All Implemented Interfaces:
Closeable, TableContainer

public class GraphicsDocument
extends Document

This class represents an empty ODF graphics document.


Nested Class Summary
static class GraphicsDocument.OdfMediaType
          This enum contains all possible media types of GraphicsDocument 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 GraphicsDocument(OdfPackage pkg, String internalPath, GraphicsDocument.OdfMediaType odfMediaType)
          To avoid data duplication a new document is only created, if not already opened.
 
Method Summary
 void changeMode(GraphicsDocument.OdfMediaType mediaType)
          Changes the document to the given mediatype.
 OfficeDrawingElement getContentRoot()
          Get the content root of a graphics document.
 OdfElement getTableContainerElement()
          Get the ODF element which can have as child element directly according to ODF specification.
static GraphicsDocument loadDocument(File file)
          Creates an GraphicsDocument from the OpenDocument provided by a File.
static GraphicsDocument loadDocument(InputStream inputStream)
          Creates an GraphicsDocument from the OpenDocument provided by a resource Stream.
static GraphicsDocument loadDocument(String documentPath)
          Loads an GraphicsDocument from the provided path.
static GraphicsDocument newGraphicsDocument()
          Creates an empty graphics document.
static GraphicsDocument newGraphicsTemplateDocument()
          Creates an empty graphics 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

GraphicsDocument

protected GraphicsDocument(OdfPackage pkg,
                           String internalPath,
                           GraphicsDocument.OdfMediaType odfMediaType)
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.

Method Detail

newGraphicsDocument

public static GraphicsDocument 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 GraphicsDocument 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 GraphicsDocument loadDocument(InputStream inputStream)
                                     throws Exception
Creates an GraphicsDocument from the OpenDocument provided by a resource Stream.

Since an InputStream does not provide the arbitrary (non sequentiell) read access needed by GraphicsDocument, 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 GraphicsDocument loadDocument(String documentPath)
                                     throws Exception
Loads an GraphicsDocument from the provided path.

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

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 SIMPLE.
Throws:
Exception - - if the document could not be created.

loadDocument

public static GraphicsDocument loadDocument(File file)
                                     throws Exception
Creates an GraphicsDocument from the OpenDocument provided by a File.

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

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 Document
Returns:
content root, representing the office:drawing tag
Throws:
Exception - if the file DOM could not be created.

changeMode

public void changeMode(GraphicsDocument.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

getTableContainerElement

public OdfElement getTableContainerElement()
Description copied from interface: TableContainer
Get the ODF element which can have as child element directly according to ODF specification. This Element will help to find the position to insert a new Table. For example, element is usable with element, so TextDocument will return OfficeTextElement. While Presentation Notes is an indirectly TableContainer, which holds Table with the help of its grand-child element , so for Notes, DrawTextBoxElement should be return.

Returns:
container element which can hold .


Copyright © 2010-2011 The Apache Software Foundation. All Rights Reserved.