org.eclipse.birt.report.engine.api
Class HTMLRenderOption

java.lang.Object
  extended byorg.eclipse.birt.report.engine.api.RenderOptionBase
      extended byorg.eclipse.birt.report.engine.api.HTMLRenderOption
All Implemented Interfaces:
IHTMLRenderOption, IRenderOption

public class HTMLRenderOption
extends RenderOptionBase
implements IHTMLRenderOption

output settings for HTML output format


Field Summary
 
Fields inherited from class org.eclipse.birt.report.engine.api.RenderOptionBase
ACTION_HANDLER, FIT_TO_PAGE, IMAGE_HANDLER, LOCALE, options, OUTPUT_FILE_NAME, OUTPUT_FORMAT, OUTPUT_FORMAT_FO, OUTPUT_FORMAT_HTML, OUTPUT_FORMAT_PDF, OUTPUT_STREAM, PAGEBREAK_PAGINATION_ONLY
 
Fields inherited from interface org.eclipse.birt.report.engine.api.IHTMLRenderOption
HTML, HTML_DISPLAY_FILTER_ICON, HTML_DISPLAY_GROUP_ICON, HTML_ENABLE_METADATA, HTML_INCLUDE_SELECTION_HANDLE, HTML_NOCSS, HTML_PAGINATION, HTML_RTL_FLAG, HTML_TITLE, HTML_TYPE, HTML_WRAP_TEMPLATE_TABLE, INSTANCE_ID_LIST, MASTER_PAGE_CONTENT, PAGEFOOTER_FLOAT_FLAG, URL_ENCODING, USER_AGENT
 
Constructor Summary
HTMLRenderOption()
          constructor
 
Method Summary
 IHTMLActionHandler getActionHandle()
           
 boolean getDisplayFilterIcon()
           
 boolean getDisplayGroupIcon()
           
 boolean getEmbeddable()
           
 boolean getEnableMetadata()
           
 boolean getHtmlPagination()
           
 boolean getHtmlRtLFlag()
           
 java.lang.String getHtmlTitle()
           
 boolean getIncludeSelectionHandle()
          Deprecated. includeSelectionHandle is replaced by eanableMetadata flag.
 java.util.List getInstanceIDs()
           
 boolean getMasterPageContent()
           
 boolean getPageFooterFloatFlag()
           
 java.lang.String getUserAgent()
           
 boolean getWrapTemplateTable()
           
 void setActionHandle(IHTMLActionHandler handler)
           
 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 option)
           
 void setHtmlTitle(java.lang.String htmlTile)
           
 void setIncludeSelectionHandle(boolean option)
          Deprecated. includeSelectionHandle is replaced by eanableMetadata flag.
 void setInstanceIDs(java.util.List instanceIDs)
           
 void setMasterPageContent(boolean show)
           
 void setPageFooterFloatFlag(boolean option)
           
 void setUserAgent(java.lang.String userAgent)
           
 void setWrapTemplateTable(boolean displayFilterIcon)
          Sets the flag indicationg that if the top-level table should be wrapped.
 
Methods inherited from class org.eclipse.birt.report.engine.api.RenderOptionBase
getOption, getOutputFormat, getOutputSetting, setOption, setOutputFileName, setOutputFormat, setOutputStream
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HTMLRenderOption

public HTMLRenderOption()
constructor

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

setMasterPageContent

public void setMasterPageContent(boolean show)

getMasterPageContent

public boolean getMasterPageContent()

setHtmlPagination

public void setHtmlPagination(boolean paginate)

getHtmlPagination

public boolean getHtmlPagination()

setActionHandle

public void setActionHandle(IHTMLActionHandler handler)

getActionHandle

public IHTMLActionHandler getActionHandle()

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 option)

getHtmlRtLFlag

public boolean getHtmlRtLFlag()

setHtmlTitle

public void setHtmlTitle(java.lang.String htmlTile)
Parameters:
htmlTile -

getHtmlTitle

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

setPageFooterFloatFlag

public void setPageFooterFloatFlag(boolean option)

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.

setWrapTemplateTable

public void setWrapTemplateTable(boolean displayFilterIcon)
Sets the flag indicationg that if the top-level table should be wrapped.

Parameters:
displayFilterIcon - the flag

getWrapTemplateTable

public boolean getWrapTemplateTable()
Returns:
the group expand/collapse icon flag value.


Copyright © 2005 Actuate Corp. All rights reserved.