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

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

All Implemented Interfaces:

IHTMLRenderOption, IRenderOption

Direct Known Subclasses:

HTMLEmitterConfig

public class HTMLRenderOption

extends RenderOption

implements IHTMLRenderOption

output settings for HTML output format

Field Summary

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

options

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

BASE_IMAGE_URL, 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, IMAGE_DIRECTROY, INSTANCE_ID_LIST, LAYOUT_PREFERENCE_AUTO, LAYOUT_PREFERENCE_FIXED, MASTER_PAGE_CONTENT, PAGEFOOTER_FLOAT_FLAG, URL_ENCODING, USER_AGENT

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

ACTION_HANDLER, BASE_URL, EMITTER_ID, IMAGE_HANDLER, LOCALE, OUTPUT_FILE_NAME, OUTPUT_FORMAT, OUTPUT_FORMAT_FO, OUTPUT_FORMAT_HTML, OUTPUT_FORMAT_PDF, OUTPUT_STREAM, SUPPORTED_IMAGE_FORMATS

Constructor Summary

HTMLRenderOption()

HTMLRenderOption(IRenderOption options)
constructor

Method Summary

java.lang.String	getBaseImageURL() returns the base url for creating image URL
boolean	getDisplayFilterIcon()
boolean	getDisplayGroupIcon()
boolean	getEmbeddable()
boolean	getEnableAgentStyleEngine()
boolean	getEnableMetadata()
boolean	getHtmlPagination()
boolean	getHtmlRtLFlag()
java.lang.String	getHtmlTitle()
java.lang.String	getImageDirectory() returns the image directory that engine stores images and charts into
boolean	getIncludeSelectionHandle() Deprecated. includeSelectionHandle is replaced by eanableMetadata flag.
java.util.List	getInstanceIDs()
java.lang.String	getLayoutPreference()
boolean	getMasterPageContent()
boolean	getPageFooterFloatFlag()
java.lang.String	getUrlEncoding()
java.lang.String	getUserAgent()
boolean	getWrapTemplateTable()
void	setBaseImageURL(java.lang.String baseImageURL) sets the base image URL for image handling
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 flag)
void	setHtmlTitle(java.lang.String htmlTitle)
void	setImageDirectory(java.lang.String imageDirectory) sets the image directory that engine stores images and charts into
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 flag)
void	setUrlEncoding(java.lang.String encoding)
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.RenderOption

getActionHandle, getActionHandler, getBaseURL, getBooleanOption, getEmitterID, getImageHandle, getImageHandler, getOption, getOptions, getOutputFileName, getOutputFormat, getOutputSetting, getOutputStream, getStringOption, getSupportedImageFormats, hasOption, setActionHandle, setActionHandler, setBaseURL, setEmitterID, setImageHandle, setImageHandler, setOption, setOutputFileName, setOutputFormat, setOutputStream, setSupportedImageFormats

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, getBaseURL, getEmitterID, getImageHandle, getImageHandler, getOption, getOptions, getOutputFileName, getOutputFormat, getOutputSetting, getOutputStream, getSupportedImageFormats, hasOption, setActionHandle, setActionHandler, setBaseURL, setEmitterID, setImageHandle, setImageHandler, setOption, setOutputFileName, setOutputFormat, setOutputStream, setSupportedImageFormats

Constructor Detail

HTMLRenderOption

public HTMLRenderOption(IRenderOption options)

constructor

HTMLRenderOption

public HTMLRenderOption()

Method Detail

getInstanceIDs

public java.util.List getInstanceIDs()

Specified by:

getInstanceIDs in interface IHTMLRenderOption

Returns:

Returns the instanceIDs.

setInstanceIDs

public void setInstanceIDs(java.util.List instanceIDs)

Specified by:

setInstanceIDs in interface IHTMLRenderOption

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 interface IHTMLRenderOption

Parameters:

embeddable - whether the HTML output can be embedded directly into an HTML page

getEmbeddable

public boolean getEmbeddable()

Specified by:

getEmbeddable in interface IHTMLRenderOption

Returns:

whether the output is embeddable

setUserAgent

public void setUserAgent(java.lang.String userAgent)

Specified by:

setUserAgent in interface IHTMLRenderOption

Parameters:

userAgent - the user agent of the request

getUserAgent

public java.lang.String getUserAgent()

Specified by:

getUserAgent in interface IHTMLRenderOption

Returns:

the user agent for the request

setUrlEncoding

public void setUrlEncoding(java.lang.String encoding)

Specified by:

setUrlEncoding in interface IHTMLRenderOption

getUrlEncoding

public java.lang.String getUrlEncoding()

Specified by:

getUrlEncoding in interface IHTMLRenderOption

Returns:

the user agent for the request

setMasterPageContent

public void setMasterPageContent(boolean show)

Specified by:

setMasterPageContent in interface IHTMLRenderOption

getMasterPageContent

public boolean getMasterPageContent()

Specified by:

getMasterPageContent in interface IHTMLRenderOption

setHtmlPagination

public void setHtmlPagination(boolean paginate)

Specified by:

setHtmlPagination in interface IHTMLRenderOption

getHtmlPagination

public boolean getHtmlPagination()

Specified by:

getHtmlPagination in interface IHTMLRenderOption

setIncludeSelectionHandle

public void setIncludeSelectionHandle(boolean option)

Deprecated. includeSelectionHandle is replaced by eanableMetadata flag.

Specified by:

setIncludeSelectionHandle in interface IHTMLRenderOption

getIncludeSelectionHandle

public boolean getIncludeSelectionHandle()

Deprecated. includeSelectionHandle is replaced by eanableMetadata flag.

Specified by:

getIncludeSelectionHandle in interface IHTMLRenderOption

setHtmlRtLFlag

public void setHtmlRtLFlag(boolean flag)

Specified by:

setHtmlRtLFlag in interface IHTMLRenderOption

getHtmlRtLFlag

public boolean getHtmlRtLFlag()

Specified by:

getHtmlRtLFlag in interface IHTMLRenderOption

setHtmlTitle

public void setHtmlTitle(java.lang.String htmlTitle)

Specified by:

setHtmlTitle in interface IHTMLRenderOption

getHtmlTitle

public java.lang.String getHtmlTitle()

Specified by:

getHtmlTitle in interface IHTMLRenderOption

Returns:

the default html title

setPageFooterFloatFlag

public void setPageFooterFloatFlag(boolean flag)

Specified by:

setPageFooterFloatFlag in interface IHTMLRenderOption

getPageFooterFloatFlag

public boolean getPageFooterFloatFlag()

Specified by:

getPageFooterFloatFlag in interface IHTMLRenderOption

setEnableMetadata

public void setEnableMetadata(boolean enableMetadata)

Sets the flag which indicating if metadata should be output.

Specified by:

setEnableMetadata in interface IHTMLRenderOption

Parameters:

enableMetadata - the flag

getEnableMetadata

public boolean getEnableMetadata()

Specified by:

getEnableMetadata in interface IHTMLRenderOption

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 interface IHTMLRenderOption

Parameters:

displayFilterIcon - the flag

getDisplayFilterIcon

public boolean getDisplayFilterIcon()

Specified by:

getDisplayFilterIcon in interface IHTMLRenderOption

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 interface IHTMLRenderOption

Parameters:

displayGroupIcon - the flag

getDisplayGroupIcon

public boolean getDisplayGroupIcon()

Specified by:

getDisplayGroupIcon in interface IHTMLRenderOption

Returns:

the group expand/collapse icon flag value.

getImageDirectory

public java.lang.String getImageDirectory()

returns the image directory that engine stores images and charts into

Specified by:

getImageDirectory in interface IHTMLRenderOption

Returns:

the image directory.

setImageDirectory

public void setImageDirectory(java.lang.String imageDirectory)

sets the image directory that engine stores images and charts into

Specified by:

setImageDirectory in interface IHTMLRenderOption

Parameters:

imageDirectory - the image directory that engine stores images and charts into

getBaseImageURL

public java.lang.String getBaseImageURL()

returns the base url for creating image URL

Specified by:

getBaseImageURL in interface IHTMLRenderOption

Returns:

Rreturn the abse image url

setBaseImageURL

public void setBaseImageURL(java.lang.String baseImageURL)

sets the base image URL for image handling

Specified by:

setBaseImageURL in interface IHTMLRenderOption

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

public void setLayoutPreference(java.lang.String layoutPreference)

Sets the flag indicationg that if the table should be outed as fixed.

Parameters:

layoutPreference - the flag

getLayoutPreference

public java.lang.String 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.