|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IHTMLRenderOption
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 | |
---|---|
static java.lang.String |
BASE_IMAGE_URL
|
static java.lang.String |
HTML
Output a complete HTML |
static java.lang.String |
HTML_DISPLAY_FILTER_ICON
Should the output display the filter icon. |
static java.lang.String |
HTML_DISPLAY_GROUP_ICON
Should the output display the group icon. |
static java.lang.String |
HTML_ENABLE_AGENTSTYLE_ENGINE
Should the HTML emitter output the BIRT styles directly to the report. |
static java.lang.String |
HTML_ENABLE_METADATA
Should the output contain metadata. |
static java.lang.String |
HTML_ID_NAMESPACE
|
static java.lang.String |
HTML_INCLUDE_SELECTION_HANDLE
Deprecated. use METADATA |
static java.lang.String |
HTML_LAYOUT_PREFERENCE
Should the table be outed as fixed. |
static java.lang.String |
HTML_NOCSS
Output a HTML fragement without CSS defination. |
static java.lang.String |
HTML_OUTPUT_MASTER_PAGE_MARGINS
Should the HTML emitter output the master page's margins. |
static java.lang.String |
HTML_RTL_FLAG
Should we output HTML as RtL. |
static java.lang.String |
HTML_TITLE
Output the HTML default title. |
static java.lang.String |
HTML_TYPE
Define the type of the html content, it can be one of: HTML or HTML_NOCSS. |
static java.lang.String |
HTML_WRAP_TEMPLATE_TABLE
Should the top-level template table be wrapped. |
static java.lang.String |
IMAGE_DIRECTROY
|
static java.lang.String |
INSTANCE_ID_LIST
The list used to contain the active object ids. |
static java.lang.String |
LAYOUT_PREFERENCE_AUTO
|
static java.lang.String |
LAYOUT_PREFERENCE_FIXED
|
static java.lang.String |
MASTER_PAGE_CONTENT
Should the report contains page header and footer The value is a Boolean object, default is Boolean.TRUE Only effect if the
HTML_Pagination is true |
static java.lang.String |
PAGEFOOTER_FLOAT_FLAG
Floating the page footer. |
static java.lang.String |
URL_ENCODING
for some case, the user needs to define the resource encoding. |
static java.lang.String |
USER_AGENT
The 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, 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 |
Method Summary | |
---|---|
java.lang.String |
getBaseImageURL()
returns the base url for creating image URL |
boolean |
getDisplayFilterIcon()
|
boolean |
getDisplayGroupIcon()
|
boolean |
getEmbeddable()
|
boolean |
getEnableMetadata()
|
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()
|
boolean |
getMasterPageContent()
Get master page content. |
boolean |
getPageFooterFloatFlag()
Get page footer float flag. |
java.lang.String |
getUrlEncoding()
|
java.lang.String |
getUserAgent()
|
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 displayFilterIcon)
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 |
setEnableMetadata(boolean enableMetadata)
Sets the flag which indicating if metadata should be output. |
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 |
setMasterPageContent(boolean show)
Set master page content. |
void |
setPageFooterFloatFlag(boolean flag)
Set page footer float flag. |
void |
setUrlEncoding(java.lang.String encoding)
|
void |
setUserAgent(java.lang.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, setSupportedImageFormats |
Methods inherited from interface org.eclipse.birt.report.engine.api.ITaskOption |
---|
getOption, getOptions, hasOption, setOption |
Field Detail |
---|
static final java.lang.String HTML_TYPE
static final java.lang.String HTML
static final java.lang.String HTML_NOCSS
static final java.lang.String USER_AGENT
static final java.lang.String URL_ENCODING
static final java.lang.String INSTANCE_ID_LIST
static final java.lang.String MASTER_PAGE_CONTENT
Boolean.TRUE
Only effect if the
HTML_Pagination is true
static final java.lang.String HTML_INCLUDE_SELECTION_HANDLE
Boolean.FALSE
.
static final java.lang.String HTML_RTL_FLAG
Boolean.FALSE
.
static final java.lang.String HTML_TITLE
static final java.lang.String PAGEFOOTER_FLOAT_FLAG
Boolean.TRUE
. Only effect when HTML_PAGINATION is set to
Boolean.TRUE
static final java.lang.String HTML_ENABLE_METADATA
Boolean.TRUE
., the output will contains
metadata include: Instance id, type and so on The default value is
Boolean.FALSE
static final java.lang.String HTML_DISPLAY_FILTER_ICON
Boolea.TRUE
. The default value is
Boolean.FALSE
static final java.lang.String HTML_DISPLAY_GROUP_ICON
Boolea.TRUE
. The default value is
Boolean.FALSE
static final java.lang.String IMAGE_DIRECTROY
static final java.lang.String BASE_IMAGE_URL
static final java.lang.String LAYOUT_PREFERENCE_FIXED
static final java.lang.String LAYOUT_PREFERENCE_AUTO
static final java.lang.String HTML_WRAP_TEMPLATE_TABLE
Boolea.TRUE
. The default
value is Boolean.FALSE
static final java.lang.String HTML_LAYOUT_PREFERENCE
Boolean.FALSE
static final java.lang.String HTML_ENABLE_AGENTSTYLE_ENGINE
Boolean.FALSE
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.
static final java.lang.String HTML_OUTPUT_MASTER_PAGE_MARGINS
Boolean.FALSE
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.
static final java.lang.String HTML_ID_NAMESPACE
Method Detail |
---|
java.util.List getInstanceIDs()
void setInstanceIDs(java.util.List instanceIDs)
instanceIDs
- The instanceIDs to set.void setEmbeddable(boolean embeddable)
embeddable
- whether the HTML output can be embedded directly into an HTML
pageboolean getEmbeddable()
void setUserAgent(java.lang.String userAgent)
userAgent
- the user agent of the requestjava.lang.String getUserAgent()
void setUrlEncoding(java.lang.String encoding)
java.lang.String getUrlEncoding()
void setMasterPageContent(boolean show)
show
- boolean getMasterPageContent()
void setHtmlPagination(boolean paginate)
paginate
- boolean getHtmlPagination()
void setIncludeSelectionHandle(boolean option)
boolean getIncludeSelectionHandle()
void setHtmlRtLFlag(boolean flag)
flag
- boolean getHtmlRtLFlag()
void setHtmlTitle(java.lang.String htmlTitle)
htmlTile
- java.lang.String getHtmlTitle()
void setPageFooterFloatFlag(boolean flag)
flag
- boolean getPageFooterFloatFlag()
void setEnableMetadata(boolean enableMetadata)
enableMetadata
- the flagboolean getEnableMetadata()
void setDisplayFilterIcon(boolean displayFilterIcon)
displayFilterIcon
- the flagboolean getDisplayFilterIcon()
void setDisplayGroupIcon(boolean displayFilterIcon)
displayFilterIcon
- the flagboolean getDisplayGroupIcon()
java.lang.String getImageDirectory()
void setImageDirectory(java.lang.String imageDirectory)
imageDirectory
- the image directory that engine stores images and charts intojava.lang.String getBaseImageURL()
void setBaseImageURL(java.lang.String baseImageURL)
baseImageURL
- the base image URL
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |