|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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_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, BASE_URL, EMITTER_ID, HTML_PAGINATION, IMAGE_HANDLER, LOCALE, OUTPUT_DISPLAY_NONE, OUTPUT_FILE_NAME, OUTPUT_FORMAT, OUTPUT_FORMAT_FO, OUTPUT_FORMAT_HTML, OUTPUT_FORMAT_PDF, OUTPUT_STREAM, 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()
|
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()
|
boolean |
getMasterPageContent()
|
boolean |
getPageFooterFloatFlag()
|
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)
|
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 |
setMasterPageContent(boolean show)
|
void |
setPageFooterFloatFlag(boolean 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, getBaseURL, getEmitterID, getImageHandle, getImageHandler, getOption, getOptions, getOutputFileName, getOutputFormat, getOutputSetting, getOutputStream, getSupportedImageFormats, hasOption, setActionHandle, setActionHandler, setBaseURL, setEmitterID, setImageHandle, setImageHandler, setOption, setOutputFileName, setOutputFormat, setOutputStream, setSupportedImageFormats |
Field Detail |
public static final java.lang.String HTML_TYPE
public static final java.lang.String HTML
public static final java.lang.String HTML_NOCSS
public static final java.lang.String USER_AGENT
public static final java.lang.String URL_ENCODING
public static final java.lang.String INSTANCE_ID_LIST
public static final java.lang.String MASTER_PAGE_CONTENT
Boolean.TRUE
Only effect if the
HTML_Pagination is true
public static final java.lang.String HTML_INCLUDE_SELECTION_HANDLE
Boolean.FALSE
.
public static final java.lang.String HTML_RTL_FLAG
Boolean.FALSE
.
public static final java.lang.String HTML_TITLE
public static final java.lang.String PAGEFOOTER_FLOAT_FLAG
Boolean.TRUE
. Only effect when HTML_PAGINATION is set to
Boolean.TRUE
public 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
public static final java.lang.String HTML_DISPLAY_FILTER_ICON
Boolea.TRUE
. The default value is
Boolean.FALSE
public static final java.lang.String HTML_DISPLAY_GROUP_ICON
Boolea.TRUE
. The default value is
Boolean.FALSE
public static final java.lang.String IMAGE_DIRECTROY
public static final java.lang.String BASE_IMAGE_URL
public static final java.lang.String LAYOUT_PREFERENCE_FIXED
public static final java.lang.String LAYOUT_PREFERENCE_AUTO
public static final java.lang.String HTML_WRAP_TEMPLATE_TABLE
Boolea.TRUE
. The default
value is Boolean.FALSE
public static final java.lang.String HTML_LAYOUT_PREFERENCE
Boolean.FALSE
public 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.
public 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.
Method Detail |
public java.util.List getInstanceIDs()
public void setInstanceIDs(java.util.List instanceIDs)
instanceIDs
- The instanceIDs to set.public void setEmbeddable(boolean embeddable)
embeddable
- whether the HTML output can be embedded directly into an HTML
pagepublic boolean getEmbeddable()
public void setUserAgent(java.lang.String userAgent)
userAgent
- the user agent of the requestpublic java.lang.String getUserAgent()
public void setUrlEncoding(java.lang.String encoding)
public java.lang.String getUrlEncoding()
public void setMasterPageContent(boolean show)
public boolean getMasterPageContent()
public void setHtmlPagination(boolean paginate)
public boolean getHtmlPagination()
public void setIncludeSelectionHandle(boolean option)
public boolean getIncludeSelectionHandle()
public void setHtmlRtLFlag(boolean flag)
public boolean getHtmlRtLFlag()
public void setHtmlTitle(java.lang.String htmlTitle)
public java.lang.String getHtmlTitle()
public void setPageFooterFloatFlag(boolean flag)
public boolean getPageFooterFloatFlag()
public void setEnableMetadata(boolean enableMetadata)
enableMetadata
- the flagpublic boolean getEnableMetadata()
public void setDisplayFilterIcon(boolean displayFilterIcon)
displayFilterIcon
- the flagpublic boolean getDisplayFilterIcon()
public void setDisplayGroupIcon(boolean displayFilterIcon)
displayFilterIcon
- the flagpublic boolean getDisplayGroupIcon()
public java.lang.String getImageDirectory()
public void setImageDirectory(java.lang.String imageDirectory)
imageDirectory
- the image directory that engine stores images and charts intopublic java.lang.String getBaseImageURL()
public 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 |