org.odftoolkit.simple.text

Class AbstractParagraphContainer

java.lang.Object

org.odftoolkit.simple.text.AbstractParagraphContainer

All Implemented Interfaces:

ParagraphContainer

public abstract class AbstractParagraphContainer
extends Object
implements ParagraphContainer

AbstractParagraphContainer is an abstract class to present paragraph container. It contains the default implementation to add/get/remove paragraph. Each subclass needs to implement getParagraphContainerElement().

Since:

0.5

Constructor Summary

Constructors

Constructor and Description
AbstractParagraphContainer()

Method Summary

Modifier and Type	Method and Description
Paragraph	addParagraph(String textContent) Add paragraph at the end of the container with specified text content.
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.
abstract 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.
boolean	removeParagraph(Paragraph para) Remove paragraph from the container

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractParagraphContainer

public AbstractParagraphContainer()

Method Detail

getParagraphContainerElement

public abstract 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

addParagraph

public Paragraph addParagraph(String textContent)

Add paragraph at the end of the container with specified text content.

Specified by:

addParagraph in interface ParagraphContainer

Parameters:

textContent - the text content

Returns:

an instance of paragraph

removeParagraph

public boolean removeParagraph(Paragraph para)

Remove paragraph from the container

Specified by:

removeParagraph in interface ParagraphContainer

Parameters:

para - the instance of paragraph

Returns:

true if the paragraph is removed successfully, false if errors happen.

getParagraphIterator

public Iterator<Paragraph> getParagraphIterator()

Return an Iterator of the paragraph in this container.

Specified by:

getParagraphIterator in interface ParagraphContainer

Returns:

an Iterator of the paragraph in this container

getParagraphByIndex

public Paragraph getParagraphByIndex(int index,
                                     boolean isEmptyParagraphSkipped)

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)

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.