ag.ion.bion.officelayer.internal.text
Class Paragraph

java.lang.Object
  ag.ion.bion.officelayer.text.AbstractTextComponent
      ag.ion.bion.officelayer.internal.text.Paragraph

All Implemented Interfaces:

ICloneServiceProvider, IParagraph, ITextComponent, ITextContent

public class Paragraph
extends AbstractTextComponent
implements IParagraph

Paragraph of a text document.

Field Summary

Fields inherited from class ag.ion.bion.officelayer.text.AbstractTextComponent

textDocument

Constructor Summary

Paragraph(ITextDocument textDocument, com.sun.star.text.XTextContent xTextContent)
Constructs new Paragraph.

Method Summary

ICharacterProperties	getCharacterProperties() Returns character properties belonging to the paragraph
ICharacterPropertyStore	getCharacterPropertyStore() Gets the character property store of the paragraph
ICloneService	getCloneService() Gets the clone service of the element.
IParagraphProperties	getParagraphProperties() Returns properties of the paragraph.
IParagraphPropertyStore	getParagraphPropertyStore() Gets the property store of the paragraph
java.lang.String	getParagraphText() Gets the text contained in this pragraph
ITextRange	getTextRange() Returns text range of the text table.
com.sun.star.text.XTextContent	getXTextContent() Returns OpenOffice.org XTextContent interface.
void	setParagraphText(java.lang.String text) Sets new text to the paragraph.

Methods inherited from class ag.ion.bion.officelayer.text.AbstractTextComponent

getTextDocument

Methods inherited from class java.lang.Object

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

Methods inherited from interface ag.ion.bion.officelayer.text.ITextComponent

getTextDocument

Constructor Detail

Paragraph

public Paragraph(ITextDocument textDocument,
                 com.sun.star.text.XTextContent xTextContent)
          throws java.lang.IllegalArgumentException

Constructs new Paragraph.

Parameters:

textDocument - text document to be used

xTextContent - OpenOffice.org XTextContent interface

Throws:

java.lang.IllegalArgumentException - if the OpenOffice.org interface or the document is not valid

Method Detail

getXTextContent

public com.sun.star.text.XTextContent getXTextContent()

Returns OpenOffice.org XTextContent interface.

Specified by:

getXTextContent in interface ITextContent

Returns:

OpenOffice.org XTextContent interface

getTextRange

public ITextRange getTextRange()

Returns text range of the text table.

Specified by:

getTextRange in interface IParagraph

Returns:

text range of the text table

getParagraphProperties

public IParagraphProperties getParagraphProperties()

Returns properties of the paragraph.

Specified by:

getParagraphProperties in interface IParagraph

Returns:

properties of the paragraph

getCharacterProperties

public ICharacterProperties getCharacterProperties()

Returns character properties belonging to the paragraph

Specified by:

getCharacterProperties in interface IParagraph

Returns:

characterproperties of the paragraph

getParagraphPropertyStore

public IParagraphPropertyStore getParagraphPropertyStore()
                                                  throws TextException

Gets the property store of the paragraph

Specified by:

getParagraphPropertyStore in interface IParagraph

Returns:

the paragprah property store

Throws:

TextException - if any error occurs

getCharacterPropertyStore

public ICharacterPropertyStore getCharacterPropertyStore()
                                                  throws TextException

Gets the character property store of the paragraph

Specified by:

getCharacterPropertyStore in interface IParagraph

Returns:

the paragraph's character property store

Throws:

TextException - if any error occurs getting the store

getCloneService

public ICloneService getCloneService()
                              throws CloneException

Gets the clone service of the element.

Specified by:

getCloneService in interface ICloneServiceProvider

Returns:

the clone service

Throws:

CloneException - if the clone service could not be returned

getParagraphText

public java.lang.String getParagraphText()
                                  throws TextException

Gets the text contained in this pragraph

Specified by:

getParagraphText in interface IParagraph

Returns:

the paragraph text or null if text cannot be gained

Throws:

TextException - if there occurs an error while fetching the text

setParagraphText

public void setParagraphText(java.lang.String text)

Sets new text to the paragraph.

Specified by:

setParagraphText in interface IParagraph

Parameters:

text - the text that should be placed