ag.ion.bion.officelayer.text
Interface ITextCursor

All Known Implementing Classes:

TextCursor

public interface ITextCursor

Cursor of a text document.

Method Summary

ICharacterProperties	getCharacterProperties() Returns the character properties.
ITextRange	getEnd() Returns end position of the cursor.
short	getEndPageNumber() Returns the page number of the text cursor end, returns -1 if page number could not be determined.
ITextRange	getStart() Returns start position of the cursor.
short	getStartPageNumber() Returns the page number of the text cursor start, returns -1 if page number could not be determined.
java.lang.String	getString() Gets the text that is marked by the cursor.
void	goLeft(short stepNumber, boolean mark) Goes to the submitted position.
void	goRight(short stepNumber, boolean mark) Goes to the submitted position.
void	gotoEnd(boolean mark) Sets the cursor to the end position (wherever it is currently).
void	gotoEndOfParagraph(boolean mark) Moves the cursor to the end of the current paragraph.
void	gotoEndOfSentence(boolean mark) Moves the cursor to the end of the current sentence.
boolean	gotoEndOfWord(boolean mark) Moves the cursor to the end of the current word.
void	gotoNextParagraph(boolean mark) Moves the cursor to the next paragraph.
void	gotoNextSentence(boolean mark) Moves the cursor to the next sentence.
boolean	gotoNextWord(boolean mark) Moves the cursor to the next word.
void	gotoPreviousParagraph(boolean mark) Moves the cursor to the previous paragraph.
void	gotoPreviousSentence(boolean mark) Moves the cursor to the previous sentence.
boolean	gotoPreviousWord(boolean mark) Moves the cursor to the previous word.
void	gotoRange(ITextRange range, boolean mark) Goes to the submitted position.
void	gotoStart(boolean mark) Sets the cursor to the start position (wherever it is currently).
void	gotoStartOfParagraph(boolean mark) Moves the cursor to the start of the current paragraph.
void	gotoStartOfSentence(boolean mark) Moves the cursor to the start of the current sentence.
boolean	gotoStartOfWord(boolean mark) Moves the cursor to the start of the current word.
void	insertDocument(java.io.InputStream inputStream, IFilter filter) Inserts a file stream at the current cursor location.
void	insertDocument(java.lang.String url) Inserts a text document at the current cursor location.
void	insertPageBreak() Inserts page break at the current cursor position.
boolean	isEndOfParagraph() Returns if the cursor is positioned at the end of a paragraph.
boolean	isEndOfSentence() Returns if the cursor is positioned at the end of a sentence.
boolean	isEndOfWord() Returns if the cursor is positioned at the end of a word.
boolean	isStartOfParagraph() Returns if the cursor is positioned at the start of a paragraph.
boolean	isStartOfSentence() Returns if the cursor is positioned at the start of a sentence.
boolean	isStartOfWord() Returns if the cursor is positioned at the start of a word.
void	setString(java.lang.String content) Sets content to the cursor.
boolean	supportsParagraphCursor() Returns if the current cursor supports paragraph cursor operations.
boolean	supportsSentenceCursor() Returns if the current cursor supports sentence cursor operations.
boolean	supportsWordCursor() Returns if the current cursor supports word cursor operations.

Method Detail

getCharacterProperties

ICharacterProperties getCharacterProperties()

Returns the character properties.

Returns:

character properties

gotoEnd

void gotoEnd(boolean mark)

Sets the cursor to the end position (wherever it is currently).

Parameters:

mark - indicates if the space between the current position and the end is to be marked

gotoStart

void gotoStart(boolean mark)

Sets the cursor to the start position (wherever it is currently).

Parameters:

mark - indicates if the space between the current position and the start is to be marked

gotoRange

void gotoRange(ITextRange range,
               boolean mark)

Goes to the submitted position.

Parameters:

range - the range that specifies where to got

mark - indicates if the space between the current position and the new one is to be marked

setString

void setString(java.lang.String content)

Sets content to the cursor.

Parameters:

content - content to be used

getString

java.lang.String getString()

Gets the text that is marked by the cursor.

Returns:

the text marked

goLeft

void goLeft(short stepNumber,
            boolean mark)

Goes to the submitted position.

Parameters:

stepNumber - stepNumber the number of cursor steps to jump

mark - mark indicates if the space between the current position and the new one is to be marked

goRight

void goRight(short stepNumber,
             boolean mark)

Goes to the submitted position.

Parameters:

stepNumber - the number of cursor steps to jump

mark - mark indicates if the space between the current position and the new one is to be marked

getStart

ITextRange getStart()

Returns start position of the cursor.

Returns:

start position of the cursor

getEnd

ITextRange getEnd()

Returns end position of the cursor.

Returns:

end position of the cursor

getStartPageNumber

short getStartPageNumber()

Returns the page number of the text cursor start, returns -1 if page number could not be determined.

Returns:

the page number of the text cursor start, returns -1 if page number could not be determined

getEndPageNumber

short getEndPageNumber()

Returns the page number of the text cursor end, returns -1 if page number could not be determined.

Returns:

the page number of the text cursor end, returns -1 if page number could not be determined

insertPageBreak

void insertPageBreak()
                     throws NOAException

Inserts page break at the current cursor position.

Throws:

NOAException - if the page break can not be set

insertDocument

void insertDocument(java.lang.String url)
                    throws NOAException

Inserts a text document at the current cursor location.

Parameters:

url - URL of the document (must look like file:///c:/test.odt)

Throws:

NOAException - if the text document can not be inserted

insertDocument

void insertDocument(java.io.InputStream inputStream,
                    IFilter filter)
                    throws NOAException

Inserts a file stream at the current cursor location.

Parameters:

inputStream - a file stream to be inserted

filter - the filter that the stream is baes on

Throws:

NOAException - if the file stream can not be inserted

supportsWordCursor

boolean supportsWordCursor()

Returns if the current cursor supports word cursor operations.

Returns:

if the current cursor supports word cursor operations

isStartOfWord

boolean isStartOfWord()
                      throws NOAException

Returns if the cursor is positioned at the start of a word.

Returns:

if the cursor is positioned at the start of a word

Throws:

NOAException - if word cursor operations are not supported

isEndOfWord

boolean isEndOfWord()
                    throws NOAException

Returns if the cursor is positioned at the end of a word.

Returns:

if the cursor is positioned at the end of a word

Throws:

NOAException - if word cursor operations are not supported

gotoNextWord

boolean gotoNextWord(boolean mark)
                     throws NOAException

Moves the cursor to the next word.

Parameters:

mark - mark indicates if the space between the current position and the new one is to be marked

Returns:

if the cursor could be positioned

Throws:

NOAException - if word cursor operations are not supported

gotoPreviousWord

boolean gotoPreviousWord(boolean mark)
                         throws NOAException

Moves the cursor to the previous word.

Parameters:

mark - mark indicates if the space between the current position and the new one is to be marked

Returns:

if the cursor could be positioned

Throws:

NOAException - if word cursor operations are not supported

gotoEndOfWord

boolean gotoEndOfWord(boolean mark)
                      throws NOAException

Moves the cursor to the end of the current word.

Parameters:

mark - mark indicates if the space between the current position and the new one is to be marked

Returns:

if the cursor could be positioned

Throws:

NOAException - if word cursor operations are not supported

gotoStartOfWord

boolean gotoStartOfWord(boolean mark)
                        throws NOAException

Moves the cursor to the start of the current word.

Parameters:

mark - mark indicates if the space between the current position and the new one is to be marked

Returns:

if the cursor could be positioned

Throws:

NOAException - if word cursor operations are not supported

supportsSentenceCursor

boolean supportsSentenceCursor()

Returns if the current cursor supports sentence cursor operations.

Returns:

if the current cursor supports sentence cursor operations

isStartOfSentence

boolean isStartOfSentence()
                          throws NOAException

Returns if the cursor is positioned at the start of a sentence.

Returns:

if the cursor is positioned at the start of a sentence

Throws:

NOAException - if sentence cursor operations are not supported

isEndOfSentence

boolean isEndOfSentence()
                        throws NOAException

Returns if the cursor is positioned at the end of a sentence.

Returns:

if the cursor is positioned at the end of a sentence

Throws:

NOAException - if sentence cursor operations are not supported

gotoNextSentence

void gotoNextSentence(boolean mark)
                      throws NOAException

Moves the cursor to the next sentence.

Parameters:

mark - mark indicates if the space between the current position and the new one is to be marked

Throws:

NOAException - if sentence cursor operations are not supported

gotoPreviousSentence

void gotoPreviousSentence(boolean mark)
                          throws NOAException

Moves the cursor to the previous sentence.

Parameters:

mark - mark indicates if the space between the current position and the new one is to be marked

Throws:

NOAException - if sentence cursor operations are not supported

gotoEndOfSentence

void gotoEndOfSentence(boolean mark)
                       throws NOAException

Moves the cursor to the end of the current sentence.

Parameters:

mark - mark indicates if the space between the current position and the new one is to be marked

Throws:

NOAException - if sentence cursor operations are not supported

gotoStartOfSentence

void gotoStartOfSentence(boolean mark)
                         throws NOAException

Moves the cursor to the start of the current sentence.

Parameters:

mark - mark indicates if the space between the current position and the new one is to be marked

Throws:

NOAException - if sentence cursor operations are not supported

supportsParagraphCursor

boolean supportsParagraphCursor()

Returns if the current cursor supports paragraph cursor operations.

Returns:

if the current cursor supports paragraph cursor operations

isStartOfParagraph

boolean isStartOfParagraph()
                           throws NOAException

Returns if the cursor is positioned at the start of a paragraph.

Returns:

if the cursor is positioned at the start of a paragraph

Throws:

NOAException - if paragraph cursor operations are not supported

isEndOfParagraph

boolean isEndOfParagraph()
                         throws NOAException

Returns if the cursor is positioned at the end of a paragraph.

Returns:

if the cursor is positioned at the end of a paragraph

Throws:

NOAException - if paragraph cursor operations are not supported

gotoNextParagraph

void gotoNextParagraph(boolean mark)
                       throws NOAException

Moves the cursor to the next paragraph.

Parameters:

mark - mark indicates if the space between the current position and the new one is to be marked

Throws:

NOAException - if paragraph cursor operations are not supported

gotoPreviousParagraph

void gotoPreviousParagraph(boolean mark)
                           throws NOAException

Moves the cursor to the previous paragraph.

Parameters:

mark - mark indicates if the space between the current position and the new one is to be marked

Throws:

NOAException - if paragraph cursor operations are not supported

gotoEndOfParagraph

void gotoEndOfParagraph(boolean mark)
                        throws NOAException

Moves the cursor to the end of the current paragraph.

Parameters:

mark - mark indicates if the space between the current position and the new one is to be marked

Throws:

NOAException - if paragraph cursor operations are not supported

gotoStartOfParagraph

void gotoStartOfParagraph(boolean mark)
                          throws NOAException

Moves the cursor to the start of the current paragraph.

Parameters:

mark - mark indicates if the space between the current position and the new one is to be marked

Throws:

NOAException - if paragraph cursor operations are not supported