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

java.lang.Object
  extended byorg.eclipse.birt.report.engine.api.RenderOptionBase
All Implemented Interfaces:
IRenderOption
Direct Known Subclasses:
FORenderOption, HTMLRenderOption

public class RenderOptionBase
extends java.lang.Object
implements IRenderOption

Settings for rendering a report to an output format. Currently supported options include format of the request, whether to render HTML with style sheet, etc. Potential future options includes image formats in PDF (vector or bitmap), font embedding options, etc.

The predefined options strings are what BIRT supports. Other options are available depending on custom extensions.


Field Summary
static java.lang.String ACTION_HANDLER
           
static java.lang.String IMAGE_HANDLER
           
static java.lang.String LOCALE
           
protected  java.util.HashMap options
          a hash map that stores the rendering options
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
           
 
Constructor Summary
RenderOptionBase()
          constructor
 
Method Summary
protected  java.lang.Object getOption(java.lang.String name)
          get option value for one rendering option
 java.lang.String getOutputFormat()
          returns the output format, i.e., html, pdf, etc.
 java.util.HashMap getOutputSetting()
          returns the output settings
protected  void setOption(java.lang.String name, java.lang.Object value)
          set value for one rendering option
 void setOutputFileName(java.lang.String outputFileName)
          sets the output file name.
 void setOutputFormat(java.lang.String format)
          sets the output format
 void setOutputStream(java.io.OutputStream ostream)
          sets the stream for writing emitter output
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OUTPUT_FORMAT

public static final java.lang.String OUTPUT_FORMAT
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

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

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

LOCALE

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

options

protected java.util.HashMap options
a hash map that stores the rendering options

Constructor Detail

RenderOptionBase

public RenderOptionBase()
constructor

Method Detail

getOutputFormat

public java.lang.String getOutputFormat()
returns the output format, i.e., html, pdf, etc.

Specified by:
getOutputFormat in interface IRenderOption
Returns:
Returns the output format

setOption

protected void setOption(java.lang.String name,
                         java.lang.Object value)
set value for one rendering option

Parameters:
name - the option name
value - value for the option

getOption

protected java.lang.Object getOption(java.lang.String name)
get option value for one rendering option

Parameters:
name - the option name
Returns:
the option value

getOutputSetting

public java.util.HashMap getOutputSetting()
returns the output settings

Specified by:
getOutputSetting in interface IRenderOption
Returns:
the output settings

setOutputFormat

public void setOutputFormat(java.lang.String format)
Description copied from interface: IRenderOption
sets the output format

Specified by:
setOutputFormat in interface IRenderOption
Parameters:
format - the output format

setOutputStream

public void setOutputStream(java.io.OutputStream ostream)
Description copied from interface: IRenderOption
sets the stream for writing emitter output

Specified by:
setOutputStream in interface IRenderOption
Parameters:
ostream - the output stream for writing emitter output

setOutputFileName

public void setOutputFileName(java.lang.String outputFileName)
Description copied from interface: IRenderOption
sets the output file name. The emitter uses the file for writing its ouput

Specified by:
setOutputFileName in interface IRenderOption
Parameters:
outputFileName - the output file name that emitter uses


Copyright © 2005 Actuate Corp. All rights reserved.