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
optionsFields 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 TypeMethodDescriptionvoidcloseOutputStreamOnExit(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 streambooleanIf the output stream needs to be closed on exit.voidsetActionHandle(IHTMLActionHandler handler) Deprecated.voidsetActionHandler(IHTMLActionHandler handler) Set the action handlervoidsetAppBaseURL(String appBaseUrl) Set app base urlvoidsetBaseURL(String baseURL) sets the base url for action handlingvoidsetEmitterID(String emitterId) Set emitter id.voidsetImageHandle(IHTMLImageHandler handler) Deprecated.voidsetImageHandler(IHTMLImageHandler handler) Set the image handlervoidsetOutputFileName(String outputFileName) Set name of the output file.voidsetOutputFormat(String format) Set output format.voidsetOutputStream(OutputStream ostream) Set output stream.voidsetSupportedImageFormats(String formats) Methods inherited from class org.eclipse.birt.report.engine.api.TaskOption
getBooleanOption, getIntOption, getOption, getOptions, getStringOption, hasOption, setOptionMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods 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:
getOutputSettingin interfaceIRenderOption- Returns:
- the output settings
-
getOutputFormat
returns the output format, i.e., html, pdf, etc.- Specified by:
getOutputFormatin interfaceIRenderOption- Returns:
- Returns the output format
-
setOutputFormat
Description copied from interface:IRenderOptionSet output format.- Specified by:
setOutputFormatin interfaceIRenderOption
-
getEmitterID
Get emitter id.- Specified by:
getEmitterIDin interfaceIRenderOption- Returns:
- Returns the emitter id
-
setEmitterID
Set emitter id.- Specified by:
setEmitterIDin interfaceIRenderOption- Parameters:
emitterId- emitter id
-
setOutputStream
Description copied from interface:IRenderOptionSet output stream.- Specified by:
setOutputStreamin interfaceIRenderOption
-
getOutputStream
Get output stream- Specified by:
getOutputStreamin interfaceIRenderOption- Returns:
- output stream
-
setOutputFileName
Set name of the output file.- Specified by:
setOutputFileNamein interfaceIRenderOption- Parameters:
outputFileName- name of the output file
-
getOutputFileName
Get name of the output file.- Specified by:
getOutputFileNamein interfaceIRenderOption- Returns:
- output file name
-
setSupportedImageFormats
- Specified by:
setSupportedImageFormatsin interfaceIRenderOption- Parameters:
formats- - the image format supported by the browser
-
getSupportedImageFormats
- Specified by:
getSupportedImageFormatsin interfaceIRenderOption- Returns:
- the image format supported by the browser
-
getBaseURL
Returns the base URL for creating an Action URL- Specified by:
getBaseURLin interfaceIRenderOption- Returns:
- the baseURL.
-
setBaseURL
sets the base url for action handling- Specified by:
setBaseURLin interfaceIRenderOption- Parameters:
baseURL- sets the base URL used for action handling
-
getAppBaseURL
Returns the app base url for URL images- Specified by:
getAppBaseURLin interfaceIRenderOption- Returns:
- appBaseUrl
-
setAppBaseURL
Set app base url- Specified by:
setAppBaseURLin interfaceIRenderOption- Parameters:
appBaseUrl- the app base url
-
setActionHandle
Deprecated.Description copied from interface:IRenderOptionSet the action handler- Specified by:
setActionHandlein interfaceIRenderOption- Parameters:
handler-
-
setActionHandler
Description copied from interface:IRenderOptionSet the action handler- Specified by:
setActionHandlerin interfaceIRenderOption
-
getActionHandle
Deprecated.Get the action handler- Specified by:
getActionHandlein interfaceIRenderOption- Returns:
- Return the action handler
-
getActionHandler
Description copied from interface:IRenderOptionGet the action handler- Specified by:
getActionHandlerin interfaceIRenderOption- Returns:
- Return the action handler
-
setImageHandle
Deprecated.Description copied from interface:IRenderOptionSet the image handler- Specified by:
setImageHandlein interfaceIRenderOption- Parameters:
handler-
-
setImageHandler
Description copied from interface:IRenderOptionSet the image handler- Specified by:
setImageHandlerin interfaceIRenderOption
-
getImageHandle
Deprecated.Get the image handler- Specified by:
getImageHandlein interfaceIRenderOption- Returns:
- Return the image handler
-
getImageHandler
Description copied from interface:IRenderOptionGet the image handler- Specified by:
getImageHandlerin 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-
-