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

All Superinterfaces:
IRenderOption
All Known Implementing Classes:
HTMLRenderOption

public interface IHTMLRenderOption
extends IRenderOption

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_PAGINATION
          Should the report contains paginations The value is a Boolean object, default is Boolean.FALSE.
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, 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

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.FALSE.

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

IMAGE_DIRECTROY

public static final java.lang.String IMAGE_DIRECTROY
See Also:
Constant Field Values

BASE_IMAGE_URL

public static final java.lang.String BASE_IMAGE_URL
See Also:
Constant Field Values

LAYOUT_PREFERENCE_FIXED

public static final java.lang.String LAYOUT_PREFERENCE_FIXED
See Also:
Constant Field Values

LAYOUT_PREFERENCE_AUTO

public static final java.lang.String LAYOUT_PREFERENCE_AUTO
See Also:
Constant Field Values

HTML_WRAP_TEMPLATE_TABLE

public static final java.lang.String HTML_WRAP_TEMPLATE_TABLE
Should the top-level template table be wrapped. Only effect if the enable metadata is setting to Boolea.TRUE. The default value is Boolean.FALSE

See Also:
Constant Field Values

HTML_LAYOUT_PREFERENCE

public static final java.lang.String HTML_LAYOUT_PREFERENCE
Should the table be outed as fixed. The default value is Boolean.FALSE

See Also:
Constant Field Values

HTML_ENABLE_AGENTSTYLE_ENGINE

public static final java.lang.String HTML_ENABLE_AGENTSTYLE_ENGINE
Should the HTML emitter output the BIRT styles directly to the report. The default value is 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.

See Also:
Constant Field Values

HTML_OUTPUT_MASTER_PAGE_MARGINS

public static final java.lang.String HTML_OUTPUT_MASTER_PAGE_MARGINS
Should the HTML emitter output the master page's margins. This property is only works for the auto layout report. The fixed report will always output the master page's margins. The default value is 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.

See Also:
Constant Field Values
Method Detail

getInstanceIDs

public java.util.List getInstanceIDs()
Returns:
Returns the instanceIDs.

setInstanceIDs

public void setInstanceIDs(java.util.List instanceIDs)
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

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

getEmbeddable

public boolean getEmbeddable()
Returns:
whether the output is embeddable

setUserAgent

public void setUserAgent(java.lang.String userAgent)
Parameters:
userAgent - the user agent of the request

getUserAgent

public java.lang.String getUserAgent()
Returns:
the user agent for the request

setUrlEncoding

public void setUrlEncoding(java.lang.String encoding)

getUrlEncoding

public java.lang.String getUrlEncoding()
Returns:
the user agent for the request

setMasterPageContent

public void setMasterPageContent(boolean show)

getMasterPageContent

public boolean getMasterPageContent()

setHtmlPagination

public void setHtmlPagination(boolean paginate)

getHtmlPagination

public boolean getHtmlPagination()

setIncludeSelectionHandle

public void setIncludeSelectionHandle(boolean option)
Deprecated. includeSelectionHandle is replaced by eanableMetadata flag.


getIncludeSelectionHandle

public boolean getIncludeSelectionHandle()
Deprecated. includeSelectionHandle is replaced by eanableMetadata flag.


setHtmlRtLFlag

public void setHtmlRtLFlag(boolean flag)

getHtmlRtLFlag

public boolean getHtmlRtLFlag()

setHtmlTitle

public void setHtmlTitle(java.lang.String htmlTitle)

getHtmlTitle

public java.lang.String getHtmlTitle()
Returns:
the default html title

setPageFooterFloatFlag

public void setPageFooterFloatFlag(boolean flag)

getPageFooterFloatFlag

public boolean getPageFooterFloatFlag()

setEnableMetadata

public void setEnableMetadata(boolean enableMetadata)
Sets the flag which indicating if metadata should be output.

Parameters:
enableMetadata - the flag

getEnableMetadata

public boolean getEnableMetadata()
Returns:
the enable metadata flag value.

setDisplayFilterIcon

public void setDisplayFilterIcon(boolean displayFilterIcon)
Sets the flag indicationg that if filter icons should be displayed.

Parameters:
displayFilterIcon - the flag

getDisplayFilterIcon

public boolean getDisplayFilterIcon()
Returns:
the display filter icon flag value.

setDisplayGroupIcon

public void setDisplayGroupIcon(boolean displayFilterIcon)
Sets the flag indicationg that if group expand/collapse icons should be displayed.

Parameters:
displayFilterIcon - the flag

getDisplayGroupIcon

public boolean getDisplayGroupIcon()
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

Returns:
the image directory.

setImageDirectory

public void setImageDirectory(java.lang.String imageDirectory)
sets the image directory that engine stores images and charts into

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

Returns:
Rreturn the abse image url

setBaseImageURL

public void setBaseImageURL(java.lang.String baseImageURL)
sets the base image URL for image handling

Parameters:
baseImageURL - the base image URL


Copyright © 2005 Actuate Corp. All rights reserved.