BBJasper

Class BBJasperExporter

java.lang.Object

BBJasper.BBJasperExporter

Direct Known Subclasses:

BBJasperCSVExporter, BBJasperDOCXExporter, BBJasperHTMLExporter, BBJasperODSExporter, BBJasperODTExporter, BBJasperPDFExporter, BBJasperPPTXExporter, BBJasperPrintServiceExporter, BBJasperRTFExporter, BBJasperTXTExporter, BBJasperXHTMLExporter, BBJasperXLSExporter, BBJasperXLSXExporter, BBJasperXMLExporter

public class BBJasperExporter
extends Object

Provides more granular control of BBJasper export operations

Since:

13.0

Field Summary

Fields

Modifier and Type	Field and Description
static BBjString	AUX_FILES_DIR$ Directory to store aux files such as images for exports
static BBjString	CLIENT_FILE_NAME_PROPERTY$ Property name for the client file for exports

Constructor Summary

Constructors

Constructor and Description
BBJasperExporter() Creates a empty BBJasperExporter object

Method Summary

Modifier and Type	Method and Description
HashMap@	getClientParameters() Returns client export parameters
Object	getParameter(JRExporterParameter p_exportParameter!) Returns a export parameter value
HashMap	getParameters() Returns export parameter values
void	setCharacterEncoding(BBjString p_characterEncoding$) Sets the character encoding for export operations
void	setEndPageIndex(BBjNumber p_endPageIndex) Sets the ending page index for export operations
void	setPageIndex(BBjNumber p_pageIndex) Sets the page index for export operations
void	setParameter(JRExporterParameter p_exportParameter!, Object p_value!) Set a report parameter value
void	setStartPageIndex(BBjNumber p_startPageIndex) Sets the starting page index for export operations

Methods inherited from class java.lang.Object

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

Field Detail

CLIENT_FILE_NAME_PROPERTY$

public static BBjString CLIENT_FILE_NAME_PROPERTY$

Property name for the client file for exports

AUX_FILES_DIR$

public static BBjString AUX_FILES_DIR$

Directory to store aux files such as images for exports

Constructor Detail

BBJasperExporter

public BBJasperExporter()

Creates a empty BBJasperExporter object

Method Detail

setCharacterEncoding

public void setCharacterEncoding(BBjString p_characterEncoding$)

Sets the character encoding for export operations

Parameters:

p_characterEncoding$ - Specifies the character encoding to use for the export operation

setPageIndex

public void setPageIndex(BBjNumber p_pageIndex)

Sets the page index for export operations

Parameters:

p_pageIndex - Specifies the page index for the export operation

setStartPageIndex

public void setStartPageIndex(BBjNumber p_startPageIndex)

Sets the starting page index for export operations

Parameters:

p_startPageIndex - Specifies the starting page index for the export operation

setEndPageIndex

public void setEndPageIndex(BBjNumber p_endPageIndex)

Sets the ending page index for export operations

Parameters:

p_endPageIndex - Specifies the ending page index for the export operation

getParameter

public Object getParameter(JRExporterParameter p_exportParameter!)

Returns a export parameter value

Parameters:

p_exportParameter! - Export parameter to return the value for

Object - which is export parameter value

getParameters

public HashMap getParameters()

Returns export parameter values

Returns:

HashMap which contains all export parameters!

getClientParameters

public HashMap@ getClientParameters()

Returns client export parameters

Returns:

Client HashMap which contains all export parameters!

setParameter

public void setParameter(JRExporterParameter p_exportParameter!,
Object p_value!)

Set a report parameter value

Parameters:

p_exportParameter! - Export parameter to set the value for

p_value! - Export parameter object value