HTMLRenderOption (Birt Engine API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.birt.report.engine.api
Class HTMLRenderOption

java.lang.Object
  org.eclipse.birt.report.engine.api.RenderOptionBase
      org.eclipse.birt.report.engine.api.HTMLRenderOption

All Implemented Interfaces:: IHTMLRenderOption, IRenderOption

public class HTMLRenderOption
extends RenderOptionBase
implements IHTMLRenderOption

output settings for HTML output format

Field Summary

Fields inherited from class org.eclipse.birt.report.engine.api.RenderOptionBase

ACTION_HANDLER, FIT_TO_PAGE, IMAGE_HANDLER, LOCALE, options, OUTPUT_FILE_NAME, OUTPUT_FORMAT, OUTPUT_FORMAT_FO, OUTPUT_FORMAT_HTML, OUTPUT_FORMAT_PDF, OUTPUT_STREAM, PAGEBREAK_PAGINATION_ONLY

Fields inherited from interface org.eclipse.birt.report.engine.api.IHTMLRenderOption

HTML, HTML_DISPLAY_FILTER_ICON, HTML_DISPLAY_GROUP_ICON, HTML_ENABLE_AGENTSTYLE_ENGINE, HTML_ENABLE_METADATA, HTML_INCLUDE_SELECTION_HANDLE, HTML_LAYOUT_PREFERENCE, HTML_NOCSS, HTML_PAGINATION, HTML_RTL_FLAG, HTML_TITLE, HTML_TYPE, HTML_WRAP_TEMPLATE_TABLE, INSTANCE_ID_LIST, LAYOUT_PREFERENCE_AUTO, LAYOUT_PREFERENCE_FIXED, MASTER_PAGE_CONTENT, PAGEFOOTER_FLOAT_FLAG, URL_ENCODING, USER_AGENT

Constructor Summary
`HTMLRenderOption()` constructor

Method Summary
`IHTMLActionHandler`	`getActionHandle()`
`boolean`	`getDisplayFilterIcon()`
`boolean`	`getDisplayGroupIcon()`
`boolean`	`getEmbeddable()`
`boolean`	`getEnableAgentStyleEngine()`
`boolean`	`getEnableMetadata()`
`boolean`	`getHtmlPagination()`
`boolean`	`getHtmlRtLFlag()`
`java.lang.String`	`getHtmlTitle()`
`boolean`	`getIncludeSelectionHandle()` Deprecated. includeSelectionHandle is replaced by eanableMetadata flag.
`java.util.List`	`getInstanceIDs()`
`java.lang.String`	`getLayoutPreference()`
`boolean`	`getMasterPageContent()`
`boolean`	`getPageFooterFloatFlag()`
`java.lang.String`	`getUserAgent()`
`boolean`	`getWrapTemplateTable()`
`void`	`setActionHandle(IHTMLActionHandler handler)`
`void`	`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 page
`void`	`setEnableAgentStyleEngine(boolean enableAgentStyleEngine)` Sets the flag indicationg that agentStyleEngine is enabled or not.
`void`	`setEnableMetadata(boolean enableMetadata)` Sets the flag which indicating if metadata should be output.
`void`	`setHtmlPagination(boolean paginate)`
`void`	`setHtmlRtLFlag(boolean option)`
`void`	`setHtmlTitle(java.lang.String htmlTile)`
`void`	`setIncludeSelectionHandle(boolean option)` Deprecated. includeSelectionHandle is replaced by eanableMetadata flag.
`void`	`setInstanceIDs(java.util.List instanceIDs)`
`void`	`setLayoutPreference(java.lang.String layoutPreference)` Sets the flag indicationg that if the table should be outed as fixed.
`void`	`setMasterPageContent(boolean show)`
`void`	`setPageFooterFloatFlag(boolean option)`
`void`	`setUserAgent(java.lang.String userAgent)`
`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.RenderOptionBase

getOption, getOutputFormat, getOutputSetting, setOption, setOutputFileName, setOutputFormat, setOutputStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail