Interface IRenderOption
- All Superinterfaces:
ITaskOption
- All Known Subinterfaces:
IExcelRenderOption,IHTMLRenderOption,IPDFRenderOption,IPostscriptRenderOption,IPPTRenderOption
- All Known Implementing Classes:
DocxRenderOption,EXCELRenderOption,HTMLEmitterConfig,HTMLRenderOption,PDFRenderOption,RenderOption,RenderOptionBase
Defines render options for emitters
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringProperty of action handlerstatic final StringAPP_BASE_URL is the same as BASE_URLstatic final StringProperty of base URLstatic final StringThe DPI which chart engine uses to generate chartsstatic final StringShould the output stream be closed when render task exits.The value is a Boolean object, default isBoolean.FALSEstatic final StringProperty of emitter idstatic final StringShould the report contains paginations The value is a Boolean object, default isBoolean.FALSE.static final StringProperty of image handlerstatic final StringProperty for localstatic final StringProperty to set output display to nonestatic final StringProperty of emitter id HTMLstatic final StringProperty of emitter id PDFstatic final StringProperty of output filestatic final StringProperty of formatstatic final StringProperty of output format FOstatic final StringProperty of output format HTMLstatic final StringProperty of output format PDFstatic final StringProperty of output streamstatic final StringThe DPI which layout engine uses to convert pixel to an abstract lengthstatic final StringProperty for report sizestatic final Stringbidi_hcg: Should we output report as RTL.static final StringSupported image formats -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Get the action handlerReturns the app base url for URL imagesReturns the base URL for creating an Action URLreturns the emitter idDeprecated.Get the image handlerGet name of the output file.Get output format.Deprecated.use getOptions insteadGet output stream.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) sets the emitter idvoidsetImageHandle(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 interface org.eclipse.birt.report.engine.api.ITaskOption
getOption, getOptions, hasOption, setOption
-
Field Details
-
OUTPUT_FORMAT
Property of format- See Also:
-
OUTPUT_FORMAT_HTML
Property of output format HTML- See Also:
-
OUTPUT_FORMAT_PDF
Property of output format PDF- See Also:
-
OUTPUT_FORMAT_FO
Property of output format FO- See Also:
-
OUTPUT_EMITTERID_HTML
Property of emitter id HTML- See Also:
-
OUTPUT_EMITTERID_PDF
Property of emitter id PDF- See Also:
-
EMITTER_ID
Property of emitter id- See Also:
-
OUTPUT_FILE_NAME
Property of output file- See Also:
-
OUTPUT_STREAM
Property of output stream- See Also:
-
IMAGE_HANDLER
Property of image handler- See Also:
-
ACTION_HANDLER
Property of action handler- See Also:
-
LOCALE
Property for local- See Also:
-
RENDER_DPI
The DPI which layout engine uses to convert pixel to an abstract length- See Also:
-
CHART_DPI
The DPI which chart engine uses to generate charts- See Also:
-
SUPPORTED_IMAGE_FORMATS
Supported image formats- See Also:
-
BASE_URL
Property of base URL- See Also:
-
RTL_FLAG
bidi_hcg: Should we output report as RTL. The value is a Boolean Object, the default isBoolean.FALSE.- See Also:
-
APP_BASE_URL
APP_BASE_URL is the same as BASE_URL- See Also:
-
OUTPUT_DISPLAY_NONE
Property to set output display to none- See Also:
-
HTML_PAGINATION
Should the report contains paginations The value is a Boolean object, default isBoolean.FALSE.- See Also:
-
CLOSE_OUTPUTSTREAM_ON_EXIT
Should the output stream be closed when render task exits.The value is a Boolean object, default isBoolean.FALSE- See Also:
-
REPORTLET_SIZE
Property for report size- See Also:
-
-
Method Details
-
getOutputSetting
Deprecated.use getOptions insteadGet the output settings- Returns:
- Return the output settings
-
setOutputFormat
Set output format.- Parameters:
format-
-
getOutputFormat
String getOutputFormat()Get output format.- Returns:
- Return the output format
-
setOutputFileName
Set name of the output file.- Parameters:
outputFileName- name of the output file
-
getOutputFileName
String getOutputFileName()Get name of the output file.- Returns:
- name
-
setOutputStream
Set output stream.- Parameters:
ostream-
-
getOutputStream
OutputStream getOutputStream()Get output stream.- Returns:
- output stream
-
setSupportedImageFormats
- Parameters:
formats- - the image format supported by the browser
-
getSupportedImageFormats
String getSupportedImageFormats()- Returns:
- the image format supported by the browser
-
getBaseURL
String getBaseURL()Returns the base URL for creating an Action URL- Returns:
- the baseURL.
-
setBaseURL
sets the base url for action handling- Parameters:
baseURL- sets the base URL used for action handling
-
getAppBaseURL
String getAppBaseURL()Returns the app base url for URL images- Returns:
- appBaseUrl
-
setAppBaseURL
Set app base url- Parameters:
appBaseURL- the app base url
-
setActionHandle
Deprecated.Set the action handler- Parameters:
handler-
-
setActionHandler
Set the action handler- Parameters:
handler-
-
getActionHandle
Deprecated.Get the action handler- Returns:
- Return the action handler
-
getActionHandler
IHTMLActionHandler getActionHandler()Get the action handler- Returns:
- Return the action handler
-
setImageHandle
Deprecated.Set the image handler- Parameters:
handler-
-
setImageHandler
Set the image handler- Parameters:
handler-
-
getImageHandle
Deprecated.Get the image handler- Returns:
- Return the image handler
-
getImageHandler
IHTMLImageHandler getImageHandler()Get the image handler- Returns:
- Return the image handler
-
getEmitterID
String getEmitterID()returns the emitter id- Returns:
- Returns the emitter id
-
setEmitterID
sets the emitter id- Parameters:
emitterID-
-