org.odftoolkit.odfdom.doc
Class OdfTextDocument

java.lang.Object
  extended by org.odftoolkit.odfdom.pkg.OdfPackageDocument
      extended by org.odftoolkit.odfdom.dom.OdfSchemaDocument
          extended by org.odftoolkit.odfdom.doc.OdfDocument
              extended by org.odftoolkit.odfdom.doc.OdfTextDocument
All Implemented Interfaces:
Closeable

Deprecated. As of release 0.8.8, replaced by org.odftoolkit.simple.TextDocument in Simple API.

public class OdfTextDocument
extends OdfDocument

This class represents an empty ODF text document.


Nested Class Summary
static class OdfTextDocument.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 OdfTextDocument(OdfPackage pkg, String internalPath, OdfTextDocument.OdfMediaType odfMediaType)
          Deprecated. To avoid data duplication a new document is only created, if not already opened.
 
Method Summary
 OdfTextParagraph addText(String text)
          Deprecated. Append text to the end of a text document.
 void changeMode(OdfTextDocument.OdfMediaType mediaType)
          Deprecated. Changes the document to the given mediatype.
 OfficeTextElement getContentRoot()
          Deprecated. Get the content root of a text document.
static OdfTextDocument loadDocument(File file)
          Deprecated. Creates an OdfTextDocument from the OpenDocument provided by a File.
static OdfTextDocument loadDocument(InputStream inputStream)
          Deprecated. Creates an OdfTextDocument from the OpenDocument provided by a resource Stream.
static OdfTextDocument loadDocument(String documentPath)
          Deprecated. Loads an OdfTextDocument from the provided path.
 OdfTextParagraph newParagraph()
          Deprecated. Creates a new paragraph
 OdfTextParagraph newParagraph(String text)
          Deprecated. Creates a new paragraph and append text
static OdfTextDocument newTextDocument()
          Deprecated. Creates an empty text document.
static OdfTextDocument newTextDocument(OdfTextDocument.OdfMediaType mimeType)
          Deprecated. Creates an empty text document.
static OdfTextDocument newTextMasterDocument()
          Deprecated. Creates an empty text master document.
static OdfTextDocument newTextTemplateDocument()
          Deprecated. Creates an empty text template.
static OdfTextDocument newTextWebDocument()
          Deprecated. Creates an empty text web.
 
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, 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, 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

OdfTextDocument

protected OdfTextDocument(OdfPackage pkg,
                          String internalPath,
                          OdfTextDocument.OdfMediaType odfMediaType)
                   throws SAXException
Deprecated. 
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

newTextDocument

public static OdfTextDocument newTextDocument()
                                       throws Exception
Deprecated. 
Creates an empty text document.

Returns:
ODF text document based on a default template
Throws:
Exception - - if the document could not be created

newTextDocument

public static OdfTextDocument newTextDocument(OdfTextDocument.OdfMediaType mimeType)
                                       throws Exception
Deprecated. 
Creates an empty text document.

Returns:
ODF text document based on a default template
Throws:
Exception - - if the document could not be created

newTextTemplateDocument

public static OdfTextDocument newTextTemplateDocument()
                                               throws Exception
Deprecated. 
Creates an empty text template.

Returns:
ODF text template based on a default
Throws:
Exception - - if the template could not be created

newTextMasterDocument

public static OdfTextDocument newTextMasterDocument()
                                             throws Exception
Deprecated. 
Creates an empty text master document.

Returns:
ODF text master based on a default
Throws:
Exception - - if the document could not be created

newTextWebDocument

public static OdfTextDocument newTextWebDocument()
                                          throws Exception
Deprecated. 
Creates an empty text web.

Returns:
ODF text web based on a default
Throws:
Exception - - if the document could not be created

loadDocument

public static OdfTextDocument loadDocument(InputStream inputStream)
                                    throws Exception
Deprecated. 
Creates an OdfTextDocument from the OpenDocument provided by a resource Stream.

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

Parameters:
inputStream - - the InputStream of the ODF text document.
Returns:
the text document created from the given InputStream
Throws:
Exception - - if the document could not be created.

loadDocument

public static OdfTextDocument loadDocument(String documentPath)
                                    throws Exception
Deprecated. 
Loads an OdfTextDocument from the provided path.

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

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

Parameters:
documentPath - - the path from where the document can be loaded
Returns:
the text 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 OdfTextDocument loadDocument(File file)
                                    throws Exception
Deprecated. 
Creates an OdfTextDocument from the OpenDocument provided by a File.

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

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

Parameters:
file - - a file representing the ODF text document.
Returns:
the text document created from the given File
Throws:
Exception - - if the document could not be created.

getContentRoot

public OfficeTextElement getContentRoot()
                                 throws Exception
Deprecated. 
Get the content root of a text document. Start here to get or create new elements of a text document like paragraphs, headings, tables or lists.

Overrides:
getContentRoot in class OdfDocument
Returns:
content root, representing the office:text tag
Throws:
Exception - if the file DOM could not be created.

newParagraph

public OdfTextParagraph newParagraph(String text)
                              throws Exception
Deprecated. 
Creates a new paragraph and append text

Parameters:
text -
Returns:
the new paragraph
Throws:
Exception - if the file DOM could not be created.

newParagraph

public OdfTextParagraph newParagraph()
                              throws Exception
Deprecated. 
Creates a new paragraph

Returns:
The new paragraph
Throws:
Exception - if the file DOM could not be created.

addText

public OdfTextParagraph addText(String text)
                         throws Exception
Deprecated. 
Append text to the end of a text document. If there is no paragraph at the end of a document, a new one will be created.

Parameters:
text - initial text for the paragraph.
Returns:
The paragraph at the end of the text document, where the text has been added to.
Throws:
Exception - if the file DOM could not be created.

changeMode

public void changeMode(OdfTextDocument.OdfMediaType mediaType)
Deprecated. 
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


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