Interface IHTMLRenderOption
- All Superinterfaces:
IRenderOption,ITaskOption
- All Known Implementing Classes:
HTMLEmitterConfig,HTMLRenderOption
Interface of constants of the HTML Render Opitons. This interface is
implemented only by: HTMLRenderOption so far. The implementation
classes should have the methods in order to support then HTML render options,
including getter and setter.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringthe URL of head.js filestatic final StringOutput a complete HTMLstatic final StringShould the output display the filter icon.static final StringShould the output display the group icon.static final StringShould the HTML emitter output the BIRT styles directly to the report.static final StringUsing compact mode or not.static final StringUsing inline style or not.static final StringShould the output contain metadata.static final StringHTMLIDNamespace is used to solve the name conflict problem when embedding multiple reports into one page.static final StringDeprecated.use METADATAstatic final Stringwhether or not the HTML is indented.static final StringShould the table be outed as fixed.static final StringOutput a HTML fragement without CSS defination.static final StringShould the HTML emitter output the master page's margins.static final StringShould we output HTML as RtL.static final StringOutput the HTML default title.static final StringDefine the type of the html content, it can be one of: HTML or HTML_NOCSS.static final Stringstatic final StringShould the top-level template table be wrapped.static final Stringstatic final StringThe list used to contain the active object ids.static final Stringstatic final Stringstatic final StringShould the report contains page header and footer The value is a Boolean object, default isBoolean.TRUEOnly effect if the HTML_Pagination is truestatic final StringA filter for metadata.static final StringFloating the page footer.static final Stringfor some case, the user needs to define the resource encoding.static final StringThe agent used to render the html output.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 -
Method Summary
Modifier and TypeMethodDescriptionreturns the base url for creating image URLbooleanbooleanbooleanbooleanbooleanGet Html pagination.booleanGet Html RTL flag.returns the image directory that engine stores images and charts intobooleanDeprecated.includeSelectionHandle is replaced by eanableMetadata flag.booleanGet master page content.booleanGet page footer float flag.booleanreturns whether to use compact mode for the HTML output, whose default value is false.voidsetBaseImageURL(String baseImageURL) sets the base image URL for image handlingvoidsetDisplayFilterIcon(boolean displayFilterIcon) Sets the flag indicationg that if filter icons should be displayed.voidsetDisplayGroupIcon(boolean displayFilterIcon) 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 pagevoidsetEnableCompactMode(boolean enableCompactMode) sets whether to use compact mode for the HTML output.voidsetEnableMetadata(boolean enableMetadata) Sets the flag which indicating if metadata should be output.voidsetHtmlPagination(boolean paginate) Set Html pagination.voidsetHtmlRtLFlag(boolean flag) Set Html RTL flag.voidsetHtmlTitle(String htmlTitle) voidsetImageDirectory(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) voidsetMasterPageContent(boolean show) Set master page content.voidsetPageFooterFloatFlag(boolean flag) Set page footer float flag.voidsetUrlEncoding(String encoding) voidsetUserAgent(String userAgent) 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, setSupportedImageFormatsMethods inherited from interface org.eclipse.birt.report.engine.api.ITaskOption
getOption, getOptions, hasOption, setOption
-
Field Details
-
HTML_TYPE
Define the type of the html content, it can be one of: HTML or HTML_NOCSS.- See Also:
-
HTML
Output a complete HTML- See Also:
-
HTML_NOCSS
Output a HTML fragement without CSS defination.- See Also:
-
USER_AGENT
The agent used to render the html output.- See Also:
-
URL_ENCODING
for some case, the user needs to define the resource encoding. It is used to encoding the hyperlinks which refers to the local resource. The value is a encode name, such as "utf-8".- See Also:
-
INSTANCE_ID_LIST
The list used to contain the active object ids. The value is a List object. The active objects including: Tempalate, Table, Chart, Label. the object in the list is a string, which is : bookmark, type, id.- See Also:
-
MASTER_PAGE_CONTENT
Should the report contains page header and footer The value is a Boolean object, default isBoolean.TRUEOnly effect if the HTML_Pagination is true- See Also:
-
HTML_INCLUDE_SELECTION_HANDLE
Deprecated.use METADATAShould we output the selection handle with the active object. The value is a Boolean Object, the default isBoolean.FALSE.- See Also:
-
HTML_RTL_FLAG
Should we output HTML as RtL. The value is an Boolean Object, the default isBoolean.FALSE.- See Also:
-
HTML_TITLE
Output the HTML default title. value???- See Also:
-
PAGEFOOTER_FLOAT_FLAG
Floating the page footer. The value is an Boolean Object, the default isBoolean.TRUE. Only effect when HTML_PAGINATION is set toBoolean.TRUE- See Also:
-
HTML_ENABLE_METADATA
Should the output contain metadata. This value is a Boolean Object. And if it's set to beBoolean.TRUE., the output will contains metadata include: Instance id, type and so on The default value isBoolean.FALSE- See Also:
-
HTML_DISPLAY_FILTER_ICON
Should the output display the filter icon. Only effect if the enable metadata is setting toBoolea.TRUE. The default value isBoolean.FALSE- See Also:
-
HTML_DISPLAY_GROUP_ICON
Should the output display the group icon. Only effect if the enable metadata is setting toBoolea.TRUE. The default value isBoolean.FALSE- See Also:
-
IMAGE_DIRECTROY
- See Also:
-
BASE_IMAGE_URL
- See Also:
-
LAYOUT_PREFERENCE_FIXED
- See Also:
-
LAYOUT_PREFERENCE_AUTO
- See Also:
-
HTML_VIEWPORT_META
- See Also:
-
HTML_WRAP_TEMPLATE_TABLE
Should the top-level template table be wrapped. Only effect if the enable metadata is setting toBoolea.TRUE. The default value isBoolean.FALSE- See Also:
-
HTML_LAYOUT_PREFERENCE
Should the table be outed as fixed. The default value isBoolean.FALSE- See Also:
-
HTML_ENABLE_AGENTSTYLE_ENGINE
Should the HTML emitter output the BIRT styles directly to the report. The default value isBoolean.FALSETrue: 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.- See Also:
-
HTML_OUTPUT_MASTER_PAGE_MARGINS
Should the HTML emitter output the master page's margins. This property is only works for the auto layout report. The fixed report will always output the master page's margins. The default value isBoolean.FALSETrue: 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.- See Also:
-
HTML_ID_NAMESPACE
HTMLIDNamespace is used to solve the name conflict problem when embedding multiple reports into one page.- See Also:
-
HTML_INDENT
whether or not the HTML is indented. The default value is true.- See Also:
-
METADATA_FILTER
A filter for metadata.- See Also:
-
HTML_ENABLE_INLINE_STYLE
Using inline style or not. This option only works when the report is embeddable. True: Try to using the inline style to instead of style class. False: Try to use the style class to compress the HTML source.- See Also:
-
HTML_ENABLE_COMPACT_MODE
Using compact mode or not. If compact mode is enabled, text indents and new line separators will be ignored in html output.- See Also:
-
BIRT_JS_URL_KEY
the URL of head.js file- See Also:
-
-
Method Details
-
getInstanceIDs
List getInstanceIDs()- Returns:
- Returns the instanceIDs.
-
setInstanceIDs
- Parameters:
instanceIDs- The instanceIDs to set.
-
setEmbeddable
void setEmbeddable(boolean embeddable) sets whether the HTML output can be embedded directly into an HTML page- Parameters:
embeddable- whether the HTML output can be embedded directly into an HTML page
-
getEmbeddable
boolean getEmbeddable()- Returns:
- whether the output is embeddable
-
setUserAgent
- Parameters:
userAgent- the user agent of the request
-
getUserAgent
String getUserAgent()- Returns:
- the user agent for the request
-
setUrlEncoding
-
getUrlEncoding
String getUrlEncoding()- Returns:
- the user agent for the request
-
setMasterPageContent
void setMasterPageContent(boolean show) Set master page content.- Parameters:
show-
-
getMasterPageContent
boolean getMasterPageContent()Get master page content.- Returns:
-
setHtmlPagination
void setHtmlPagination(boolean paginate) Set Html pagination.- Parameters:
paginate-
-
getHtmlPagination
boolean getHtmlPagination()Get Html pagination.- Returns:
-
setIncludeSelectionHandle
Deprecated.includeSelectionHandle is replaced by eanableMetadata flag. -
getIncludeSelectionHandle
Deprecated.includeSelectionHandle is replaced by eanableMetadata flag. -
setHtmlRtLFlag
void setHtmlRtLFlag(boolean flag) Set Html RTL flag.- Parameters:
flag-
-
getHtmlRtLFlag
boolean getHtmlRtLFlag()Get Html RTL flag.- Returns:
-
setHtmlTitle
- Parameters:
htmlTile-
-
getHtmlTitle
String getHtmlTitle()- Returns:
- the default html title
-
setEnableMetadata
void setEnableMetadata(boolean enableMetadata) Sets the flag which indicating if metadata should be output.- Parameters:
enableMetadata- the flag
-
getEnableMetadata
boolean getEnableMetadata()- Returns:
- the enable metadata flag value.
-
setDisplayFilterIcon
void setDisplayFilterIcon(boolean displayFilterIcon) Sets the flag indicationg that if filter icons should be displayed.- Parameters:
displayFilterIcon- the flag
-
getDisplayFilterIcon
boolean getDisplayFilterIcon()- Returns:
- the display filter icon flag value.
-
setDisplayGroupIcon
void setDisplayGroupIcon(boolean displayFilterIcon) Sets the flag indicationg that if group expand/collapse icons should be displayed.- Parameters:
displayFilterIcon- the flag
-
getDisplayGroupIcon
boolean getDisplayGroupIcon()- Returns:
- the group expand/collapse icon flag value.
-
getImageDirectory
String getImageDirectory()returns the image directory that engine stores images and charts into- Returns:
- the image directory.
-
setImageDirectory
sets the image directory that engine stores images and charts into- Parameters:
imageDirectory- the image directory that engine stores images and charts into
-
getBaseImageURL
String getBaseImageURL()returns the base url for creating image URL- Returns:
- Rreturn the abse image url
-
setBaseImageURL
sets the base image URL for image handling- Parameters:
baseImageURL- the base image URL
-
isEnableCompactMode
boolean isEnableCompactMode()returns whether to use compact mode for the HTML output, whose default value is false.- Returns:
-
setEnableCompactMode
void setEnableCompactMode(boolean enableCompactMode) 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.- Parameters:
enableCompactMode-
-