TextDocument (Simple ODF v0.9.0 - http://odftoolkit.org)

java.lang.Object
- org.odftoolkit.odfdom.pkg.OdfPackageDocument
- - org.odftoolkit.odfdom.dom.OdfSchemaDocument
  - - org.odftoolkit.simple.Document
    - - org.odftoolkit.simple.TextDocument

All Implemented Interfaces:

Closeable, AutoCloseable, ChartContainer, VariableContainer, ControlContainer, FormContainer, TableContainer, ListContainer, ParagraphContainer
```
public class TextDocument
extends Document
implements ListContainer, ParagraphContainer, VariableContainer, ChartContainer, FormContainer, ControlContainer
```
This class represents an empty ODF text document.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TextDocument.OdfMediaType
This enum contains all possible media types of SpreadsheetDocument 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

Nested Classes
Modifier and Type	Class and Description
`static class`	`TextDocument.OdfMediaType` This enum contains all possible media types of SpreadsheetDocument documents.

Field Summary
- Fields inherited from class org.odftoolkit.simple.Document
  selectionManager
- 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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addColumnBreak()` Appends a new column break to this document.
`void`	`addColumnBreak(Paragraph refParagraph)` Appends a new column break to this document after the reference paragraph.
`List`	`addList()` Add a new List to this container.
`List`	`addList(ListDecorator decorator)` Add a List with specified ListDecorator to this container.
`void`	`addPageBreak()` Appends a new page break to this document.
`void`	`addPageBreak(Paragraph refParagraph)` Appends a new page break to this document after the reference paragraph.
`void`	`addPageBreak(Paragraph refParagraph, MasterPage master)` Appends a new page break to this document after the reference paragraph, and the master page style will be applied to the new page.
`Paragraph`	`addParagraph(String text)` Creates a new paragraph and append text.
`Table`	`addTable(int numRows, int numCols, int headerRowNumber, int headerColumnNumber)` Add a new Table to this container with a specified row number and column number.
`OdfTextParagraph`	`addText(String text)` Deprecated. As of Simple version 0.5, replaced by `Paragraph.appendTextContent(String content)`
`Section`	`appendSection(Section section, boolean isResourceCopied)` Copy a section and append it at the end of the text document, whether the section is in this document or in a different document.
`Section`	`appendSection(String name)` Create an empty section and append it at the end of the text document.
`void`	`changeMode(TextDocument.OdfMediaType mediaType)` Changes the document to the given mediatype.
`void`	`clearList()` Remove all Lists from this container.
`Chart`	`createChart(String title, DataSet dataset, Rectangle rect)` Creates a new Chart for this container.
`Chart`	`createChart(String title, SpreadsheetDocument document, CellRangeAddressList cellRangeAddr, boolean firstRowAsLabel, boolean firstColumnAsLabel, boolean rowAsDataSeries, Rectangle rect)` Creates a new Chart for this container.
`Chart`	`createChart(String title, String[] labels, String[] legends, double[][] data, Rectangle rect)` Creates a new Chart for this container.
`TextTableOfContentElement`	`createDefaultTOC(Paragraph refParagraph, boolean before)` Create a new Table Of Content to this document before the reference paragraph.
`Control`	`createDrawControl()` Create an instance of control and and append it at the end of this container.
`Form`	`createForm(String name)` Create a form with specified name in this text document.
`TextTableOfContentElement`	`createTOCwithStyle(Paragraph refParagraph, TOCStyle additionalStyle, boolean before)` Create a new Table Of Content to this document before the reference paragraph.
`VariableField`	`declareVariable(String name, VariableField.VariableType type)` Declare a new variable field to this container.
`void`	`deleteChartById(String chartId)` Deletes chart by chart id.
`void`	`deleteChartByTitle(String title)` Deletes chart(s) by chart title.
`boolean`	`getApplyDesignMode()` Get the attribute `form:apply-design-mode` which specifies whether forms are presented in editable or non-editable state.
`boolean`	`getAutomaticFocus()` Get the attribute `form:automatic-focus` which specifies whether the consumer loading the document should set the focus to a form control.
`Chart`	`getChartById(String chartId)` Gets chart with specified id.
`List<Chart>`	`getChartByTitle(String title)` Gets chart list with specified title.
`int`	`getChartCount()` Returns the chart count of this container
`OfficeTextElement`	`getContentRoot()` Get the content root of a text document.
`OdfElement`	`getDrawControlContainerElement()` Get the ODF element which can have DrawControlElement as child element directly.
`Footer`	`getFooter()` Get the Standard Page footer of this text document.
`Footer`	`getFooter(boolean isFirstPage)` Get the footer of this text document.
`Form`	`getFormByName(String name)` Return a form whose name is a given value.
`OfficeFormsElement`	`getFormContainerElement()` Get the ODF element `OfficeFormsElement` which can have `FormFormElement` as child element directly according to ODF specification.
`Iterator<Form>`	`getFormIterator()` Get a form iterator to traverse all the forms in this document.
`Header`	`getHeader()` Get the Standard Page header of this text document.
`Header`	`getHeader(boolean isFirstPage)` Get the header of this text document.
`OdfElement`	`getListContainerElement()` Get the ODF element which can have as child element directly according to ODF specification.
`Iterator<List>`	`getListIterator()` Return an Iterator of the Lists in this ListContainer.
`Paragraph`	`getParagraphByIndex(int index, boolean isEmptyParagraphSkipped)` Return a paragraph with a given index.
`Paragraph`	`getParagraphByReverseIndex(int reverseIndex, boolean isEmptyParagraphSkipped)` Return a paragraph with a given index.
`OdfElement`	`getParagraphContainerElement()` Get the ODF element which can have as child element directly.
`Iterator<Paragraph>`	`getParagraphIterator()` Return an Iterator of the paragraph in this container.
`OdfElement`	`getTableContainerElement()` Get the ODF element which can have as child element directly according to ODF specification.
`OdfElement`	`getVariableContainerElement()` Get the ODF element which can have variable declare section as child element directly according to ODF specification.
`VariableField`	`getVariableFieldByName(String name)` Return the declared variable by name.
`void`	`insertContentFromDocumentAfter(TextDocument sourceDocument, Paragraph referenceParagraph, boolean isCopyStyle)` Copy text content of the source TextDocument and insert it to the current TextDocument after the reference Paragraph, with Styles or without Styles.
`void`	`insertContentFromDocumentBefore(TextDocument sourceDocument, Paragraph referenceParagraph, boolean isCopyStyle)` Copy text content of the source TextDocument and insert it to the current TextDocument before the reference Paragraph, with Styles or without Styles.
`OdfElement`	`insertOdfElement(OdfElement referenceOdfElement, Document sourceDocument, OdfElement sourceOdfElement, boolean before)` Copy a OdfElement and insert it before or after the Reference OdfElement in the TextDocument, whether the OdfElement is in this TextDocument or in a different Document.
`Paragraph`	`insertParagraph(Paragraph referenceParagraph, Paragraph sourceParagraph, boolean before)` Copy a Paragraph and insert it before or after the Reference Paragraph in the text document, whether the Paragraph is in this document or in a different document.
`Table`	`insertTable(Paragraph referenceParagraph, Table sourceTable, boolean before)` Copy a Table and insert it before or after the Reference Paragraph in the text document, whether the Table is in this TextDocument or in a different Document.
`static TextDocument`	`loadDocument(File file)` Creates an TextDocument from the OpenDocument provided by a File.
`static TextDocument`	`loadDocument(InputStream inputStream)` Creates an TextDocument from the OpenDocument provided by a resource Stream.
`static TextDocument`	`loadDocument(String documentPath)` Loads an TextDocument from the provided path.
`OdfTextParagraph`	`newParagraph()` Deprecated. As of Simple version 0.5, replaced by `Paragraph.newParagraph(ParagraphContainer)`
`OdfTextParagraph`	`newParagraph(String text)` Deprecated. As of Simple version 0.5, replaced by `addParagraph(String text)`
`static TextDocument`	`newTextDocument()` Creates an empty text document.
`static TextDocument`	`newTextDocument(TextDocument.OdfMediaType mimeType)` Creates an empty text document.
`static TextDocument`	`newTextMasterDocument()` Creates an empty text master document.
`static TextDocument`	`newTextTemplateDocument()` Creates an empty text template.
`static TextDocument`	`newTextWebDocument()` Creates an empty text web.
`boolean`	`removeForm(Form form)` Remove a form with the specified name in this document.
`boolean`	`removeList(List list)` Remove the existing List from this container.
`boolean`	`removeParagraph(Paragraph para)` Remove paragraph from this document
`void`	`setApplyDesignMode(boolean isDesignMode)` Set the attribute `form:apply-design-mode` which specifies whether forms are presented in editable or non-editable state.
`void`	`setAutomaticFocus(boolean isAutoFocus)` Set the attribute `form:automatic-focus` which specifies whether the consumer loading the document should set the focus to a form control.
`void`	`setPageColumns(int columnsNumber, double spacing)` Defines several columns to the page whose style is specified.

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
  - TextDocument
```
protected TextDocument(OdfPackage pkg,
                       String internalPath,
                       TextDocument.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
  - newTextDocument
```
public static TextDocument newTextDocument()
                                    throws Exception
```
    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 TextDocument newTextDocument(TextDocument.OdfMediaType mimeType)
                                    throws Exception
```
    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 TextDocument newTextTemplateDocument()
                                            throws Exception
```
    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 TextDocument newTextMasterDocument()
                                          throws Exception
```
    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 TextDocument newTextWebDocument()
                                       throws Exception
```
    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 TextDocument loadDocument(InputStream inputStream)
                                 throws Exception
```
    Creates an TextDocument from the OpenDocument provided by a resource Stream.
    Since an InputStream does not provide the arbitrary (non sequentiell) read access needed by TextDocument, 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 TextDocument loadDocument(String documentPath)
                                 throws Exception
```
    Loads an TextDocument from the provided path.
    TextDocument relies on the file being available for read access over the whole lifecycle of TextDocument.
    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 SIMPLE.
    
    Throws:
    
    Exception - - if the document could not be created.
  - loadDocument
```
public static TextDocument loadDocument(File file)
                                 throws Exception
```
    Creates an TextDocument from the OpenDocument provided by a File.
    TextDocument relies on the file being available for read access over the whole lifecycle of TextDocument.
    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
```
    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 Document
    
    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. As of Simple version 0.5, replaced by addParagraph(String text)
    
    Creates a new paragraph and append text
    
    Parameters:
    
    text -
    
    Returns:
    
    the new paragraph
    
    Throws:
    
    Exception - if the file DOM could not be created.
    
    See Also:
    
    addParagraph(String)
  - newParagraph
```
public OdfTextParagraph newParagraph()
                              throws Exception
```
    Deprecated. As of Simple version 0.5, replaced by Paragraph.newParagraph(ParagraphContainer)
    
    Creates a new paragraph
    
    Returns:
    
    The new paragraph
    
    Throws:
    
    Exception - if the file DOM could not be created.
    
    See Also:
    
    Paragraph.newParagraph(ParagraphContainer), addParagraph(String)
  - addText
```
public OdfTextParagraph addText(String text)
                         throws Exception
```
    Deprecated. As of Simple version 0.5, replaced by Paragraph.appendTextContent(String content)
    
    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.
    
    See Also:
    
    Paragraph.appendTextContent(String), Paragraph.appendTextContentNotCollapsed(String), getParagraphByIndex(int, boolean), getParagraphByReverseIndex(int, boolean)
  - changeMode
```
public void changeMode(TextDocument.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
  - appendSection
```
public Section appendSection(Section section,
                             boolean isResourceCopied)
```
    Copy a section and append it at the end of the text document, whether the section is in this document or in a different document.
    The IDs and names in this section would be changed to ensure unique.
    If the section contains a linked resource, isResourceCopied would specify whether the linked resource would be copied or not, when the copy and append happens within a same document.
    
    Parameters:
    
    section - - the section object
    
    isResourceCopied - - whether the linked resource is copied or not.
  - appendSection
```
public Section appendSection(String name)
```
    Create an empty section and append it at the end of the text document.
    
    Parameters:
    
    name - - specify the section name
    
    Returns:
    
    an instance of the section
    
    Throws:
    
    RuntimeException - if content DOM could not be initialized
  - getHeader
```
public Header getHeader()
```
    Get the Standard Page header of this text document.
    
    Returns:
    
    the Standard Page header of this text document.
    
    Since:
    
    0.4.5
  - getHeader
```
public Header getHeader(boolean isFirstPage)
```
    Get the header of this text document.
    
    Parameters:
    
    isFirstPage - if isFirstPage is true, return the First Page header, otherwise return Standard Page header.
    
    Returns:
    
    the header of this text document.
    
    Since:
    
    0.5
  - getFooter
```
public Footer getFooter()
```
    Get the Standard Page footer of this text document.
    
    Returns:
    
    the Standard Page footer of this text document.
    
    Since:
    
    0.4.5
  - getFooter
```
public Footer getFooter(boolean isFirstPage)
```
    Get the footer of this text document.
    
    Parameters:
    
    isFirstPage - if isFirstPage is true, return the First Page footer, otherwise return Standard Page footer.
    
    Returns:
    
    the footer of this text document.
    
    Since:
    
    0.5
  - 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.
    
    Specified by:
    
    getTableContainerElement in interface TableContainer
    
    Returns:
    
    container element which can hold .
  - getListContainerElement
```
public OdfElement getListContainerElement()
```
    Description copied from interface: ListContainer
    
    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 List. For example, element is usable with element, so TextDocument will return OfficeTextElement. While Presentation Notes is an indirectly ListContainer, which holds List with the help of its grand-child element , so for Notes, DrawTextBoxElement should be return.
    
    Specified by:
    
    getListContainerElement in interface ListContainer
    
    Returns:
    
    container element which can hold .
  - addList
```
public List addList()
```
    Description copied from interface: ListContainer
    
    Add a new List to this container.
    
    Specified by:
    
    addList in interface ListContainer
    
    Returns:
    
    added list.
  - addList
```
public List addList(ListDecorator decorator)
```
    Description copied from interface: ListContainer
    
    Add a List with specified ListDecorator to this container.
    
    Specified by:
    
    addList in interface ListContainer
    
    Parameters:
    
    decorator - the specified ListDecorator
    
    Returns:
    
    added list.
  - clearList
```
public void clearList()
```
    Description copied from interface: ListContainer
    
    Remove all Lists from this container.
    
    Specified by:
    
    clearList in interface ListContainer
  - getListIterator
```
public Iterator<List> getListIterator()
```
    Description copied from interface: ListContainer
    
    Return an Iterator of the Lists in this ListContainer. The Lists are iterated in the same order that they occur in the ListContainer.
    
    Specified by:
    
    getListIterator in interface ListContainer
    
    Returns:
    
    an Iterator of the Lists in this ListContainer
    
    See Also:
    
    Iterator
  - removeList
```
public boolean removeList(List list)
```
    Description copied from interface: ListContainer
    
    Remove the existing List from this container.
    
    Specified by:
    
    removeList in interface ListContainer
    
    Returns:
    
    true, if the container contains this List.
  - addPageBreak
```
public void addPageBreak()
```
    Appends a new page break to this document.
    
    Since:
    
    0.6.5
  - addPageBreak
```
public void addPageBreak(Paragraph refParagraph)
```
    Appends a new page break to this document after the reference paragraph.
    
    Parameters:
    
    refParagraph - the reference paragraph after where the page break inserted.
    
    Since:
    
    0.6.5
  - setPageColumns
```
public void setPageColumns(int columnsNumber,
                           double spacing)
```
    Defines several columns to the page whose style is specified.
    
    Parameters:
    
    columnsNumber - the number of columns (are of width identical)
    
    spacing - column spacing in cm (ex. 2.40 for 2,4 cm)
    
    Since:
    
    0.6.6
  - addColumnBreak
```
public void addColumnBreak()
```
    Appends a new column break to this document.
    
    Since:
    
    0.6.6
  - addColumnBreak
```
public void addColumnBreak(Paragraph refParagraph)
```
    Appends a new column break to this document after the reference paragraph.
    
    Parameters:
    
    refParagraph - the reference paragraph after where the column break inserted.
    
    Since:
    
    0.6.6
  - addPageBreak
```
public void addPageBreak(Paragraph refParagraph,
                         MasterPage master)
```
    Appends a new page break to this document after the reference paragraph, and the master page style will be applied to the new page.
    
    Parameters:
    
    refParagraph - the reference paragraph after where the page break inserted.
    
    master - the master page style applied to the new page.
    
    Since:
    
    0.8
  - addParagraph
```
public Paragraph addParagraph(String text)
```
    Creates a new paragraph and append text.
    
    Specified by:
    
    addParagraph in interface ParagraphContainer
    
    Parameters:
    
    text - the text content of this paragraph
    
    Returns:
    
    the new paragraph
  - removeParagraph
```
public boolean removeParagraph(Paragraph para)
```
    Remove paragraph from this document
    
    Specified by:
    
    removeParagraph in interface ParagraphContainer
    
    Parameters:
    
    para - the instance of paragraph
    
    Returns:
    
    true if the paragraph is removed successfully, false if errors happen.
  - getParagraphContainerElement
```
public OdfElement getParagraphContainerElement()
```
    Description copied from interface: ParagraphContainer
    
    Get the ODF element which can have as child element directly.
    
    Specified by:
    
    getParagraphContainerElement in interface ParagraphContainer
    
    Returns:
    
    - an ODF element which can have paragraph as child
  - getParagraphByIndex
```
public Paragraph getParagraphByIndex(int index,
                                     boolean isEmptyParagraphSkipped)
```
    Description copied from interface: ParagraphContainer
    
    Return a paragraph with a given index.
    An index of zero represents the first paragraph.
    If empty paragraph is skipped, the empty paragraph won't be counted.
    
    Specified by:
    
    getParagraphByIndex in interface ParagraphContainer
    
    Parameters:
    
    index - - the index started from 0.
    
    isEmptyParagraphSkipped - - whether the empty paragraph is skipped or not
    
    Returns:
    
    the paragraph with a given index
  - getParagraphByReverseIndex
```
public Paragraph getParagraphByReverseIndex(int reverseIndex,
                                            boolean isEmptyParagraphSkipped)
```
    Description copied from interface: ParagraphContainer
    
    Return a paragraph with a given index. The index is in reverse order.
    An index of zero represents the last paragraph.
    If empty paragraph is skipped, the empty paragraph won't be counted.
    
    Specified by:
    
    getParagraphByReverseIndex in interface ParagraphContainer
    
    Parameters:
    
    reverseIndex - - the index started from 0 in reverse order.
    
    isEmptyParagraphSkipped - - whether the empty paragraph is skipped or not
    
    Returns:
    
    the paragraph with a given index
  - getParagraphIterator
```
public Iterator<Paragraph> getParagraphIterator()
```
    Description copied from interface: ParagraphContainer
    
    Return an Iterator of the paragraph in this container.
    
    Specified by:
    
    getParagraphIterator in interface ParagraphContainer
    
    Returns:
    
    an Iterator of the paragraph in this container
  - declareVariable
```
public VariableField declareVariable(String name,
                                     VariableField.VariableType type)
```
    Description copied from interface: VariableContainer
    
    Declare a new variable field to this container.
    
    Specified by:
    
    declareVariable in interface VariableContainer
    
    Parameters:
    
    name - the unique name of this variable field.
    
    type - the type of this variable field.
    
    Returns:
    
    declared variable field.
  - getVariableFieldByName
```
public VariableField getVariableFieldByName(String name)
```
    Description copied from interface: VariableContainer
    
    Return the declared variable by name.
    
    Specified by:
    
    getVariableFieldByName in interface VariableContainer
    
    Parameters:
    
    name - the unique name of this variable field.
    
    Returns:
    
    the declared variable.
  - getVariableContainerElement
```
public OdfElement getVariableContainerElement()
```
    Description copied from interface: VariableContainer
    
    Get the ODF element which can have variable declare section as child element directly according to ODF specification. This element will help to find the position to declare a new variable.
    The variable declare section may be , or .
    
    Specified by:
    
    getVariableContainerElement in interface VariableContainer
    
    Returns:
    
    container element which can hold variable declare section.
  - createChart
```
public Chart createChart(String title,
                         DataSet dataset,
                         Rectangle rect)
```
    Description copied from interface: ChartContainer
    
    Creates a new Chart for this container.
    
    Specified by:
    
    createChart in interface ChartContainer
    
    Parameters:
    
    title - chart title.
    
    dataset - chart data set.
    
    rect - chart rectangle.
    
    Returns:
    
    the created chart.
  - createChart
```
public Chart createChart(String title,
                         SpreadsheetDocument document,
                         CellRangeAddressList cellRangeAddr,
                         boolean firstRowAsLabel,
                         boolean firstColumnAsLabel,
                         boolean rowAsDataSeries,
                         Rectangle rect)
```
    Description copied from interface: ChartContainer
    
    Creates a new Chart for this container.
    
    Specified by:
    
    createChart in interface ChartContainer
    
    Parameters:
    
    title - chart title.
    
    document - the data source spreadsheet document.
    
    cellRangeAddr - the cell range address list which is used as chart data set.
    
    firstRowAsLabel - whether uses first row as label.
    
    firstColumnAsLabel - whether uses first column as label.
    
    rowAsDataSeries - whether uses data as series.
    
    rect - chart rectangle.
    
    Returns:
    
    the created chart.
  - createChart
```
public Chart createChart(String title,
                         String[] labels,
                         String[] legends,
                         double[][] data,
                         Rectangle rect)
```
    Description copied from interface: ChartContainer
    
    Creates a new Chart for this container.
    
    Specified by:
    
    createChart in interface ChartContainer
    
    Parameters:
    
    title - chart rectangle.
    
    labels - label strings
    
    legends - legend strings
    
    data - chart data set.
    
    rect - chart rectangle.
    
    Returns:
    
    the created chart.
  - deleteChartById
```
public void deleteChartById(String chartId)
```
    Description copied from interface: ChartContainer
    
    Deletes chart by chart id.
    
    Specified by:
    
    deleteChartById in interface ChartContainer
    
    Parameters:
    
    chartId - the id of specified chart.
  - deleteChartByTitle
```
public void deleteChartByTitle(String title)
```
    Description copied from interface: ChartContainer
    
    Deletes chart(s) by chart title.
    
    Specified by:
    
    deleteChartByTitle in interface ChartContainer
    
    Parameters:
    
    title - the title of specified chart(s).
  - getChartById
```
public Chart getChartById(String chartId)
```
    Description copied from interface: ChartContainer
    
    Gets chart with specified id.
    
    Specified by:
    
    getChartById in interface ChartContainer
    
    Parameters:
    
    chartId - the id of this chart.
    
    Returns:
    
    the chart with specified id.
  - getChartByTitle
```
public List<Chart> getChartByTitle(String title)
```
    Description copied from interface: ChartContainer
    
    Gets chart list with specified title.
    
    Specified by:
    
    getChartByTitle in interface ChartContainer
    
    Parameters:
    
    title - the title of specified chart(s).
    
    Returns:
    
    the chart(s) with specified title.
  - getChartCount
```
public int getChartCount()
```
    Description copied from interface: ChartContainer
    
    Returns the chart count of this container
    
    Specified by:
    
    getChartCount in interface ChartContainer
    
    Returns:
    
    the chart count of this container
  - createDefaultTOC
```
public TextTableOfContentElement createDefaultTOC(Paragraph refParagraph,
                                                  boolean before)
```
    Create a new Table Of Content to this document before the reference paragraph. Because until you do a full layout of the document, taking into account font metrics,line breaking algorithms, hyphenation, image positioning, "orphan and widow" rules, etc., you don't know what content is on which page. So all the page numbers in TOC are be set value "1". Please update the page numbers from AOO Menus: Tools->Update->All Indexes and Tables
    
    Parameters:
    
    refParagraph - the reference paragraph where the TOC be inserted.
    
    before - true:insert TOC before the reference paragraph. false:insert TOC after the reference paragraph.
    
    Since:
    
    0.8.6
  - createTOCwithStyle
```
public TextTableOfContentElement createTOCwithStyle(Paragraph refParagraph,
                                                    TOCStyle additionalStyle,
                                                    boolean before)
```
    Create a new Table Of Content to this document before the reference paragraph. The additional paragraph styles list will be included in the TOC. Because until you do a full layout of the document, taking into account font metrics,line breaking algorithms, hyphenation, image positioning, "orphan and widow" rules, etc., you don't know what content is on which page. So all the page numbers in TOC are be set value "1". Please update the page numbers from AOO Menus: Tools->Update->All Indexes and Tables. If additionalStyle is null then call createDefaultTOC().
    
    Parameters:
    
    refParagraph - the reference paragraph before where the TOC inserted.
    
    additionalStyle - the additional paragraph styles that you want to include in the TOC
    
    before - true:insert TOC before the reference paragraph. false:insert TOC after the reference paragraph.
    
    Since:
    
    0.8.6
  - insertParagraph
```
public Paragraph insertParagraph(Paragraph referenceParagraph,
                                 Paragraph sourceParagraph,
                                 boolean before)
```
    Copy a Paragraph and insert it before or after the Reference Paragraph in the text document, whether the Paragraph is in this document or in a different document.
    
    Parameters:
    
    referenceParagraph - - where the Paragraph be inserted
    
    sourceParagraph - - the Paragraph which will be copied
    
    before - true:insert Paragraph before the reference paragraph. false:insert Paragraph after the reference paragraph.
  - insertTable
```
public Table insertTable(Paragraph referenceParagraph,
                         Table sourceTable,
                         boolean before)
```
    Copy a Table and insert it before or after the Reference Paragraph in the text document, whether the Table is in this TextDocument or in a different Document.
    
    Parameters:
    
    referenceParagraph - - where the Paragraph be inserted
    
    sourceParagraph - - the Paragraph which will be copied
    
    before - true:insert Paragraph before the reference paragraph. false:insert Paragraph after the reference paragraph.
  - insertOdfElement
```
public OdfElement insertOdfElement(OdfElement referenceOdfElement,
                                   Document sourceDocument,
                                   OdfElement sourceOdfElement,
                                   boolean before)
```
    Copy a OdfElement and insert it before or after the Reference OdfElement in the TextDocument, whether the OdfElement is in this TextDocument or in a different Document.
    
    Parameters:
    
    referenceOdfElement - - where the OdfElement be inserted
    
    sourceDocument - - the source Document which contain the sourceOdfElement
    
    sourceOdfElement - - the OdfElement which will be copied
    
    before - true:insert OdfElement before the reference OdfElement. false:insert OdfElement after the reference OdfElement.
  - insertContentFromDocumentAfter
```
public void insertContentFromDocumentAfter(TextDocument sourceDocument,
                                           Paragraph referenceParagraph,
                                           boolean isCopyStyle)
```
    Copy text content of the source TextDocument and insert it to the current TextDocument after the reference Paragraph, with Styles or without Styles.
    
    Parameters:
    
    sourceDocument - the source TextDocument
    
    referenceParagraph - where the text content of the source TextDocument be inserted
    
    isCopyStyle - true:copy the styles in source document to current TextDocment. false:don't copy the styles in source document to current TextDocment.
  - insertContentFromDocumentBefore
```
public void insertContentFromDocumentBefore(TextDocument sourceDocument,
                                            Paragraph referenceParagraph,
                                            boolean isCopyStyle)
```
    Copy text content of the source TextDocument and insert it to the current TextDocument before the reference Paragraph, with Styles or without Styles.
    
    Parameters:
    
    srcDoc - the source TextDocument
    
    referenceParagraph - where the text content of the source TextDocument be inserted
    
    isCopyStyle - true:copy the styles in source document to current TextDocment. false:don't copy the styles in source document to current TextDocment.
  - createForm
```
public Form createForm(String name)
```
    Create a form with specified name in this text document.
    
    Specified by:
    
    createForm in interface FormContainer
    
    Parameters:
    
    name - - form name, represents attribute form:name
    
    Returns:
    
    an instance of Form
    
    See Also:
    
    FormContainer.createForm(String)
  - getFormIterator
```
public Iterator<Form> getFormIterator()
```
    Get a form iterator to traverse all the forms in this document.
    
    Specified by:
    
    getFormIterator in interface FormContainer
    
    Returns:
    
    form iterator
    
    See Also:
    
    FormContainer.getFormIterator()
  - removeForm
```
public boolean removeForm(Form form)
```
    Remove a form with the specified name in this document.
    
    Specified by:
    
    removeForm in interface FormContainer
    
    Parameters:
    
    form - - the form to be removed
    
    Returns:
    
    true if the form is removed successfully, false if errors happen.
    
    See Also:
    
    FormContainer.removeForm(Form)
  - getFormByName
```
public Form getFormByName(String name)
```
    Description copied from interface: FormContainer
    
    Return a form whose name is a given value.
    
    Specified by:
    
    getFormByName in interface FormContainer
    
    Parameters:
    
    name - - the name of the form
    
    Returns:
    
    a form whose name is a given value
  - getFormContainerElement
```
public OfficeFormsElement getFormContainerElement()
```
    Description copied from interface: FormContainer
    
    Get the ODF element OfficeFormsElement which can have FormFormElement as child element directly according to ODF specification. This element will help to find the position to insert a new FormFormElement element.
    
    Specified by:
    
    getFormContainerElement in interface FormContainer
    
    Returns:
    
    the element of office:forms
  - getApplyDesignMode
```
public boolean getApplyDesignMode()
```
    Description copied from interface: FormContainer
    
    Get the attribute form:apply-design-mode which specifies whether forms are presented in editable or non-editable state.
    
    Specified by:
    
    getApplyDesignMode in interface FormContainer
    
    Returns:
    
    true if forms in document are presented in editable state;false if forms in document are presented in completed state
  - getAutomaticFocus
```
public boolean getAutomaticFocus()
```
    Description copied from interface: FormContainer
    
    Get the attribute form:automatic-focus which specifies whether the consumer loading the document should set the focus to a form control.
    
    Specified by:
    
    getAutomaticFocus in interface FormContainer
    
    Returns:
    
    true if sets the focus to a form control after loading the document; false if else.
  - setApplyDesignMode
```
public void setApplyDesignMode(boolean isDesignMode)
```
    Description copied from interface: FormContainer
    
    Set the attribute form:apply-design-mode which specifies whether forms are presented in editable or non-editable state.
    
    Specified by:
    
    setApplyDesignMode in interface FormContainer
    
    Parameters:
    
    isDesignMode - - true if forms in document are presented in editable state; false if forms in document are presented in completed state
  - setAutomaticFocus
```
public void setAutomaticFocus(boolean isAutoFocus)
```
    Description copied from interface: FormContainer
    
    Set the attribute form:automatic-focus which specifies whether the consumer loading the document should set the focus to a form control.
    
    Specified by:
    
    setAutomaticFocus in interface FormContainer
    
    Parameters:
    
    isAutoFocus - -true if sets the focus to a form control after loading the document; false if else.
  - createDrawControl
```
public Control createDrawControl()
```
    Description copied from interface: ControlContainer
    
    Create an instance of control and and append it at the end of this container.
    
    Specified by:
    
    createDrawControl in interface ControlContainer
    
    Returns:
    
    a control instance
  - getDrawControlContainerElement
```
public OdfElement getDrawControlContainerElement()
```
    Description copied from interface: ControlContainer
    
    Get the ODF element which can have DrawControlElement as child element directly.
    
    Specified by:
    
    getDrawControlContainerElement in interface ControlContainer
    
    Returns:
    
    - an ODF element which can have control as child
  - addTable
```
public Table addTable(int numRows,
                      int numCols,
                      int headerRowNumber,
                      int headerColumnNumber)
```
    Add a new Table to this container with a specified row number and column number.
    The table will be inserted at the end of the tableContainer. An unique table name will be given, you may set a custom table name using the setTableName method.
    
    Parameters:
    
    numRows - the row number
    
    numCols - the column number
    
    headerRowNumber - the header row number
    
    headerColumnNumber - the header column number
    
    Returns:
    
    a new instance of Table

Class TextDocument

Nested Class Summary

Nested classes/interfaces inherited from class org.odftoolkit.simple.Document

Nested classes/interfaces inherited from class org.odftoolkit.odfdom.dom.OdfSchemaDocument

Nested classes/interfaces inherited from class org.odftoolkit.odfdom.pkg.OdfPackageDocument

Field Summary

Fields inherited from class org.odftoolkit.simple.Document

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

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

Constructor Summary

Method Summary

Methods inherited from class org.odftoolkit.simple.Document

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

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

Methods inherited from class java.lang.Object

Constructor Detail

TextDocument

Method Detail

newTextDocument

newTextDocument

newTextTemplateDocument

newTextMasterDocument

newTextWebDocument

loadDocument

loadDocument

loadDocument

getContentRoot

newParagraph

newParagraph

addText

changeMode

appendSection

appendSection

getHeader

getHeader

getFooter

getFooter

getTableContainerElement

getListContainerElement

addList

addList

clearList

getListIterator

removeList

addPageBreak

addPageBreak

setPageColumns

addColumnBreak

addColumnBreak

addPageBreak

addParagraph

removeParagraph

getParagraphContainerElement

getParagraphByIndex

getParagraphByReverseIndex

getParagraphIterator

declareVariable

getVariableFieldByName

getVariableContainerElement

createChart

createChart

createChart

deleteChartById

deleteChartByTitle

getChartById

getChartByTitle

getChartCount

createDefaultTOC

createTOCwithStyle

insertParagraph

insertTable

insertOdfElement

insertContentFromDocumentAfter

insertContentFromDocumentBefore

createForm

getFormIterator

removeForm

getFormByName

getFormContainerElement

getApplyDesignMode