|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.engine.api.TaskOption
org.eclipse.birt.report.engine.api.RenderOption
org.eclipse.birt.report.engine.api.HTMLRenderOption
public class HTMLRenderOption
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, HTML, HTML_DISPLAY_FILTER_ICON, HTML_DISPLAY_GROUP_ICON, HTML_ENABLE_AGENTSTYLE_ENGINE, HTML_ENABLE_METADATA, HTML_ID_NAMESPACE, HTML_INCLUDE_SELECTION_HANDLE, HTML_LAYOUT_PREFERENCE, HTML_NOCSS, HTML_OUTPUT_MASTER_PAGE_MARGINS, 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, APP_BASE_URL, BASE_URL, 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, RTL_FLAG, SUPPORTED_IMAGE_FORMATS |
Constructor Summary | |
---|---|
HTMLRenderOption()
Default constructor. |
|
HTMLRenderOption(java.util.HashMap options)
|
|
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()
|
java.lang.String |
getHTMLIDNamespace()
|
boolean |
getHtmlPagination()
Get html pagination. |
boolean |
getHtmlRtLFlag()
Get Html RTL flag. |
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()
Get master page content. |
boolean |
getOutputMasterPageMargins()
|
boolean |
getPageFooterFloatFlag()
Get page footer float flag. |
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 |
setHTMLIDNamespace(java.lang.String id)
sets the HTML ID namespace. |
void |
setHtmlPagination(boolean paginate)
Set html pagination. |
void |
setHtmlRtLFlag(boolean flag)
Set Html RTL 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)
Set master page content. |
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(java.lang.String encoding)
Set the URL encoding for the request. |
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 |
---|
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, 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 Detail |
---|
public HTMLRenderOption(IRenderOption options)
public HTMLRenderOption(java.util.HashMap options)
public HTMLRenderOption()
Method Detail |
---|
public java.util.List getInstanceIDs()
getInstanceIDs
in interface IHTMLRenderOption
public void setInstanceIDs(java.util.List instanceIDs)
setInstanceIDs
in interface IHTMLRenderOption
instanceIDs
- The instanceIDs to set.public void setEmbeddable(boolean embeddable)
setEmbeddable
in interface IHTMLRenderOption
embeddable
- whether the HTML output can be embedded directly into an HTML
pagepublic boolean getEmbeddable()
getEmbeddable
in interface IHTMLRenderOption
public void setUserAgent(java.lang.String userAgent)
setUserAgent
in interface IHTMLRenderOption
userAgent
- the user agent of the requestpublic java.lang.String getUserAgent()
getUserAgent
in interface IHTMLRenderOption
public void setUrlEncoding(java.lang.String encoding)
setUrlEncoding
in interface IHTMLRenderOption
public java.lang.String getUrlEncoding()
getUrlEncoding
in interface IHTMLRenderOption
public void setMasterPageContent(boolean show)
setMasterPageContent
in interface IHTMLRenderOption
public boolean getMasterPageContent()
getMasterPageContent
in interface IHTMLRenderOption
public void setHtmlPagination(boolean paginate)
setHtmlPagination
in interface IHTMLRenderOption
public boolean getHtmlPagination()
getHtmlPagination
in interface IHTMLRenderOption
public void setIncludeSelectionHandle(boolean option)
setIncludeSelectionHandle
in interface IHTMLRenderOption
public boolean getIncludeSelectionHandle()
getIncludeSelectionHandle
in interface IHTMLRenderOption
public void setHtmlRtLFlag(boolean flag)
setHtmlRtLFlag
in interface IHTMLRenderOption
public boolean getHtmlRtLFlag()
getHtmlRtLFlag
in interface IHTMLRenderOption
public void setHtmlTitle(java.lang.String htmlTitle)
setHtmlTitle
in interface IHTMLRenderOption
htmlTile
- public java.lang.String getHtmlTitle()
getHtmlTitle
in interface IHTMLRenderOption
public void setPageFooterFloatFlag(boolean flag)
setPageFooterFloatFlag
in interface IHTMLRenderOption
public boolean getPageFooterFloatFlag()
getPageFooterFloatFlag
in interface IHTMLRenderOption
public void setEnableMetadata(boolean enableMetadata)
setEnableMetadata
in interface IHTMLRenderOption
enableMetadata
- the flagpublic boolean getEnableMetadata()
getEnableMetadata
in interface IHTMLRenderOption
public void setDisplayFilterIcon(boolean displayFilterIcon)
setDisplayFilterIcon
in interface IHTMLRenderOption
displayFilterIcon
- the flagpublic boolean getDisplayFilterIcon()
getDisplayFilterIcon
in interface IHTMLRenderOption
public void setDisplayGroupIcon(boolean displayGroupIcon)
setDisplayGroupIcon
in interface IHTMLRenderOption
displayGroupIcon
- the flagpublic boolean getDisplayGroupIcon()
getDisplayGroupIcon
in interface IHTMLRenderOption
public java.lang.String getImageDirectory()
getImageDirectory
in interface IHTMLRenderOption
public void setImageDirectory(java.lang.String imageDirectory)
setImageDirectory
in interface IHTMLRenderOption
imageDirectory
- the image directory that engine stores images and charts intopublic java.lang.String getBaseImageURL()
getBaseImageURL
in interface IHTMLRenderOption
public void setBaseImageURL(java.lang.String baseImageURL)
setBaseImageURL
in interface IHTMLRenderOption
baseImageURL
- the base image URLpublic void setWrapTemplateTable(boolean wrapTemplateTable)
wrapTemplateTable
- the flagpublic boolean getWrapTemplateTable()
public void setLayoutPreference(java.lang.String layoutPreference)
layoutPreference
- the flagpublic java.lang.String getLayoutPreference()
public void setEnableAgentStyleEngine(boolean enableAgentStyleEngine)
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.public boolean getEnableAgentStyleEngine()
public void setOutputMasterPageMargins(boolean outputMasterPageMargins)
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.public boolean getOutputMasterPageMargins()
public void setHTMLIDNamespace(java.lang.String id)
id
- the viewer idpublic java.lang.String getHTMLIDNamespace()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |