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

All Known Subinterfaces:
IHTMLRenderOption, IPDFRenderOption
All Known Implementing Classes:
HTMLRenderOption, PDFRenderOption, RenderOption

public interface IRenderOption

Defines render options for emitters


Field Summary
static java.lang.String ACTION_HANDLER
           
static java.lang.String BASE_URL
           
static java.lang.String EMITTER_ID
           
static java.lang.String IMAGE_HANDLER
           
static java.lang.String LOCALE
           
static java.lang.String OUTPUT_DISPLAY_NONE
           
static java.lang.String OUTPUT_FILE_NAME
           
static java.lang.String OUTPUT_FORMAT
           
static java.lang.String OUTPUT_FORMAT_FO
           
static java.lang.String OUTPUT_FORMAT_HTML
           
static java.lang.String OUTPUT_FORMAT_PDF
           
static java.lang.String OUTPUT_STREAM
           
static java.lang.String SUPPORTED_IMAGE_FORMATS
           
 
Method Summary
 IHTMLActionHandler getActionHandle()
          Deprecated.  
 IHTMLActionHandler getActionHandler()
           
 java.lang.String getBaseURL()
          Returns the base URL for creating an Action URL
 java.lang.String getEmitterID()
          returns the emitter id
 IHTMLImageHandler getImageHandle()
          Deprecated.  
 IHTMLImageHandler getImageHandler()
           
 java.lang.Object getOption(java.lang.String name)
          get the option value defined by the name.
 java.util.HashMap getOptions()
          get all the options defined in this object
 java.lang.String getOutputFileName()
           
 java.lang.String getOutputFormat()
           
 java.util.HashMap getOutputSetting()
          Deprecated. use getOptions instead
 java.io.OutputStream getOutputStream()
           
 java.lang.String getSupportedImageFormats()
           
 boolean hasOption(java.lang.String name)
          if there exits an option named by name.
 void setActionHandle(IHTMLActionHandler handler)
          Deprecated.  
 void setActionHandler(IHTMLActionHandler handler)
           
 void setBaseURL(java.lang.String baseURL)
          sets the base url for action handling
 void setEmitterID(java.lang.String emitterID)
          sets the emitter id
 void setImageHandle(IHTMLImageHandler handler)
          Deprecated.  
 void setImageHandler(IHTMLImageHandler handler)
           
 void setOption(java.lang.String name, java.lang.Object value)
          set the option value.
 void setOutputFileName(java.lang.String outputFileName)
           
 void setOutputFormat(java.lang.String format)
           
 void setOutputStream(java.io.OutputStream ostream)
           
 void setSupportedImageFormats(java.lang.String formats)
           
 

Field Detail

OUTPUT_FORMAT

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

OUTPUT_FORMAT_HTML

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

OUTPUT_FORMAT_PDF

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

OUTPUT_FORMAT_FO

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

EMITTER_ID

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

OUTPUT_FILE_NAME

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

OUTPUT_STREAM

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

IMAGE_HANDLER

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

ACTION_HANDLER

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

LOCALE

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

SUPPORTED_IMAGE_FORMATS

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

BASE_URL

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

OUTPUT_DISPLAY_NONE

public static final java.lang.String OUTPUT_DISPLAY_NONE
See Also:
Constant Field Values
Method Detail

getOptions

public java.util.HashMap getOptions()
get all the options defined in this object

Returns:

getOutputSetting

public java.util.HashMap getOutputSetting()
Deprecated. use getOptions instead

Returns:

setOption

public void setOption(java.lang.String name,
                      java.lang.Object value)
set the option value.

Parameters:
name - option name.
value - value

getOption

public java.lang.Object getOption(java.lang.String name)
get the option value defined by the name.

Parameters:
name - option name.
Returns:
value, null if not defined

hasOption

public boolean hasOption(java.lang.String name)
if there exits an option named by name.

Parameters:
name - option name.
Returns:
true if user has defined an option with this name, even if the value is NULL. false otherwise.

setOutputFormat

public void setOutputFormat(java.lang.String format)

getOutputFormat

public java.lang.String getOutputFormat()

setOutputFileName

public void setOutputFileName(java.lang.String outputFileName)

getOutputFileName

public java.lang.String getOutputFileName()

setOutputStream

public void setOutputStream(java.io.OutputStream ostream)

getOutputStream

public java.io.OutputStream getOutputStream()

setSupportedImageFormats

public void setSupportedImageFormats(java.lang.String formats)
Parameters:
formats - - the image format supported by the browser

getSupportedImageFormats

public java.lang.String getSupportedImageFormats()
Returns:
the image format supported by the browser

getBaseURL

public java.lang.String getBaseURL()
Returns the base URL for creating an Action URL

Returns:
the baseURL.

setBaseURL

public void setBaseURL(java.lang.String baseURL)
sets the base url for action handling

Parameters:
baseURL - sets the base URL used for action handling

setActionHandle

public void setActionHandle(IHTMLActionHandler handler)
Deprecated.  

Parameters:
handler -

setActionHandler

public void setActionHandler(IHTMLActionHandler handler)

getActionHandle

public IHTMLActionHandler getActionHandle()
Deprecated.  

Returns:

getActionHandler

public IHTMLActionHandler getActionHandler()

setImageHandle

public void setImageHandle(IHTMLImageHandler handler)
Deprecated.  

Parameters:
handler -

setImageHandler

public void setImageHandler(IHTMLImageHandler handler)

getImageHandle

public IHTMLImageHandler getImageHandle()
Deprecated.  

Returns:

getImageHandler

public IHTMLImageHandler getImageHandler()

getEmitterID

public java.lang.String getEmitterID()
returns the emitter id

Returns:
Returns the emitter id

setEmitterID

public void setEmitterID(java.lang.String emitterID)
sets the emitter id

Parameters:
emitterID -


Copyright © 2005 Actuate Corp. All rights reserved.