|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.engine.api.RenderOption
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_DISPLAY_NONE, 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 |
protected java.util.HashMap options
Constructor Detail |
public RenderOption()
public RenderOption(java.util.HashMap options)
public RenderOption(IRenderOption options)
Method Detail |
public void setOption(java.lang.String name, java.lang.Object value)
setOption
in interface IRenderOption
name
- the option namevalue
- value for the optionpublic java.lang.Object getOption(java.lang.String name)
getOption
in interface IRenderOption
name
- the option name
public boolean hasOption(java.lang.String name)
hasOption
in interface IRenderOption
name
- option name.
public java.util.HashMap getOptions()
IRenderOption
getOptions
in interface IRenderOption
public java.util.HashMap getOutputSetting()
getOutputSetting
in interface IRenderOption
protected java.lang.String getStringOption(java.lang.String name)
protected boolean getBooleanOption(java.lang.String name, boolean defaultValue)
public java.lang.String getOutputFormat()
getOutputFormat
in interface IRenderOption
public void setOutputFormat(java.lang.String format)
setOutputFormat
in interface IRenderOption
public java.lang.String getEmitterID()
IRenderOption
getEmitterID
in interface IRenderOption
public void setEmitterID(java.lang.String emitterId)
IRenderOption
setEmitterID
in interface IRenderOption
emitterId
- public void setOutputStream(java.io.OutputStream ostream)
setOutputStream
in interface IRenderOption
public java.io.OutputStream getOutputStream()
getOutputStream
in interface IRenderOption
public void setOutputFileName(java.lang.String outputFileName)
setOutputFileName
in interface IRenderOption
public java.lang.String getOutputFileName()
getOutputFileName
in interface IRenderOption
public void setSupportedImageFormats(java.lang.String formats)
setSupportedImageFormats
in interface IRenderOption
formats
- -
the image format supported by the browserpublic java.lang.String getSupportedImageFormats()
getSupportedImageFormats
in interface IRenderOption
public java.lang.String getBaseURL()
getBaseURL
in interface IRenderOption
public void setBaseURL(java.lang.String baseURL)
setBaseURL
in interface IRenderOption
baseURL
- sets the base URL used for action handlingpublic void setActionHandle(IHTMLActionHandler handler)
setActionHandle
in interface IRenderOption
handler
- public void setActionHandler(IHTMLActionHandler handler)
setActionHandler
in interface IRenderOption
public IHTMLActionHandler getActionHandle()
getActionHandle
in interface IRenderOption
public IHTMLActionHandler getActionHandler()
getActionHandler
in interface IRenderOption
public void setImageHandle(IHTMLImageHandler handler)
setImageHandle
in interface IRenderOption
handler
- public void setImageHandler(IHTMLImageHandler handler)
setImageHandler
in interface IRenderOption
public IHTMLImageHandler getImageHandle()
getImageHandle
in interface IRenderOption
public IHTMLImageHandler getImageHandler()
getImageHandler
in interface IRenderOption
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |