Package org.pentaho.reporting.engine.classic.core.modules.output.table.xls.helper

Class ExcelPageDefinition

java.lang.Object

org.pentaho.reporting.engine.classic.core.modules.output.table.xls.helper.ExcelPageDefinition

public final class ExcelPageDefinition
extends Object

A read only page format mapping definiton to map a page format to an predefined excel constant.

Author:

Thomas Morgner

Constructor Summary

Constructors

Constructor	Description
ExcelPageDefinition(short pageFormatCode, int width, int height)	Defines a new excel page format mapping.
ExcelPageDefinition(short pageFormatCode, PageSize pageSize)

Method Summary

Modifier and Type	Method	Description
int	getHeight()	Returns the defined page height for that page definition.
short	getPageFormatCode()	Return the excel page format code that describes that page size.
int	getWidth()	Returns the defined page width for that page definition.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExcelPageDefinition

public ExcelPageDefinition(short pageFormatCode,
                           int width,
                           int height)

Defines a new excel page format mapping.

Parameters:

pageFormatCode - the excel internal page format code.

width - the width of the page.

height - the height of the page.

ExcelPageDefinition

public ExcelPageDefinition(short pageFormatCode,
                           PageSize pageSize)

Method Detail

getPageFormatCode

public short getPageFormatCode()

Return the excel page format code that describes that page size.

Returns:

the page format code as defined in the Excel File format.

getWidth

public int getWidth()

Returns the defined page width for that page definition.

Returns:

the page width;

getHeight

public int getHeight()

Returns the defined page height for that page definition.

Returns:

the page height;