com.businessobjects.rebean.wi
Interface PageNavigation

public interface PageNavigation

The PageNavigation interface provides access to navigate to different pages of the report.

Method Summary

void	first() Moves to the first page of the report
int	getCurrent() Gets the current page of the report
boolean	isFirst() Returns true on the first page of the report.
boolean	isLast() Returns true on the last page of the report
void	last() Moves to the last page of the report.
void	navigateToReportElement(java.lang.String parentRef, java.lang.String reportElementBid) Moves to the first page which contains the report element with the specified reference parentRef.
boolean	next() Moves to the next page of the report
boolean	previous() Moves to the previous page of the report
void	setTo(int pageNbr) Moves to the specified page of the report Note : -1 is accepted as pageNumber and set the page to the last one.

Method Detail

isFirst

boolean isFirst()

Returns true on the first page of the report.

Returns:

true, if the page is first page in the report.

isLast

boolean isLast()

Returns true on the last page of the report

Returns:

true, if the page is first page in the document.

first

void first()
           throws REException

Moves to the first page of the report

Throws:

REException

next

boolean next()
             throws REException

Moves to the next page of the report

Throws:

REException

previous

boolean previous()
                 throws REException

Moves to the previous page of the report

Throws:

REException

last

void last()
          throws REException

Moves to the last page of the report. CAUTION : if you call this method, all pages are computed and can introduce performance penalties.

Throws:

REException

getCurrent

int getCurrent()

Gets the current page of the report

setTo

void setTo(int pageNbr)
           throws REException

Moves to the specified page of the report Note : -1 is accepted as pageNumber and set the page to the last one.

Throws:

REException

navigateToReportElement

void navigateToReportElement(java.lang.String parentRef,
                             java.lang.String reportElementBid)

Moves to the first page which contains the report element with the specified reference parentRef. If the user wants to follow a newly added ReportElement, he can add its id (reportElementBid).

Parameters:

parentRef - the parent report element

reportElementBid - eventually, the new report element identifier

Since:

12.0