|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Represents the extended item presentation time extension. The calling sequence in presentation engine might work as follows:
Field Summary | |
static int |
OUTPUT_AS_CUSTOM
|
static int |
OUTPUT_AS_DRAWING
|
static int |
OUTPUT_AS_HTML_TEXT
|
static int |
OUTPUT_AS_IMAGE
|
static int |
OUTPUT_AS_IMAGE_WITH_MAP
|
static int |
OUTPUT_AS_TEXT
|
static int |
OUTPUT_NONE
|
Method Summary | |
void |
deserialize(java.io.InputStream istream)
deserializes generation time state information about the extended item |
void |
finish()
Performs clean up work |
java.lang.String |
getImageMIMEType()
|
int |
getOutputType()
returns the output type, which could be IMAGE, TEXT, HTML TEXT, DRAWING, etc. |
org.eclipse.birt.report.engine.extension.Size |
getSize()
Get the size of the extended item. |
java.lang.Object |
onRowSets(IRowSet[] rowSets)
processes the extended item in report presentation environment. |
void |
setActionHandler(IHTMLActionHandler ah)
|
void |
setApplicationClassLoader(java.lang.ClassLoader loader)
passes the class loader used to load user defined classes. |
void |
setDynamicStyle(IStyle style)
Set dynamic style. |
void |
setLocale(java.util.Locale locale)
passes the locale used in the presentation. |
void |
setModelObject(org.eclipse.birt.report.model.api.ExtendedItemHandle modelHandle)
passes a handle to the extended report item model to the extension |
void |
setOutputFormat(java.lang.String outputFormat)
sets the output format, i.e., HTML, PDF, etc. |
void |
setReportQueries(org.eclipse.birt.data.engine.api.IBaseQueryDefinition[] queries)
pass the prepared query definition to extended item implementation, so that it can access data. |
void |
setResolution(int dpi)
passes the dpi (dot per inch) from the rendering environment to the extension. |
void |
setScriptContext(org.eclipse.birt.report.engine.api.script.IReportContext context)
pass the script context to the report item. |
void |
setSupportedImageFormats(java.lang.String supportedImageFormats)
sets the image formats that are supported for this output format. |
Field Detail |
public static final int OUTPUT_NONE
public static final int OUTPUT_AS_IMAGE
public static final int OUTPUT_AS_TEXT
public static final int OUTPUT_AS_HTML_TEXT
public static final int OUTPUT_AS_DRAWING
public static final int OUTPUT_AS_CUSTOM
public static final int OUTPUT_AS_IMAGE_WITH_MAP
Method Detail |
public void setModelObject(org.eclipse.birt.report.model.api.ExtendedItemHandle modelHandle)
modelHandle
- a handle to the extended item model objectpublic void setApplicationClassLoader(java.lang.ClassLoader loader)
loader
- class loader used to load the classespublic void setScriptContext(org.eclipse.birt.report.engine.api.script.IReportContext context)
context
- report context used by java-based scriptpublic void setReportQueries(org.eclipse.birt.data.engine.api.IBaseQueryDefinition[] queries)
public void setLocale(java.util.Locale locale)
locale
- localepublic void setResolution(int dpi)
dpi
- the dpi of the rendering environmentpublic void setOutputFormat(java.lang.String outputFormat)
outputFormat
- the output format, i.e., html, pdf, etc.public void setActionHandler(IHTMLActionHandler ah)
ah
- the HTML action handler used to create a URL based on an actionpublic java.lang.String getImageMIMEType()
public void setSupportedImageFormats(java.lang.String supportedImageFormats)
supportedImageFormats
- the image formats that the presentation engine could support.public void deserialize(java.io.InputStream istream)
istream
- the input stream to deserialize generation time state frompublic int getOutputType()
public java.lang.Object onRowSets(IRowSet[] rowSets) throws org.eclipse.birt.core.exception.BirtException
rowSets
- rowSets an array of row sets that is passed to the extension
org.eclipse.birt.core.exception.BirtException
- throws exception when there is a problem processing the
extended itempublic org.eclipse.birt.report.engine.extension.Size getSize()
public void finish()
public void setDynamicStyle(IStyle style)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |