|
||||||||||
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.GraphicsDocument
public class GraphicsDocument
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 |
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, loadDocument, loadDocument, LoadTableTemplateFromForeignTable, loadTemplate, newImage, removeElementLinkedResource, save, save, save, setLocale, setLocale, setOdfMediaType, setPassword, toString |
Methods inherited from class org.odftoolkit.odfdom.dom.OdfSchemaDocument |
---|
getBaseURI, getBookmarkRDFMetadata, getContentDom, getContentStream, getDocumentStyles, getFileDom, getInContentMetadata, getInContentMetadataFromCache, getManifestRDFMetadata, getMasterPages, getMetaDom, getMetaStream, getOfficeMasterStyles, getOrCreateDocumentStyles, getRDFMetadata, getSettingsDom, getSettingsStream, getStylesDom, getStylesStream, getTables, getXMLFilePath |
Methods inherited from class org.odftoolkit.odfdom.pkg.OdfPackageDocument |
---|
flushDoms, getDocumentPath, getFileDom, getMediaTypeString, getPackage, getXMLFileMetadata, 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 GraphicsDocument(OdfPackage pkg, String internalPath, GraphicsDocument.OdfMediaType odfMediaType)
Method Detail |
---|
public static GraphicsDocument newGraphicsDocument() throws Exception
Exception
- - if the document could not be createdpublic static GraphicsDocument newGraphicsTemplateDocument() throws Exception
Exception
- - if the template could not be createdpublic static GraphicsDocument loadDocument(InputStream inputStream) throws Exception
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.
inputStream
- - the InputStream of the ODF graphics document.
Exception
- - if the document could not be created.public static GraphicsDocument loadDocument(String documentPath) throws Exception
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.
documentPath
- - the path from where the document can be loaded
Exception
- - if the document could not be created.public static GraphicsDocument loadDocument(File file) throws Exception
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.
file
- - a file representing the ODF graphics document.
Exception
- - if the document could not be created.public OfficeDrawingElement getContentRoot() throws Exception
getContentRoot
in class Document
Exception
- if the file DOM could not be created.public void changeMode(GraphicsDocument.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 |