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

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

All Implemented Interfaces:

IPageCursor

public class PageCursor
extends java.lang.Object
implements IPageCursor

Page cursor of a text document.

Constructor Summary

PageCursor(com.sun.star.text.XPageCursor xPageCursor)
Constructs new PageCursor.

Method Summary

short	getPage() Returns the number of the page within the document of this cursor.
void	jumpToEndOfPage() Moves the cursor to the end of the current page.
void	jumpToFirstPage() Moves the cursor to the first page.
void	jumpToLastPage() Moves the cursor to the last page.
void	jumpToNextPage() Moves the cursor to the next page.
void	jumpToPage(short pageNumber) Moves the cursor to the specified page.
void	jumpToPreviousPage() Moves the cursor to the previous page.
void	jumpToStartOfPage() Moves the cursor to the start of the current page.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageCursor

public PageCursor(com.sun.star.text.XPageCursor xPageCursor)
           throws java.lang.IllegalArgumentException

Constructs new PageCursor.

Parameters:

xPageCursor - OpenOffice.org XPageCursor interface to be used

Throws:

java.lang.IllegalArgumentException - if the submitted OpenOffice.org XPageCursor interface is not valid

Method Detail

jumpToFirstPage

public void jumpToFirstPage()

Moves the cursor to the first page.

Specified by:

jumpToFirstPage in interface IPageCursor

jumpToLastPage

public void jumpToLastPage()

Moves the cursor to the last page.

Specified by:

jumpToLastPage in interface IPageCursor

jumpToPage

public void jumpToPage(short pageNumber)

Moves the cursor to the specified page.

Specified by:

jumpToPage in interface IPageCursor

Parameters:

pageNumber - the page number to jump to

getPage

public short getPage()

Returns the number of the page within the document of this cursor.

Specified by:

getPage in interface IPageCursor

Returns:

the number of the page within the document of this cursor

jumpToNextPage

public void jumpToNextPage()

Moves the cursor to the next page.

Specified by:

jumpToNextPage in interface IPageCursor

jumpToPreviousPage

public void jumpToPreviousPage()

Moves the cursor to the previous page.

Specified by:

jumpToPreviousPage in interface IPageCursor

jumpToEndOfPage

public void jumpToEndOfPage()

Moves the cursor to the end of the current page.

Specified by:

jumpToEndOfPage in interface IPageCursor

jumpToStartOfPage

public void jumpToStartOfPage()

Moves the cursor to the start of the current page.

Specified by:

jumpToStartOfPage in interface IPageCursor