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
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
ConstructorsConstructorDescriptionconstructorRenderOption
(Map<String, Object> options) Constructor.RenderOption
(IRenderOption options) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
closeOutputStreamOnExit
(boolean closeOnExit) Get flag indicates if the output stream needs to be closed on exit.Deprecated.Get the action handlerReturns the app base url for URL imagesReturns the base URL for creating an Action URLGet emitter id.Deprecated.Get the image handlerGet name of the output file.returns the output format, i.e., html, pdf, etc.Deprecated.user should always use the get/set to change the setting.Get output streamboolean
If the output stream needs to be closed on exit.void
setActionHandle
(IHTMLActionHandler handler) Deprecated.void
setActionHandler
(IHTMLActionHandler handler) Set the action handlervoid
setAppBaseURL
(String appBaseUrl) Set app base urlvoid
setBaseURL
(String baseURL) sets the base url for action handlingvoid
setEmitterID
(String emitterId) Set emitter id.void
setImageHandle
(IHTMLImageHandler handler) Deprecated.void
setImageHandler
(IHTMLImageHandler handler) Set the image handlervoid
setOutputFileName
(String outputFileName) Set name of the output file.void
setOutputFormat
(String format) Set output format.void
setOutputStream
(OutputStream ostream) Set output stream.void
setSupportedImageFormats
(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 Details
-
RenderOption
public RenderOption()constructor -
RenderOption
Constructor.- Parameters:
options
-
-
RenderOption
Constructor.- Parameters:
options
-
-
-
Method Details
-
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
returns the output format, i.e., html, pdf, etc.- Specified by:
getOutputFormat
in interfaceIRenderOption
- Returns:
- Returns the output format
-
setOutputFormat
Description copied from interface:IRenderOption
Set output format.- Specified by:
setOutputFormat
in interfaceIRenderOption
-
getEmitterID
Get emitter id.- Specified by:
getEmitterID
in interfaceIRenderOption
- Returns:
- Returns the emitter id
-
setEmitterID
Set emitter id.- Specified by:
setEmitterID
in interfaceIRenderOption
- Parameters:
emitterId
- emitter id
-
setOutputStream
Description copied from interface:IRenderOption
Set output stream.- Specified by:
setOutputStream
in interfaceIRenderOption
-
getOutputStream
Get output stream- Specified by:
getOutputStream
in interfaceIRenderOption
- Returns:
- output stream
-
setOutputFileName
Set name of the output file.- Specified by:
setOutputFileName
in interfaceIRenderOption
- Parameters:
outputFileName
- name of the output file
-
getOutputFileName
Get name of the output file.- Specified by:
getOutputFileName
in interfaceIRenderOption
- Returns:
- output file name
-
setSupportedImageFormats
- Specified by:
setSupportedImageFormats
in interfaceIRenderOption
- Parameters:
formats
- - the image format supported by the browser
-
getSupportedImageFormats
- Specified by:
getSupportedImageFormats
in interfaceIRenderOption
- Returns:
- the image format supported by the browser
-
getBaseURL
Returns the base URL for creating an Action URL- Specified by:
getBaseURL
in interfaceIRenderOption
- Returns:
- the baseURL.
-
setBaseURL
sets the base url for action handling- Specified by:
setBaseURL
in interfaceIRenderOption
- Parameters:
baseURL
- sets the base URL used for action handling
-
getAppBaseURL
Returns the app base url for URL images- Specified by:
getAppBaseURL
in interfaceIRenderOption
- Returns:
- appBaseUrl
-
setAppBaseURL
Set app base url- Specified by:
setAppBaseURL
in interfaceIRenderOption
- Parameters:
appBaseUrl
- the app base url
-
setActionHandle
Deprecated.Description copied from interface:IRenderOption
Set the action handler- Specified by:
setActionHandle
in interfaceIRenderOption
- Parameters:
handler
-
-
setActionHandler
Description copied from interface:IRenderOption
Set the action handler- Specified by:
setActionHandler
in interfaceIRenderOption
-
getActionHandle
Deprecated.Get the action handler- Specified by:
getActionHandle
in interfaceIRenderOption
- Returns:
- Return the action handler
-
getActionHandler
Description copied from interface:IRenderOption
Get the action handler- Specified by:
getActionHandler
in interfaceIRenderOption
- Returns:
- Return the action handler
-
setImageHandle
Deprecated.Description copied from interface:IRenderOption
Set the image handler- Specified by:
setImageHandle
in interfaceIRenderOption
- Parameters:
handler
-
-
setImageHandler
Description copied from interface:IRenderOption
Set the image handler- Specified by:
setImageHandler
in interfaceIRenderOption
-
getImageHandle
Deprecated.Get the image handler- Specified by:
getImageHandle
in interfaceIRenderOption
- Returns:
- Return the image handler
-
getImageHandler
Description copied from interface:IRenderOption
Get the image handler- Specified by:
getImageHandler
in interfaceIRenderOption
- Returns:
- Return the image handler
-
needCloseOutputStreamOnExit
public boolean needCloseOutputStreamOnExit()If the output stream needs to be closed on exit.- Returns:
- true, output stream must 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
-
-