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:
IRenderOption

public class HTMLRenderOption
extends RenderOptionBase

output settings for HTML output format


Field Summary
static java.lang.String HTML
           
static java.lang.String HTML_NOCSS
           
static java.lang.String HTML_PAGINATION
           
static java.lang.String HTML_TYPE
           
static java.lang.String INSTANCE_ID_LIST
           
protected  java.util.List instanceIDs
           
static java.lang.String MASTER_PAGE_CONTENT
           
static java.lang.String URL_ENCODING
           
static java.lang.String USER_AGENT
           
 
Fields inherited from class org.eclipse.birt.report.engine.api.RenderOptionBase
ACTION_HANDLER, IMAGE_HANDLER, LOCALE, options, OUTPUT_FILE_NAME, OUTPUT_FORMAT, OUTPUT_FORMAT_FO, OUTPUT_FORMAT_HTML, OUTPUT_FORMAT_PDF, OUTPUT_STREAM
 
Constructor Summary
HTMLRenderOption()
          constructor
 
Method Summary
 IHTMLActionHandler getActionHandle()
           
 boolean getEmbeddable()
           
 boolean getHtmlPagination()
           
 java.util.List getInstanceIDs()
           
 boolean getMasterPageContent()
           
 java.lang.String getUserAgent()
           
 void setActionHandle(IHTMLActionHandler handler)
           
 void setEmbeddable(boolean embeddable)
          sets whether the HTML output can be embedded directly into an HTML page
 void setHtmlPagination(boolean paginate)
           
 void setInstanceIDs(java.util.List instanceIDs)
           
 void setMasterPageContent(boolean show)
           
 void setUserAgent(java.lang.String userAgent)
           
 
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
 

Field Detail

HTML_TYPE

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

HTML

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

HTML_NOCSS

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

USER_AGENT

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

URL_ENCODING

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

INSTANCE_ID_LIST

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

HTML_PAGINATION

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

MASTER_PAGE_CONTENT

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

instanceIDs

protected java.util.List instanceIDs
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()


Copyright © 2005 Actuate Corp. All rights reserved.