ag.ion.bion.officelayer.text
Interface ITextRange

All Known Subinterfaces:

IBookmark

All Known Implementing Classes:

Bookmark, TextRange

public interface ITextRange

Range of text in a text document.

Method Summary

short	compareRange(ITextRange textRangeToCompare) Compares this text range with the given text range.
ITextTableCell	getCell() Returns cell of the texttable if the text range is part of cell.
IPageStyle	getPageStyle() Returns related page style of the text range.
com.sun.star.text.XTextRange	getXTextRange() Returns OpenOffice.org XTextRange interface.
void	setDocument(IDocument document) Sets the document of the text range.
void	setText(java.lang.String text) Sets text of the text range.

Method Detail

getXTextRange

com.sun.star.text.XTextRange getXTextRange()

Returns OpenOffice.org XTextRange interface. This method is not part of the public API. It should never used from outside.

Returns:

OpenOffice.org XTextRange interface

setText

void setText(java.lang.String text)

Sets text of the text range.

Parameters:

text - text to be used

getPageStyle

IPageStyle getPageStyle()
                        throws TextException

Returns related page style of the text range.

Returns:

page style of the text range

Throws:

TextException

getCell

ITextTableCell getCell()

Returns cell of the texttable if the text range is part of cell.

Returns:

cell of the texttable if the text range is part of cell or null if the text range is not part of a cell

compareRange

short compareRange(ITextRange textRangeToCompare)
                   throws TextException

Compares this text range with the given text range. Returns 1 if this range starts before the given text range, 0 if the text ranges start at the same position and -1 if this text range starts behin the given text range.

Parameters:

textRangeToCompare - the text range to compare

Returns:

1 if this range starts before the given text range, 0 if the text ranges start at the same position and -1 if this text range starts behin the given text range

Throws:

TextException - if the text ranges to compare are not within the same text.

setDocument

void setDocument(IDocument document)

Sets the document of the text range. This makes sense if the text range was generated as the document was unknown.

Parameters:

document - document to be used