org.eclipse.birt.report.engine.api
Interface IHTMLRenderOption

All Known Implementing Classes:
HTMLRenderOption

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 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_METADATA
          Should the output contain metadata.
static java.lang.String HTML_INCLUDE_SELECTION_HANDLE
          Deprecated. use METADATA
static java.lang.String HTML_NOCSS
          Output a HTML fragement without CSS defination.
static java.lang.String HTML_PAGINATION
          Should the report contains paginations The value is a Boolean object, default is Boolean.TRUE.
static java.lang.String HTML_RTL_FLAG
          Should we output HTML as RtL.
static java.lang.String HTML_TITLE
          Output the HTML default title. value???
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 INSTANCE_ID_LIST
          The list used to contain the active object ids.
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.
 

Field Detail

HTML_TYPE

public static final java.lang.String HTML_TYPE
Define the type of the html content, it can be one of: HTML or HTML_NOCSS.

See Also:
Constant Field Values

HTML

public static final java.lang.String HTML
Output a complete HTML

See Also:
Constant Field Values

HTML_NOCSS

public static final java.lang.String HTML_NOCSS
Output a HTML fragement without CSS defination.

See Also:
Constant Field Values

USER_AGENT

public static final java.lang.String USER_AGENT
The agent used to render the html output.

See Also:
Constant Field Values

URL_ENCODING

public static final java.lang.String URL_ENCODING
for some case, the user needs to define the resource encoding. It is used to encoding the hyperlinks which refers to the local resource. The value is a encode name, such as "utf-8".

See Also:
Constant Field Values

INSTANCE_ID_LIST

public static final java.lang.String INSTANCE_ID_LIST
The list used to contain the active object ids. The value is a List object. The active objects including: Tempalate, Table, Chart, Label. the object in the list is a string, which is : bookmark, type, id.

See Also:
Constant Field Values

HTML_PAGINATION

public static final java.lang.String HTML_PAGINATION
Should the report contains paginations The value is a Boolean object, default is Boolean.TRUE.

See Also:
Constant Field Values

MASTER_PAGE_CONTENT

public static final 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

See Also:
Constant Field Values

HTML_INCLUDE_SELECTION_HANDLE

public static final java.lang.String HTML_INCLUDE_SELECTION_HANDLE
Deprecated. use METADATA

Should we output the selection handle with the active object. The value is a Boolean Object, the default is Boolean.FALSE.

See Also:
Constant Field Values

HTML_RTL_FLAG

public static final java.lang.String HTML_RTL_FLAG
Should we output HTML as RtL. The value is an Boolean Object, the default is Boolean.FALSE.

See Also:
Constant Field Values

HTML_TITLE

public static final java.lang.String HTML_TITLE
Output the HTML default title. value???

See Also:
Constant Field Values

PAGEFOOTER_FLOAT_FLAG

public static final java.lang.String PAGEFOOTER_FLOAT_FLAG
Floating the page footer. The value is an Boolean Object, the default is Boolean.TRUE. Only effect when HTML_PAGINATION is set to Boolean.TRUE

See Also:
Constant Field Values

HTML_ENABLE_METADATA

public static final java.lang.String HTML_ENABLE_METADATA
Should the output contain metadata. This value is a Boolean Object. And if it's set to be Boolean.TRUE., the output will contains metadata include: Instance id, type and so on The default value is Boolean.FALSE

See Also:
Constant Field Values

HTML_DISPLAY_FILTER_ICON

public static final java.lang.String HTML_DISPLAY_FILTER_ICON
Should the output display the filter icon. Only effect if the enable metadata is setting to Boolea.TRUE. The default value is Boolean.FALSE

See Also:
Constant Field Values

HTML_DISPLAY_GROUP_ICON

public static final java.lang.String HTML_DISPLAY_GROUP_ICON
Should the output display the group icon. Only effect if the enable metadata is setting to Boolea.TRUE. The default value is Boolean.FALSE

See Also:
Constant Field Values


Copyright © 2005 Actuate Corp. All rights reserved.