com.businessobjects.rebean.wi
Interface PageInfo

All Superinterfaces:

Unit

public interface PageInfo
extends Unit

Warning: This interface is no longer functional from the SAP BusinessObjects 4.0 release onwards.

The PageInfo interface describes the page setting of a report.

Method Summary

int	getHorizontalRecords() Gets the maximum number of horizontal records displayed in the page.
Margins	getMargins() Returns the Margins instance allowing to the margin information.
Orientation	getOrientation() Returns the orientation of the report (portrait or landscape)
PaperSize	getPaperSize() Gets the paper size type of the current report
double	getPaperSizeHeight() Gets the height of the current page, in the current unity.
double	getPaperSizeWidth() Gets the width of the current page in the current unity
int	getVerticalRecords() Gets the maximum number of vertical records displayed in the page.
void	setHorizontalRecords(int nbRecords) Specifies the maximum number of horizontal records that will be displayed in the report.
void	setOrientation(Orientation ori) Changes the orientation of the page.
void	setPaperSize(PaperSize ps) Changes the paper size.
void	setPaperSizeHeight(double height) Changes the height of the page.
void	setPaperSizeWidth(double width) Changes the width of the page.
void	setVerticalRecords(int nbRecords) Specifies the maximum number of vertical records that will be displayed in the report.

Methods inherited from interface com.businessobjects.rebean.wi.Unit

getUnit, setUnit

Method Detail

getMargins

Margins getMargins()

Returns the Margins instance allowing to the margin information.

Returns:

a Margins instance allowing to get and set margin information.

getOrientation

Orientation getOrientation()

Returns the orientation of the report (portrait or landscape)

Returns:

the orientation of the report (portrait or landscape)

See Also:

Orientation

setOrientation

void setOrientation(Orientation ori)

Changes the orientation of the page.

Parameters:

ori - the new orientation

Throws:

java.lang.NullPointerException - if ori is null

See Also:

Orientation

getPaperSize

PaperSize getPaperSize()

Gets the paper size type of the current report

Returns:

the paper size type of the current report

See Also:

PaperSize

setPaperSize

void setPaperSize(PaperSize ps)

Changes the paper size.

Parameters:

ps - the new paper size

Throws:

java.lang.NullPointerException - if ps is null

See Also:

PaperSize

getPaperSizeWidth

double getPaperSizeWidth()

Gets the width of the current page in the current unity

Returns:

the width of the current page, in the current unity

See Also:

Unit

setPaperSizeWidth

void setPaperSizeWidth(double width)

Changes the width of the page. This will also set the paper size to PaperSize.CUSTOM. The width will be set in the current unity.

Throws:

java.lang.IllegalArgumentException - if width < 0

See Also:

Unit, PageInfo.getPaperSize()

getPaperSizeHeight

double getPaperSizeHeight()

Gets the height of the current page, in the current unity.

Returns:

the height of the current page, in the current unity.

See Also:

Unit

setPaperSizeHeight

void setPaperSizeHeight(double height)

Changes the height of the page. This will also set the paper size to PaperSize.CUSTOM. The height will be set in the current unity.

Throws:

java.lang.IllegalArgumentException - if height < 0

See Also:

Unit, PageInfo.getPaperSize()

getHorizontalRecords

int getHorizontalRecords()

Gets the maximum number of horizontal records displayed in the page.

Returns:

the maximum number of horizontal records

Since:

12.0

setHorizontalRecords

void setHorizontalRecords(int nbRecords)

Specifies the maximum number of horizontal records that will be displayed in the report.

Parameters:

nbRecords - number of records

Since:

12.0

getVerticalRecords

int getVerticalRecords()

Gets the maximum number of vertical records displayed in the page.

Returns:

the maximum number of vertical records

Since:

12.0

setVerticalRecords

void setVerticalRecords(int nbRecords)

Specifies the maximum number of vertical records that will be displayed in the report.

Parameters:

nbRecords - number of records

Since:

12.0