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

java.lang.Object
  ag.ion.bion.officelayer.internal.text.ViewCursor

All Implemented Interfaces:

IViewCursor

public class ViewCursor
extends java.lang.Object
implements IViewCursor

Visible cursor implementation of a text document.

Constructor Summary

ViewCursor(ITextDocument textDocument, com.sun.star.text.XTextViewCursor xTextViewCursor)
Constructs new ViewCursor.

Method Summary

IPageCursor	getPageCursor() Returns the page cursor for the view cursor, can be null if no page cursor is available.
ITextRange	getStartTextRange() Returns start text range of the cursor.
ITextCursor	getTextCursorFromEnd() Returns new text cursor from the end position of the view cursor.
ITextCursor	getTextCursorFromStart() Returns new text cursor from the start position of the view cursor.
void	goToRange(ITextRange textRange, boolean select) Moves to the given text range.

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewCursor

public ViewCursor(ITextDocument textDocument,
                  com.sun.star.text.XTextViewCursor xTextViewCursor)
           throws java.lang.IllegalArgumentException

Constructs new ViewCursor.

Parameters:

textDocument - text document to be used

xTextViewCursor - OpenOffice.org XTextViewCursor interface to be used

Throws:

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

Method Detail

getStartTextRange

public ITextRange getStartTextRange()

Returns start text range of the cursor.

Specified by:

getStartTextRange in interface IViewCursor

Returns:

start text range of the cursor

getTextCursorFromStart

public ITextCursor getTextCursorFromStart()

Returns new text cursor from the start position of the view cursor.

Specified by:

getTextCursorFromStart in interface IViewCursor

Returns:

new text cursor from the start position of the view cursor

getTextCursorFromEnd

public ITextCursor getTextCursorFromEnd()

Returns new text cursor from the end position of the view cursor.

Specified by:

getTextCursorFromEnd in interface IViewCursor

Returns:

new text cursor from the end position of the view cursor

goToRange

public void goToRange(ITextRange textRange,
                      boolean select)

Moves to the given text range.

Specified by:

goToRange in interface IViewCursor

Parameters:

textRange - the text range to go to

select - if to extend the selection

getPageCursor

public IPageCursor getPageCursor()

Returns the page cursor for the view cursor, can be null if no page cursor is available.

Specified by:

getPageCursor in interface IViewCursor

Returns:

the page cursor for the view cursor, can be null