|
||||||||||
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.odfdom.doc.OdfDocument
org.odftoolkit.odfdom.doc.OdfSpreadsheetDocument
org.odftoolkit.simple.SpreadsheetDocument
in Simple API.
public class OdfSpreadsheetDocument
This class represents an empty ODF spreadsheet document.
Nested Class Summary | |
---|---|
static class |
OdfSpreadsheetDocument.OdfMediaType
Deprecated. This enum contains all possible media types of OdfSpreadsheetDocument 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.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 |
OdfSpreadsheetDocument(OdfPackage pkg,
String internalPath,
OdfSpreadsheetDocument.OdfMediaType odfMediaType)
Deprecated. To avoid data duplication a new document is only created, if not already opened. |
Method Summary | |
---|---|
void |
changeMode(OdfSpreadsheetDocument.OdfMediaType mediaType)
Deprecated. Changes the document to the given mediatype. |
OfficeSpreadsheetElement |
getContentRoot()
Deprecated. Get the content root of a spreadsheet document. |
static OdfSpreadsheetDocument |
loadDocument(File file)
Deprecated. Creates an OdfSpreadsheetDocument from the OpenDocument provided by a File. |
static OdfSpreadsheetDocument |
loadDocument(InputStream inputStream)
Deprecated. Creates an OdfSpreadsheetDocument from the OpenDocument provided by a resource Stream. |
static OdfSpreadsheetDocument |
loadDocument(String documentPath)
Deprecated. Loads an OdfSpreadsheetDocument from the provided path. |
static OdfSpreadsheetDocument |
newSpreadsheetDocument()
Deprecated. Creates an empty spreadsheet document. |
static OdfSpreadsheetDocument |
newSpreadsheetTemplateDocument()
Deprecated. Creates an empty spreadsheet template. |
Methods inherited from class org.odftoolkit.odfdom.doc.OdfDocument |
---|
close, getLocale, getOdfMediaType, getOfficeMetadata, getTableByName, getTableList, getUnicodeGroup, loadDocument, loadDocument, loadSubDocument, loadSubDocuments, loadSubDocuments, loadTemplate, newImage, save, save, setLocale, setOdfMediaType, 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, 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 |
---|
protected OdfSpreadsheetDocument(OdfPackage pkg, String internalPath, OdfSpreadsheetDocument.OdfMediaType odfMediaType) throws SAXException
SAXException
Method Detail |
---|
public static OdfSpreadsheetDocument newSpreadsheetDocument() throws Exception
Exception
- - if the document could not be createdpublic static OdfSpreadsheetDocument newSpreadsheetTemplateDocument() throws Exception
Exception
- - if the template could not be createdpublic static OdfSpreadsheetDocument loadDocument(InputStream inputStream) throws Exception
Since an InputStream does not provide the arbitrary (non sequentiell) read access needed by OdfSpreadsheetDocument, 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 spreadsheet document, ClassCastException might be thrown.
inputStream
- - the InputStream of the ODF spreadsheet document.
Exception
- - if the document could not be created.public static OdfSpreadsheetDocument loadDocument(String documentPath) throws Exception
OdfSpreadsheetDocument relies on the file being available for read access over the whole lifecycle of OdfSpreadsheetDocument.
If the resource stream is not a ODF spreadsheet 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 OdfSpreadsheetDocument loadDocument(File file) throws Exception
OdfSpreadsheetDocument relies on the file being available for read access over the whole lifecycle of OdfSpreadsheetDocument.
If the resource stream is not a ODF spreadsheet document, ClassCastException might be thrown.
file
- - a file representing the ODF spreadsheet document.
Exception
- - if the document could not be created.public OfficeSpreadsheetElement getContentRoot() throws Exception
getContentRoot
in class OdfDocument
Exception
- if the file DOM could not be created.public void changeMode(OdfSpreadsheetDocument.OdfMediaType mediaType)
mediaType
- the related ODF mimetype
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |