org.eclipse.birt.report.engine.api
Class RenderOption

java.lang.Object
  org.eclipse.birt.report.engine.api.RenderOption

All Implemented Interfaces:

IRenderOption

Direct Known Subclasses:

HTMLRenderOption, PDFRenderOption, RenderOptionBase

public class RenderOption

extends java.lang.Object

implements IRenderOption

Settings for rendering a report to an output format. Currently supported options include format of the request, whether to render HTML with style sheet, etc. Potential future options includes image formats in PDF (vector or bitmap), font embedding options, etc.

The predefined options strings are what BIRT supports. Other options are available depending on custom extensions.

Field Summary

protected java.util.HashMap

options a hash map that stores the rendering options

Fields inherited from interface org.eclipse.birt.report.engine.api.IRenderOption

ACTION_HANDLER, BASE_URL, EMITTER_ID, IMAGE_HANDLER, LOCALE, OUTPUT_FILE_NAME, OUTPUT_FORMAT, OUTPUT_FORMAT_FO, OUTPUT_FORMAT_HTML, OUTPUT_FORMAT_PDF, OUTPUT_STREAM, SUPPORTED_IMAGE_FORMATS

Constructor Summary

RenderOption()
constructor

RenderOption(java.util.HashMap options)

RenderOption(IRenderOption options)

Method Summary

IHTMLActionHandler	getActionHandle() Deprecated.
IHTMLActionHandler	getActionHandler()
java.lang.String	getBaseURL() Returns the base URL for creating an Action URL
protected boolean	getBooleanOption(java.lang.String name, boolean defaultValue)
java.lang.String	getEmitterID() returns the emitter id
IHTMLImageHandler	getImageHandle() Deprecated.
IHTMLImageHandler	getImageHandler()
java.lang.Object	getOption(java.lang.String name) get option value for one rendering option
java.util.HashMap	getOptions() get all the options defined in this object
java.lang.String	getOutputFileName()
java.lang.String	getOutputFormat() returns the output format, i.e., html, pdf, etc.
java.util.HashMap	getOutputSetting() Deprecated. user should always use the get/set to change the setting.
java.io.OutputStream	getOutputStream()
protected java.lang.String	getStringOption(java.lang.String name)
java.lang.String	getSupportedImageFormats()
boolean	hasOption(java.lang.String name) Check if an option is defined.
void	setActionHandle(IHTMLActionHandler handler) Deprecated.
void	setActionHandler(IHTMLActionHandler handler)
void	setBaseURL(java.lang.String baseURL) sets the base url for action handling
void	setEmitterID(java.lang.String emitterId) sets the emitter id
void	setImageHandle(IHTMLImageHandler handler) Deprecated.
void	setImageHandler(IHTMLImageHandler handler)
void	setOption(java.lang.String name, java.lang.Object value) set value for one rendering option
void	setOutputFileName(java.lang.String outputFileName)
void	setOutputFormat(java.lang.String format)
void	setOutputStream(java.io.OutputStream ostream)
void	setSupportedImageFormats(java.lang.String formats)

Methods inherited from class java.lang.Object

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

Field Detail

options

protected java.util.HashMap options

a hash map that stores the rendering options

Constructor Detail

RenderOption

public RenderOption()

constructor

RenderOption

public RenderOption(java.util.HashMap options)

RenderOption

public RenderOption(IRenderOption options)

Method Detail

setOption

public void setOption(java.lang.String name,
                      java.lang.Object value)

set value for one rendering option

Specified by:

setOption in interface IRenderOption

Parameters:

name - the option name

value - value for the option

getOption

public java.lang.Object getOption(java.lang.String name)

get option value for one rendering option

Specified by:

getOption in interface IRenderOption

Parameters:

name - the option name

Returns:

the option value

hasOption

public boolean hasOption(java.lang.String name)

Check if an option is defined.

Specified by:

hasOption in interface IRenderOption

Parameters:

name - option name.

Returns:

true if user has defined an option with this name, even if the value is NULL. false otherwise.

getOptions

public java.util.HashMap getOptions()

Description copied from interface: IRenderOption

get all the options defined in this object

Specified by:

getOptions in interface IRenderOption

Returns:

getOutputSetting

public java.util.HashMap getOutputSetting()

Deprecated. user should always use the get/set to change the setting.

returns the output settings

Specified by:

getOutputSetting in interface IRenderOption

Returns:

the output settings

getStringOption

protected java.lang.String getStringOption(java.lang.String name)

getBooleanOption

protected boolean getBooleanOption(java.lang.String name,
                                   boolean defaultValue)

getOutputFormat

public java.lang.String getOutputFormat()

returns the output format, i.e., html, pdf, etc.

Specified by:

getOutputFormat in interface IRenderOption

Returns:

Returns the output format

setOutputFormat

public void setOutputFormat(java.lang.String format)

Specified by:

setOutputFormat in interface IRenderOption

getEmitterID

public java.lang.String getEmitterID()

Description copied from interface: IRenderOption

returns the emitter id

Specified by:

getEmitterID in interface IRenderOption

Returns:

Returns the emitter id

setEmitterID

public void setEmitterID(java.lang.String emitterId)

Description copied from interface: IRenderOption

sets the emitter id

Specified by:

setEmitterID in interface IRenderOption

Parameters:

emitterId -

setOutputStream

public void setOutputStream(java.io.OutputStream ostream)

Specified by:

setOutputStream in interface IRenderOption

getOutputStream

public java.io.OutputStream getOutputStream()

Specified by:

getOutputStream in interface IRenderOption

setOutputFileName

public void setOutputFileName(java.lang.String outputFileName)

Specified by:

setOutputFileName in interface IRenderOption

getOutputFileName

public java.lang.String getOutputFileName()

Specified by:

getOutputFileName in interface IRenderOption

setSupportedImageFormats

public void setSupportedImageFormats(java.lang.String formats)

Specified by:

setSupportedImageFormats in interface IRenderOption

Parameters:

formats - - the image format supported by the browser

getSupportedImageFormats

public java.lang.String getSupportedImageFormats()

Specified by:

getSupportedImageFormats in interface IRenderOption

Returns:

the image format supported by the browser

getBaseURL

public java.lang.String getBaseURL()

Returns the base URL for creating an Action URL

Specified by:

getBaseURL in interface IRenderOption

Returns:

the baseURL.

setBaseURL

public void setBaseURL(java.lang.String baseURL)

sets the base url for action handling

Specified by:

setBaseURL in interface IRenderOption

Parameters:

baseURL - sets the base URL used for action handling

setActionHandle

public void setActionHandle(IHTMLActionHandler handler)

Deprecated.

Specified by:

setActionHandle in interface IRenderOption

Parameters:

handler -

setActionHandler

public void setActionHandler(IHTMLActionHandler handler)

Specified by:

setActionHandler in interface IRenderOption

getActionHandle

public IHTMLActionHandler getActionHandle()

Deprecated.

Specified by:

getActionHandle in interface IRenderOption

Returns:

getActionHandler

public IHTMLActionHandler getActionHandler()

Specified by:

getActionHandler in interface IRenderOption

setImageHandle

public void setImageHandle(IHTMLImageHandler handler)

Deprecated.

Specified by:

setImageHandle in interface IRenderOption

Parameters:

handler -

setImageHandler

public void setImageHandler(IHTMLImageHandler handler)

Specified by:

setImageHandler in interface IRenderOption

getImageHandle

public IHTMLImageHandler getImageHandle()

Deprecated.

Specified by:

getImageHandle in interface IRenderOption

Returns:

getImageHandler

public IHTMLImageHandler getImageHandler()

Specified by:

getImageHandler in interface IRenderOption