|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.engine.api.RenderOptionBase
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 |
FIT_TO_PAGE
|
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
|
static java.lang.String |
PAGEBREAK_PAGINATION_ONLY
|
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 |
public static final java.lang.String OUTPUT_FORMAT
public static final java.lang.String IMAGE_HANDLER
public static final java.lang.String ACTION_HANDLER
public static final java.lang.String OUTPUT_FORMAT_HTML
public static final java.lang.String OUTPUT_FORMAT_PDF
public static final java.lang.String OUTPUT_FORMAT_FO
public static final java.lang.String OUTPUT_FILE_NAME
public static final java.lang.String OUTPUT_STREAM
public static final java.lang.String LOCALE
public static final java.lang.String FIT_TO_PAGE
public static final java.lang.String PAGEBREAK_PAGINATION_ONLY
protected java.util.HashMap options
Constructor Detail |
public RenderOptionBase()
Method Detail |
public java.lang.String getOutputFormat()
getOutputFormat
in interface IRenderOption
protected void setOption(java.lang.String name, java.lang.Object value)
name
- the option namevalue
- value for the optionprotected java.lang.Object getOption(java.lang.String name)
name
- the option name
public java.util.HashMap getOutputSetting()
getOutputSetting
in interface IRenderOption
public void setOutputFormat(java.lang.String format)
IRenderOption
setOutputFormat
in interface IRenderOption
format
- the output formatpublic void setOutputStream(java.io.OutputStream ostream)
IRenderOption
setOutputStream
in interface IRenderOption
ostream
- the output stream for writing emitter outputpublic void setOutputFileName(java.lang.String outputFileName)
IRenderOption
setOutputFileName
in interface IRenderOption
outputFileName
- the output file name that emitter uses
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |