com.businessobjects.rebean.wi
Class PaginationMode

java.lang.Object
  com.businessobjects.rebean.wi.PaginationMode

All Implemented Interfaces:

EnumItem, java.io.Serializable

public final class PaginationMode
extends java.lang.Object
implements java.io.Serializable, EnumItem

The ReportEngine supports three types of pagination modes:

• Page - the report remains in the page format defined during document creation.
• Listing - the entire report is returned as a single page.
• QuickDisplay - the Report is displayed in optimized PaginationMode.

The PaginationMode associated to report can be set or retrieved using Report.getPaginationMode() and Report.setPaginationMode(PaginationMode).

Example: Setting a Report objects PaginationMode to Page.

        DocumentInstance doc = repEng.getDocumentFromStorageToken(storageToken);
  Report rep = doc.getReports().getItem(iRepID);
  rep.setPaginationMode(PaginationMode.Page);
 

Note: Using Listing mode for a very large document can introduce performance issues.

See Also:

Report, ReportMap, ReportMapNode, Serialized Form

Field Summary

static int	_Listing Listing mode base value.
static int	_Page Page mode base value.
static int	_QuickDisplay QuickDisplay base value.
static PaginationMode	Listing A static Listing PaginationMode object.
static PaginationMode	Page A static Page PaginationMode object.
static PaginationMode	QuickDisplay This object is used to set a Report into optimized PaginationMode.

Method Summary

static PaginationMode	from_int(int value) Returns a PaginationMode object for a set value.
java.lang.String	toString() Returns a String interpretation of the current PaginationMode.
int	value() Returns an integer representation of the current PaginationMode.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_Listing

public static final int _Listing

Listing mode base value.

See Also:

Constant Field Values

Listing

public static final PaginationMode Listing

A static Listing PaginationMode object. This object is used to set a Report into Listing PaginationMode.

Example: Setting PaginationMode to Listing.

rep.setPaginationMode(PaginationMode.Listing);

See Also:

Report

_Page

public static final int _Page

Page mode base value.

See Also:

Constant Field Values

Page

public static final PaginationMode Page

A static Page PaginationMode object. This object is used to set a Report into Page PaginationMode.

Example: Setting PaginationMode to Page.
rep.setPaginationMode(PaginationMode.Page );


See Also:

Report

_QuickDisplay

public static final int _QuickDisplay

QuickDisplay base value.

Since:

12.0

See Also:

Constant Field Values

QuickDisplay

public static final PaginationMode QuickDisplay

This object is used to set a Report into optimized PaginationMode.

Example: Setting PaginationMode to QuickDisplay.

 DocumentInstance wiDoc =  repEng.openDocument(Integer.parseInt(strDocId));
 Reports reps = wiDoc.getReports();
 Report rep = reps.getItem(0);
 rep.setPaginationMode(PaginationMode.QuickDisplay);
 HTMLView htmlView = (HTMLView) rep.getView(OutputFormatType.DHTML);
 PrintWriter writer = response.getWriter();
 htmlView.getContent(writer, "", "");
 writer.close();
 

Since:

12.0

See Also:

Report

Method Detail

value

public int value()

Returns an integer representation of the current PaginationMode. Possible values are:

• PaginationMode._Listing
• PaginationMode._Page
• PaginationMode._QuickDisplay

Specified by:

value in interface EnumItem

Returns:

The current pagination mode.

See Also:

PaginationMode

from_int

public static PaginationMode from_int(int value)

Returns a PaginationMode object for a set value.

Parameters:

value - This value can be either _Listing or _Page or _QuickDisplay.

Returns:

The PaginationMode for a stated value.

toString

public java.lang.String toString()

Returns a String interpretation of the current PaginationMode. Possible values are:

• Listing
• Page
• QuickDisplay

Overrides:

toString in class java.lang.Object

See Also:

PaginationMode, Report