public interface IReportItemPresentation
Modifier and Type | Field and Description |
---|---|
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_AS_UNKNOWN |
static int |
OUTPUT_NONE |
Modifier and Type | Method and Description |
---|---|
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.
|
IReportItemPresentationInfo |
getPresentationConfig() |
Size |
getSize()
Get the size of the extended item.
|
void |
init(IReportItemPresentationInfo info) |
boolean |
isCacheable()
Check if can support cache in current situation.
|
java.lang.Object |
onRowSets(IBaseResultSet[] results)
Process the extended item.
|
java.lang.Object |
onRowSets(IRowSet[] rowSets)
Deprecated.
since BIRT 2.3
|
void |
setActionHandler(IHTMLActionHandler ah)
Deprecated.
implement #init(IReportItemPresentationInfo) instead.
|
void |
setApplicationClassLoader(java.lang.ClassLoader loader)
Deprecated.
implement #init(IReportItemPresentationInfo) instead.
|
void |
setDynamicStyle(IStyle style)
Deprecated.
implement #init(IReportItemPresentationInfo) instead.
Set dynamic style.
|
void |
setExtendedItemContent(IContent content)
Deprecated.
implement #init(IReportItemPresentationInfo) instead.
|
void |
setLocale(java.util.Locale locale)
Deprecated.
implement #init(IReportItemPresentationInfo) instead.
|
void |
setModelObject(ExtendedItemHandle modelHandle)
Deprecated.
implement #init(IReportItemPresentationInfo) instead
|
void |
setOutputFormat(java.lang.String outputFormat)
Deprecated.
implement #init(IReportItemPresentationInfo) instead.
|
void |
setReportQueries(IDataQueryDefinition[] queries)
Deprecated.
implement #init(IReportItemPresentationInfo) instead.
pass the prepared query definition to extended item implementation, so
that it can access data.
|
void |
setResolution(int dpi)
Deprecated.
implement #init(IReportItemPresentationInfo) instead.
|
void |
setScriptContext(IReportContext context)
Deprecated.
implement #init(IReportItemPresentationInfo) instead.
|
void |
setSupportedImageFormats(java.lang.String supportedImageFormats)
Deprecated.
implement #init(IReportItemPresentationInfo) instead.
|
static final int OUTPUT_NONE
static final int OUTPUT_AS_IMAGE
static final int OUTPUT_AS_TEXT
static final int OUTPUT_AS_HTML_TEXT
static final int OUTPUT_AS_DRAWING
static final int OUTPUT_AS_CUSTOM
static final int OUTPUT_AS_IMAGE_WITH_MAP
static final int OUTPUT_AS_UNKNOWN
void init(IReportItemPresentationInfo info)
info
- Presentation info of report itemvoid setModelObject(ExtendedItemHandle modelHandle)
modelHandle
- a handle to the extended item model objectvoid setApplicationClassLoader(java.lang.ClassLoader loader)
loader
- class loader used to load the classesvoid setScriptContext(IReportContext context)
context
- report context used by java-based scriptvoid setReportQueries(IDataQueryDefinition[] queries)
void setLocale(java.util.Locale locale)
locale
- localevoid setResolution(int dpi)
dpi
- the dpi of the rendering environmentvoid setOutputFormat(java.lang.String outputFormat)
outputFormat
- the output format, i.e., html, pdf, etc.void setActionHandler(IHTMLActionHandler ah)
ah
- the HTML action handler used to create a URL based on an actionjava.lang.String getImageMIMEType()
void setSupportedImageFormats(java.lang.String supportedImageFormats)
supportedImageFormats
- the image formats that the presentation engine could support.void deserialize(java.io.InputStream istream)
istream
- the input stream to deserialize generation time state fromint getOutputType()
mimeType
- an out parameter that returns the MIME type of the outputjava.lang.Object onRowSets(IRowSet[] rowSets) throws BirtException
rowSets
- rowSets an array of row sets that is passed to the extensionBirtException
- throws exception when there is a problem processing the
extended itemjava.lang.Object onRowSets(IBaseResultSet[] results) throws BirtException
results
- results is an array of query results which is passed to the
extended item. The extended item could retrieve data from
those results.BirtException
- Throws exception when there is a problem processing the
extended itemSize getSize()
void finish()
void setDynamicStyle(IStyle style)
void setExtendedItemContent(IContent content)
content
- content which is transformed from extended item.IReportItemPresentationInfo getPresentationConfig()
boolean isCacheable()
Copyright © 2014 OpenText Corp. All rights reserved.