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
optionsFields 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, VIEWER_PREVIEW_HTML_LAYOUT, VIEWER_PREVIEW_LAYOUT, VIEWER_PREVIEW_PAGE_LAYOUTFields 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 filebooleanbooleanbooleanIs the content output embeddablebooleanbooleanbooleanbooleanbooleanGet html pagination.booleanGet Html RTL flag.Get the html titlereturns the image directory that engine stores images and charts intobooleanDeprecated.includeSelectionHandle is replaced by eanableMetadata flag.Get the Instance IDsbooleanGet master page content.booleanbooleanGet page footer float flag.Get the URL encodingGet the user agent of the requestbooleanGet the viewer preview is page layoutbooleanbooleanreturns whether to use compact mode for the HTML output, whose default value is false.voidsetBaseImageURL(String baseImageURL) sets the base image URL for image handlingvoidsetBirtJsUrl(String birtJsUrl) set the URL of head.js filevoidsetDisplayFilterIcon(boolean displayFilterIcon) Sets the flag indicationg that if filter icons should be displayed.voidsetDisplayGroupIcon(boolean displayGroupIcon) Sets the flag indicationg that if group expand/collapse icons should be displayed.voidsetEmbeddable(boolean embeddable) sets whether the HTML output can be embedded directly into an HTML pagevoidsetEnableAgentStyleEngine(boolean enableAgentStyleEngine) Sets the flag indicationg that agentStyleEngine is enabled or not.voidsetEnableCompactMode(boolean enableCompactMode) sets whether to use compact mode for the HTML output.voidsetEnableInlineStyle(boolean inlineStyleFlag) Sets the flag indicating that Trying to use inline style instead of CSS class style.voidsetEnableMetadata(boolean enableMetadata) Sets the flag which indicating if metadata should be output.voidsets the HTML ID namespace.voidsetHTMLIndent(boolean indent) Sets the flag indicating that if the HTML should be indented.voidsetHtmlPagination(boolean paginate) Set html pagination.voidsetHtmlRtLFlag(boolean flag) Set Html RTL flag.voidsetHtmlTitle(String htmlTitle) Set the html titlevoidsetImageDirectory(String imageDirectory) sets the image directory that engine stores images and charts intovoidsetIncludeSelectionHandle(boolean option) Deprecated.includeSelectionHandle is replaced by eanableMetadata flag.voidsetInstanceIDs(List instanceIDs) Set instance IDsvoidsetLayoutPreference(String layoutPreference) Sets the flag indicationg that if the table should be outed as fixed.voidsetMasterPageContent(boolean show) Set master page content.voidsetMetadataFilter(IMetadataFilter filter) voidsetOutputMasterPageMargins(boolean outputMasterPageMargins) Sets the flag indicationg that output the master page's margins for the auto layout report or not.voidsetPageFooterFloatFlag(boolean flag) Set page footer float flag.voidsetUrlEncoding(String encoding) Set the URL encoding for the request.voidsetUserAgent(String userAgent) voidsetViewerPageLayout(boolean pageLayout) Set the viewer page layout is to be usedvoidsetViewportMeta(String viewport) set the viewport meta information.voidsetWrapTemplateTable(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, setSupportedImageFormatsMethods 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.IRenderOption
getActionHandle, getActionHandler, getAppBaseURL, getBaseURL, getEmitterID, getImageHandle, getImageHandler, getOutputFileName, getOutputFormat, getOutputSetting, getOutputStream, getSupportedImageFormats, setActionHandle, setActionHandler, setAppBaseURL, setBaseURL, setEmitterID, setImageHandle, setImageHandler, setOutputFileName, setOutputFormat, setOutputStream, setSupportedImageFormatsMethods 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
Description copied from interface:IHTMLRenderOptionGet the Instance IDs- Specified by:
getInstanceIDsin interfaceIHTMLRenderOption- Returns:
- Returns the instanceIDs.
-
setInstanceIDs
Description copied from interface:IHTMLRenderOptionSet instance IDs- Specified by:
setInstanceIDsin 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:
setEmbeddablein interfaceIHTMLRenderOption- Parameters:
embeddable- whether the HTML output can be embedded directly into an HTML page
-
getEmbeddable
public boolean getEmbeddable()Is the content output embeddable- Specified by:
getEmbeddablein interfaceIHTMLRenderOption- Returns:
- whether the output is embeddable
-
setViewerPageLayout
public void setViewerPageLayout(boolean pageLayout) Set the viewer page layout is to be used- Specified by:
setViewerPageLayoutin interfaceIHTMLRenderOption- Parameters:
pageLayout- page layout for the preview
-
getViewerPageLayout
public boolean getViewerPageLayout()Get the viewer preview is page layout- Specified by:
getViewerPageLayoutin interfaceIHTMLRenderOption- Returns:
- true, if the viewer preview is page layout
-
setUserAgent
- Specified by:
setUserAgentin interfaceIHTMLRenderOption- Parameters:
userAgent- the user agent of the request
-
getUserAgent
Description copied from interface:IHTMLRenderOptionGet the user agent of the request- Specified by:
getUserAgentin interfaceIHTMLRenderOption- Returns:
- the user agent for the request
-
setUrlEncoding
Set the URL encoding for the request.- Specified by:
setUrlEncodingin interfaceIHTMLRenderOption
-
getUrlEncoding
Description copied from interface:IHTMLRenderOptionGet the URL encoding- Specified by:
getUrlEncodingin interfaceIHTMLRenderOption- Returns:
- the user agent for the request
-
setMasterPageContent
public void setMasterPageContent(boolean show) Set master page content.- Specified by:
setMasterPageContentin interfaceIHTMLRenderOption
-
getMasterPageContent
public boolean getMasterPageContent()Get master page content.- Specified by:
getMasterPageContentin interfaceIHTMLRenderOption- Returns:
- the master page content
-
setHtmlPagination
public void setHtmlPagination(boolean paginate) Set html pagination.- Specified by:
setHtmlPaginationin interfaceIHTMLRenderOption
-
getHtmlPagination
public boolean getHtmlPagination()Get html pagination.- Specified by:
getHtmlPaginationin interfaceIHTMLRenderOption- Returns:
- the html pagination
-
setIncludeSelectionHandle
Deprecated.includeSelectionHandle is replaced by eanableMetadata flag.Description copied from interface:IHTMLRenderOptionSet if the selection handle must be included- Specified by:
setIncludeSelectionHandlein interfaceIHTMLRenderOption- Parameters:
option- include the selection handle
-
getIncludeSelectionHandle
Deprecated.includeSelectionHandle is replaced by eanableMetadata flag.Description copied from interface:IHTMLRenderOptionGet the information whether the selection handle is included- Specified by:
getIncludeSelectionHandlein interfaceIHTMLRenderOption- Returns:
- is the selection handle included
-
setHtmlRtLFlag
public void setHtmlRtLFlag(boolean flag) Set Html RTL flag.- Specified by:
setHtmlRtLFlagin interfaceIHTMLRenderOption
-
getHtmlRtLFlag
public boolean getHtmlRtLFlag()Get Html RTL flag.- Specified by:
getHtmlRtLFlagin interfaceIHTMLRenderOption- Returns:
- the html RTL flag
-
setHtmlTitle
Description copied from interface:IHTMLRenderOptionSet the html title- Specified by:
setHtmlTitlein interfaceIHTMLRenderOption- Parameters:
htmlTile-
-
getHtmlTitle
Description copied from interface:IHTMLRenderOptionGet the html title- Specified by:
getHtmlTitlein interfaceIHTMLRenderOption- Returns:
- the default html title
-
setEnableMetadata
public void setEnableMetadata(boolean enableMetadata) Sets the flag which indicating if metadata should be output.- Specified by:
setEnableMetadatain interfaceIHTMLRenderOption- Parameters:
enableMetadata- the flag
-
getEnableMetadata
public boolean getEnableMetadata()- Specified by:
getEnableMetadatain 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:
setDisplayFilterIconin interfaceIHTMLRenderOption- Parameters:
displayFilterIcon- the flag
-
getDisplayFilterIcon
public boolean getDisplayFilterIcon()- Specified by:
getDisplayFilterIconin 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:
setDisplayGroupIconin interfaceIHTMLRenderOption- Parameters:
displayGroupIcon- the flag
-
getDisplayGroupIcon
public boolean getDisplayGroupIcon()- Specified by:
getDisplayGroupIconin interfaceIHTMLRenderOption- Returns:
- the group expand/collapse icon flag value.
-
getImageDirectory
returns the image directory that engine stores images and charts into- Specified by:
getImageDirectoryin interfaceIHTMLRenderOption- Returns:
- the image directory.
-
setImageDirectory
sets the image directory that engine stores images and charts into- Specified by:
setImageDirectoryin interfaceIHTMLRenderOption- Parameters:
imageDirectory- the image directory that engine stores images and charts into
-
getBaseImageURL
returns the base url for creating image URL- Specified by:
getBaseImageURLin interfaceIHTMLRenderOption- Returns:
- Rreturn the abse image url
-
setBaseImageURL
sets the base image URL for image handling- Specified by:
setBaseImageURLin 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:IHTMLRenderOptionreturns whether to use compact mode for the HTML output, whose default value is false.- Specified by:
isEnableCompactModein interfaceIHTMLRenderOption- Returns:
- returns whether to use compact mode for the HTML output
-
setEnableCompactMode
public void setEnableCompactMode(boolean enableCompactMode) Description copied from interface:IHTMLRenderOptionsets 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:
setEnableCompactModein 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
-