com.businessobjects.dsws.reportengine
Interface NavigateToPage

All Superinterfaces:

Navigate

public interface NavigateToPage
extends Navigate

The NavigateToPage interface is used to set the current page of a document to a specific page.

Example: Navigate to third page.

 RetrieveData retBOData = RetrieveData.Factory.newInstance();
 RetrieveView retBOView = RetrieveView.Factory.newInstance();
 retBOData.setRetrieveView(retBOView);
 NavigateToPage nPage =NavigateToPage.Factory.newInstance();
 //Navigate to the third page, page index starts with "1"
 nPage.setPage(3);
 DocumentInformation docInfo = boRepEng.getDocumentInformation(strDocid,null,null,nPage,retBOData);
 

For an example of how to use the Navigate interfaces see here.

See Also:

Navigate, NavigateToDataProvider, NavigateToFirstPage, NavigateToLastPage, NavigateToPage, NavigateToPath, NavigationNode, ReportEngine, BinaryView, XMLView, ViewSupport, ViewModeType, RetrieveData, RetrieveView, OutputFormatType, DocumentInformation

Nested Class Summary

static class

NavigateToPage.Factory A class with methods for creating instances of the NavigateToPage type.

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

int	getPage() Internal Use Only.
void	setPage(int page) Sets the current page number to navigate to.
org.apache.xmlbeans.XmlInt	xgetPage() Internal Use Only.
void	xsetPage(org.apache.xmlbeans.XmlInt page) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getPage

int getPage()

Internal Use Only.

xgetPage

org.apache.xmlbeans.XmlInt xgetPage()

Internal Use Only.

setPage

void setPage(int page)

Sets the current page number to navigate to.

Parameters:

page - the page number to navigate to.

xsetPage

void xsetPage(org.apache.xmlbeans.XmlInt page)

Internal Use Only.