Class RenderOption
- java.lang.Object
-
- org.eclipse.birt.report.engine.api.TaskOption
-
- org.eclipse.birt.report.engine.api.RenderOption
-
- All Implemented Interfaces:
IRenderOption
,ITaskOption
- Direct Known Subclasses:
DocxRenderOption
,EXCELRenderOption
,HTMLRenderOption
,PDFRenderOption
,RenderOptionBase
public class RenderOption extends TaskOption 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
-
Fields inherited from class org.eclipse.birt.report.engine.api.TaskOption
options
-
Fields inherited from interface org.eclipse.birt.report.engine.api.IRenderOption
ACTION_HANDLER, APP_BASE_URL, BASE_URL, CHART_DPI, CLOSE_OUTPUTSTREAM_ON_EXIT, EMITTER_ID, HTML_PAGINATION, IMAGE_HANDLER, LOCALE, OUTPUT_DISPLAY_NONE, OUTPUT_EMITTERID_HTML, OUTPUT_EMITTERID_PDF, OUTPUT_FILE_NAME, OUTPUT_FORMAT, OUTPUT_FORMAT_FO, OUTPUT_FORMAT_HTML, OUTPUT_FORMAT_PDF, OUTPUT_STREAM, RENDER_DPI, REPORTLET_SIZE, RTL_FLAG, SUPPORTED_IMAGE_FORMATS
-
-
Constructor Summary
Constructors Constructor Description RenderOption()
constructorRenderOption(java.util.Map options)
Constructor.RenderOption(IRenderOption options)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
closeOutputStreamOnExit(boolean closeOnExit)
Get flag indicates if the output stream needs to be closed on exit.IHTMLActionHandler
getActionHandle()
Deprecated.IHTMLActionHandler
getActionHandler()
java.lang.String
getAppBaseURL()
Returns the app base url for URL imagesjava.lang.String
getBaseURL()
Returns the base URL for creating an Action URLjava.lang.String
getEmitterID()
Get emitter id.IHTMLImageHandler
getImageHandle()
Deprecated.IHTMLImageHandler
getImageHandler()
java.lang.String
getOutputFileName()
Get name of the output file.java.lang.String
getOutputFormat()
returns the output format, i.e., html, pdf, etc.java.util.Map
getOutputSetting()
Deprecated.user should always use the get/set to change the setting.java.io.OutputStream
getOutputStream()
Get output streamjava.lang.String
getSupportedImageFormats()
boolean
needCloseOutputStreamOnExit()
If the output stream needs to be closed on exit.void
setActionHandle(IHTMLActionHandler handler)
Deprecated.void
setActionHandler(IHTMLActionHandler handler)
void
setAppBaseURL(java.lang.String appBaseUrl)
Set app base urlvoid
setBaseURL(java.lang.String baseURL)
sets the base url for action handlingvoid
setEmitterID(java.lang.String emitterId)
Set emitter id.void
setImageHandle(IHTMLImageHandler handler)
Deprecated.void
setImageHandler(IHTMLImageHandler handler)
void
setOutputFileName(java.lang.String outputFileName)
Set name of the output file.void
setOutputFormat(java.lang.String format)
Set output format.void
setOutputStream(java.io.OutputStream ostream)
Set output stream.void
setSupportedImageFormats(java.lang.String formats)
-
Methods inherited from class org.eclipse.birt.report.engine.api.TaskOption
getBooleanOption, getIntOption, getOption, getOptions, getStringOption, hasOption, setOption
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.eclipse.birt.report.engine.api.ITaskOption
getOption, getOptions, hasOption, setOption
-
-
-
-
Constructor Detail
-
RenderOption
public RenderOption()
constructor
-
RenderOption
public RenderOption(java.util.Map options)
Constructor.- Parameters:
options
-
-
RenderOption
public RenderOption(IRenderOption options)
Constructor.- Parameters:
options
-
-
-
Method Detail
-
getOutputSetting
@Deprecated public java.util.Map getOutputSetting()
Deprecated.user should always use the get/set to change the setting.returns the output settings- Specified by:
getOutputSetting
in interfaceIRenderOption
- Returns:
- the output settings
-
getOutputFormat
public java.lang.String getOutputFormat()
returns the output format, i.e., html, pdf, etc.- Specified by:
getOutputFormat
in interfaceIRenderOption
- Returns:
- Returns the output format
-
setOutputFormat
public void setOutputFormat(java.lang.String format)
Description copied from interface:IRenderOption
Set output format.- Specified by:
setOutputFormat
in interfaceIRenderOption
-
getEmitterID
public java.lang.String getEmitterID()
Get emitter id.- Specified by:
getEmitterID
in interfaceIRenderOption
- Returns:
- Returns the emitter id
-
setEmitterID
public void setEmitterID(java.lang.String emitterId)
Set emitter id.- Specified by:
setEmitterID
in interfaceIRenderOption
- Parameters:
emitterId
- emitter id
-
setOutputStream
public void setOutputStream(java.io.OutputStream ostream)
Description copied from interface:IRenderOption
Set output stream.- Specified by:
setOutputStream
in interfaceIRenderOption
-
getOutputStream
public java.io.OutputStream getOutputStream()
Get output stream- Specified by:
getOutputStream
in interfaceIRenderOption
- Returns:
- output stream
-
setOutputFileName
public void setOutputFileName(java.lang.String outputFileName)
Set name of the output file.- Specified by:
setOutputFileName
in interfaceIRenderOption
- Parameters:
outputFileName
- name of the output file
-
getOutputFileName
public java.lang.String getOutputFileName()
Get name of the output file.- Specified by:
getOutputFileName
in interfaceIRenderOption
- Returns:
- output file name
-
setSupportedImageFormats
public void setSupportedImageFormats(java.lang.String formats)
- Specified by:
setSupportedImageFormats
in interfaceIRenderOption
- Parameters:
formats
- - the image format supported by the browser
-
getSupportedImageFormats
public java.lang.String getSupportedImageFormats()
- Specified by:
getSupportedImageFormats
in interfaceIRenderOption
- 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 interfaceIRenderOption
- Returns:
- the baseURL.
-
setBaseURL
public void setBaseURL(java.lang.String baseURL)
sets the base url for action handling- Specified by:
setBaseURL
in interfaceIRenderOption
- Parameters:
baseURL
- sets the base URL used for action handling
-
getAppBaseURL
public java.lang.String getAppBaseURL()
Returns the app base url for URL images- Specified by:
getAppBaseURL
in interfaceIRenderOption
- Returns:
- appBaseUrl
-
setAppBaseURL
public void setAppBaseURL(java.lang.String appBaseUrl)
Set app base url- Specified by:
setAppBaseURL
in interfaceIRenderOption
- Parameters:
appBaseURL
- the app base url
-
setActionHandle
@Deprecated public void setActionHandle(IHTMLActionHandler handler)
Deprecated.- Specified by:
setActionHandle
in interfaceIRenderOption
- Parameters:
handler
-
-
setActionHandler
public void setActionHandler(IHTMLActionHandler handler)
- Specified by:
setActionHandler
in interfaceIRenderOption
-
getActionHandle
@Deprecated public IHTMLActionHandler getActionHandle()
Deprecated.- Specified by:
getActionHandle
in interfaceIRenderOption
- Returns:
-
getActionHandler
public IHTMLActionHandler getActionHandler()
- Specified by:
getActionHandler
in interfaceIRenderOption
-
setImageHandle
@Deprecated public void setImageHandle(IHTMLImageHandler handler)
Deprecated.- Specified by:
setImageHandle
in interfaceIRenderOption
- Parameters:
handler
-
-
setImageHandler
public void setImageHandler(IHTMLImageHandler handler)
- Specified by:
setImageHandler
in interfaceIRenderOption
-
getImageHandle
@Deprecated public IHTMLImageHandler getImageHandle()
Deprecated.- Specified by:
getImageHandle
in interfaceIRenderOption
- Returns:
-
getImageHandler
public IHTMLImageHandler getImageHandler()
- Specified by:
getImageHandler
in interfaceIRenderOption
-
needCloseOutputStreamOnExit
public boolean needCloseOutputStreamOnExit()
If the output stream needs to be closed on exit.
-
closeOutputStreamOnExit
public void closeOutputStreamOnExit(boolean closeOnExit)
Get flag indicates if the output stream needs to be closed on exit.- Parameters:
closeOnExit
-
-
-