Class HTMLRenderOption
java.lang.Object
org.eclipse.birt.report.engine.api.TaskOption
org.eclipse.birt.report.engine.api.RenderOption
org.eclipse.birt.report.engine.api.HTMLRenderOption
- All Implemented Interfaces:
IHTMLRenderOption
,IRenderOption
,ITaskOption
- Direct Known Subclasses:
HTMLEmitterConfig
output settings for HTML output format
-
Field Summary
Fields inherited from class org.eclipse.birt.report.engine.api.TaskOption
options
Fields inherited from interface org.eclipse.birt.report.engine.api.IHTMLRenderOption
BASE_IMAGE_URL, BIRT_JS_URL_KEY, HTML, HTML_DISPLAY_FILTER_ICON, HTML_DISPLAY_GROUP_ICON, HTML_ENABLE_AGENTSTYLE_ENGINE, HTML_ENABLE_COMPACT_MODE, HTML_ENABLE_INLINE_STYLE, HTML_ENABLE_METADATA, HTML_ID_NAMESPACE, HTML_INCLUDE_SELECTION_HANDLE, HTML_INDENT, HTML_LAYOUT_PREFERENCE, HTML_NOCSS, HTML_OUTPUT_MASTER_PAGE_MARGINS, HTML_RTL_FLAG, HTML_TITLE, HTML_TYPE, HTML_VIEWPORT_META, HTML_WRAP_TEMPLATE_TABLE, IMAGE_DIRECTROY, INSTANCE_ID_LIST, LAYOUT_PREFERENCE_AUTO, LAYOUT_PREFERENCE_FIXED, MASTER_PAGE_CONTENT, METADATA_FILTER, PAGEFOOTER_FLOAT_FLAG, URL_ENCODING, USER_AGENT
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
ConstructorsConstructorDescriptionDefault constructor.HTMLRenderOption
(HashMap options) HTMLRenderOption
(IRenderOption options) Constructor -
Method Summary
Modifier and TypeMethodDescriptionreturns the base url for creating image URLget the URL of head.js fileboolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
Get html pagination.boolean
Get Html RTL flag.returns the image directory that engine stores images and charts intoboolean
Deprecated.includeSelectionHandle is replaced by eanableMetadata flag.boolean
Get master page content.boolean
boolean
Get page footer float flag.boolean
boolean
returns whether to use compact mode for the HTML output, whose default value is false.void
setBaseImageURL
(String baseImageURL) sets the base image URL for image handlingvoid
setBirtJsUrl
(String birtJsUrl) set the URL of head.js filevoid
setDisplayFilterIcon
(boolean displayFilterIcon) Sets the flag indicationg that if filter icons should be displayed.void
setDisplayGroupIcon
(boolean displayGroupIcon) Sets the flag indicationg that if group expand/collapse icons should be displayed.void
setEmbeddable
(boolean embeddable) sets whether the HTML output can be embedded directly into an HTML pagevoid
setEnableAgentStyleEngine
(boolean enableAgentStyleEngine) Sets the flag indicationg that agentStyleEngine is enabled or not.void
setEnableCompactMode
(boolean enableCompactMode) sets whether to use compact mode for the HTML output.void
setEnableInlineStyle
(boolean inlineStyleFlag) Sets the flag indicating that Trying to use inline style instead of CSS class style.void
setEnableMetadata
(boolean enableMetadata) Sets the flag which indicating if metadata should be output.void
sets the HTML ID namespace.void
setHTMLIndent
(boolean indent) Sets the flag indicating that if the HTML should be indented.void
setHtmlPagination
(boolean paginate) Set html pagination.void
setHtmlRtLFlag
(boolean flag) Set Html RTL flag.void
setHtmlTitle
(String htmlTitle) void
setImageDirectory
(String imageDirectory) sets the image directory that engine stores images and charts intovoid
setIncludeSelectionHandle
(boolean option) Deprecated.includeSelectionHandle is replaced by eanableMetadata flag.void
setInstanceIDs
(List instanceIDs) void
setLayoutPreference
(String layoutPreference) Sets the flag indicationg that if the table should be outed as fixed.void
setMasterPageContent
(boolean show) Set master page content.void
setMetadataFilter
(IMetadataFilter filter) void
setOutputMasterPageMargins
(boolean outputMasterPageMargins) Sets the flag indicationg that output the master page's margins for the auto layout report or not.void
setPageFooterFloatFlag
(boolean flag) Set page footer float flag.void
setUrlEncoding
(String encoding) Set the URL encoding for the request.void
setUserAgent
(String userAgent) void
setViewportMeta
(String viewport) set the viewport meta information.void
setWrapTemplateTable
(boolean wrapTemplateTable) Sets the flag indicationg that if the top-level table should be wrapped.Methods inherited from class org.eclipse.birt.report.engine.api.RenderOption
closeOutputStreamOnExit, getActionHandle, getActionHandler, getAppBaseURL, getBaseURL, getEmitterID, getImageHandle, getImageHandler, getOutputFileName, getOutputFormat, getOutputSetting, getOutputStream, getSupportedImageFormats, needCloseOutputStreamOnExit, setActionHandle, setActionHandler, setAppBaseURL, setBaseURL, setEmitterID, setImageHandle, setImageHandler, setOutputFileName, setOutputFormat, setOutputStream, setSupportedImageFormats
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.IRenderOption
getActionHandle, getActionHandler, getAppBaseURL, getBaseURL, getEmitterID, getImageHandle, getImageHandler, getOutputFileName, getOutputFormat, getOutputSetting, getOutputStream, getSupportedImageFormats, setActionHandle, setActionHandler, setAppBaseURL, setBaseURL, setEmitterID, setImageHandle, setImageHandler, setOutputFileName, setOutputFormat, setOutputStream, setSupportedImageFormats
Methods inherited from interface org.eclipse.birt.report.engine.api.ITaskOption
getOption, getOptions, hasOption, setOption
-
Constructor Details
-
HTMLRenderOption
Constructor -
HTMLRenderOption
-
HTMLRenderOption
public HTMLRenderOption()Default constructor.
-
-
Method Details
-
getInstanceIDs
- Specified by:
getInstanceIDs
in interfaceIHTMLRenderOption
- Returns:
- Returns the instanceIDs.
-
setInstanceIDs
- Specified by:
setInstanceIDs
in interfaceIHTMLRenderOption
- Parameters:
instanceIDs
- The instanceIDs to set.
-
setEmbeddable
public void setEmbeddable(boolean embeddable) sets whether the HTML output can be embedded directly into an HTML page- Specified by:
setEmbeddable
in interfaceIHTMLRenderOption
- Parameters:
embeddable
- whether the HTML output can be embedded directly into an HTML page
-
getEmbeddable
public boolean getEmbeddable()- Specified by:
getEmbeddable
in interfaceIHTMLRenderOption
- Returns:
- whether the output is embeddable
-
setUserAgent
- Specified by:
setUserAgent
in interfaceIHTMLRenderOption
- Parameters:
userAgent
- the user agent of the request
-
getUserAgent
- Specified by:
getUserAgent
in interfaceIHTMLRenderOption
- Returns:
- the user agent for the request
-
setUrlEncoding
Set the URL encoding for the request.- Specified by:
setUrlEncoding
in interfaceIHTMLRenderOption
-
getUrlEncoding
- Specified by:
getUrlEncoding
in interfaceIHTMLRenderOption
- Returns:
- the user agent for the request
-
setMasterPageContent
public void setMasterPageContent(boolean show) Set master page content.- Specified by:
setMasterPageContent
in interfaceIHTMLRenderOption
-
getMasterPageContent
public boolean getMasterPageContent()Get master page content.- Specified by:
getMasterPageContent
in interfaceIHTMLRenderOption
- Returns:
-
setHtmlPagination
public void setHtmlPagination(boolean paginate) Set html pagination.- Specified by:
setHtmlPagination
in interfaceIHTMLRenderOption
-
getHtmlPagination
public boolean getHtmlPagination()Get html pagination.- Specified by:
getHtmlPagination
in interfaceIHTMLRenderOption
- Returns:
-
setIncludeSelectionHandle
Deprecated.includeSelectionHandle is replaced by eanableMetadata flag.- Specified by:
setIncludeSelectionHandle
in interfaceIHTMLRenderOption
-
getIncludeSelectionHandle
Deprecated.includeSelectionHandle is replaced by eanableMetadata flag.- Specified by:
getIncludeSelectionHandle
in interfaceIHTMLRenderOption
-
setHtmlRtLFlag
public void setHtmlRtLFlag(boolean flag) Set Html RTL flag.- Specified by:
setHtmlRtLFlag
in interfaceIHTMLRenderOption
-
getHtmlRtLFlag
public boolean getHtmlRtLFlag()Get Html RTL flag.- Specified by:
getHtmlRtLFlag
in interfaceIHTMLRenderOption
- Returns:
-
setHtmlTitle
- Specified by:
setHtmlTitle
in interfaceIHTMLRenderOption
- Parameters:
htmlTile
-
-
getHtmlTitle
- Specified by:
getHtmlTitle
in interfaceIHTMLRenderOption
- Returns:
- the default html title
-
setEnableMetadata
public void setEnableMetadata(boolean enableMetadata) Sets the flag which indicating if metadata should be output.- Specified by:
setEnableMetadata
in interfaceIHTMLRenderOption
- Parameters:
enableMetadata
- the flag
-
getEnableMetadata
public boolean getEnableMetadata()- Specified by:
getEnableMetadata
in interfaceIHTMLRenderOption
- Returns:
- the enable metadata flag value.
-
setDisplayFilterIcon
public void setDisplayFilterIcon(boolean displayFilterIcon) Sets the flag indicationg that if filter icons should be displayed.- Specified by:
setDisplayFilterIcon
in interfaceIHTMLRenderOption
- Parameters:
displayFilterIcon
- the flag
-
getDisplayFilterIcon
public boolean getDisplayFilterIcon()- Specified by:
getDisplayFilterIcon
in interfaceIHTMLRenderOption
- Returns:
- the display filter icon flag value.
-
setDisplayGroupIcon
public void setDisplayGroupIcon(boolean displayGroupIcon) Sets the flag indicationg that if group expand/collapse icons should be displayed.- Specified by:
setDisplayGroupIcon
in interfaceIHTMLRenderOption
- Parameters:
displayGroupIcon
- the flag
-
getDisplayGroupIcon
public boolean getDisplayGroupIcon()- Specified by:
getDisplayGroupIcon
in interfaceIHTMLRenderOption
- Returns:
- the group expand/collapse icon flag value.
-
getImageDirectory
returns the image directory that engine stores images and charts into- Specified by:
getImageDirectory
in interfaceIHTMLRenderOption
- Returns:
- the image directory.
-
setImageDirectory
sets the image directory that engine stores images and charts into- Specified by:
setImageDirectory
in interfaceIHTMLRenderOption
- Parameters:
imageDirectory
- the image directory that engine stores images and charts into
-
getBaseImageURL
returns the base url for creating image URL- Specified by:
getBaseImageURL
in interfaceIHTMLRenderOption
- Returns:
- Rreturn the abse image url
-
setBaseImageURL
sets the base image URL for image handling- Specified by:
setBaseImageURL
in interfaceIHTMLRenderOption
- Parameters:
baseImageURL
- the base image URL
-
setWrapTemplateTable
public void setWrapTemplateTable(boolean wrapTemplateTable) Sets the flag indicationg that if the top-level table should be wrapped.- Parameters:
wrapTemplateTable
- the flag
-
getWrapTemplateTable
public boolean getWrapTemplateTable()- Returns:
- the group expand/collapse icon flag value.
-
setLayoutPreference
Sets the flag indicationg that if the table should be outed as fixed.- Parameters:
layoutPreference
- the flag
-
getLayoutPreference
- Returns:
- the table layout fixed flag value.
-
setEnableAgentStyleEngine
public void setEnableAgentStyleEngine(boolean enableAgentStyleEngine) Sets the flag indicationg that agentStyleEngine is enabled or not.- Parameters:
enableAgentStyleEngine
- True: means the HTML emitter will output the BIRT styles directly to the report and depends on the browser to implement the style calculation. False: means the HTML emitter will use BIRT style engine to calculate the styles and output the result to the report.
-
getEnableAgentStyleEngine
public boolean getEnableAgentStyleEngine()- Returns:
- the agentStyleEngine enabled flag value.
-
setOutputMasterPageMargins
public void setOutputMasterPageMargins(boolean outputMasterPageMargins) Sets the flag indicationg that output the master page's margins for the auto layout report or not.- Parameters:
outputMasterPageMargins
- True: means the HTML emitter will output the master page's margins for auto report. False: means the HTML emitter won't output the master page's margins for auto report.
-
getOutputMasterPageMargins
public boolean getOutputMasterPageMargins()- Returns:
- the outputMasterPageMargins flag value.
-
setHTMLIDNamespace
sets the HTML ID namespace.- Parameters:
id
- the viewer id
-
getHTMLIDNamespace
- Returns:
- the HTML ID namespace.
-
setHTMLIndent
public void setHTMLIndent(boolean indent) Sets the flag indicating that if the HTML should be indented.- Parameters:
indent
- the flag
-
getHTMLIndent
public boolean getHTMLIndent()- Returns:
- the HTML indent flag value. The default value is true.
-
setMetadataFilter
-
getMetadataFilter
-
setEnableInlineStyle
public void setEnableInlineStyle(boolean inlineStyleFlag) Sets the flag indicating that Trying to use inline style instead of CSS class style. This option only works when the report is embeddable.- Parameters:
inlineStyleFlag
- the flag
-
getEnableInlineStyle
public boolean getEnableInlineStyle()- Returns:
- the inline style flag value. The default value is false. True: Try to using the inline style to instead of style class. Fals: Try to use the style class to compress the HTML source.
-
setViewportMeta
set the viewport meta information.- Parameters:
viewport
-
-
getViewportMeta
- Returns:
- the viewport meta information.
-
isEnableCompactMode
public boolean isEnableCompactMode()Description copied from interface:IHTMLRenderOption
returns whether to use compact mode for the HTML output, whose default value is false.- Specified by:
isEnableCompactMode
in interfaceIHTMLRenderOption
- Returns:
-
setEnableCompactMode
public void setEnableCompactMode(boolean enableCompactMode) Description copied from interface:IHTMLRenderOption
sets whether to use compact mode for the HTML output. If the compact mode was used, text indents and new line separators will be ignored.- Specified by:
setEnableCompactMode
in interfaceIHTMLRenderOption
-
setBirtJsUrl
set the URL of head.js file- Parameters:
headJsUrl
-
-
getBirtJsUrl
get the URL of head.js file- Returns:
- the URL of head.js file
-