org.eclipse.birt.report.engine.extension
Interface IReportItemPresentation

public interface IReportItemPresentation

Represents the extended item presentation time extension. The calling sequence in presentation engine might work as follows:

Design engine creates a new instance of the extended item.

Presentation engine detects that the element is an extended item. It dynamically creates an object with type IReportItemPresentation.

The presentation engine calls various setXXX methods to pass initialization parameters to the extension implementation.

deserialize method restores the generation time state

Render the extended item through onRowSets method, handled the returned image

Call finish() for cleanup.

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

OUTPUT_NONE

public static final int OUTPUT_NONE

See Also:

Constant Field Values

OUTPUT_AS_IMAGE

public static final int OUTPUT_AS_IMAGE

See Also:

Constant Field Values

OUTPUT_AS_TEXT

public static final int OUTPUT_AS_TEXT

See Also:

Constant Field Values

OUTPUT_AS_HTML_TEXT

public static final int OUTPUT_AS_HTML_TEXT

See Also:

Constant Field Values

OUTPUT_AS_DRAWING

public static final int OUTPUT_AS_DRAWING

See Also:

Constant Field Values

OUTPUT_AS_CUSTOM

public static final int OUTPUT_AS_CUSTOM

See Also:

Constant Field Values

OUTPUT_AS_IMAGE_WITH_MAP

public static final int OUTPUT_AS_IMAGE_WITH_MAP

See Also:

Constant Field Values

Method Detail

setModelObject

public void setModelObject(org.eclipse.birt.report.model.api.ExtendedItemHandle modelHandle)

passes a handle to the extended report item model to the extension

Parameters:

modelHandle - a handle to the extended item model object

setApplicationClassLoader

public void setApplicationClassLoader(java.lang.ClassLoader loader)

passes the class loader used to load user defined classes.

Parameters:

loader - class loader used to load the classes

setScriptContext

public void setScriptContext(org.eclipse.birt.report.engine.api.script.IReportContext context)

pass the script context to the report item.

Parameters:

context - report context used by java-based script

setReportQueries

public 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.

setLocale

public void setLocale(java.util.Locale locale)

passes the locale used in the presentation.

Parameters:

locale - locale

setResolution

public void setResolution(int dpi)

passes the dpi (dot per inch) from the rendering environment to the extension. Mostly used for printing.

Parameters:

dpi - the dpi of the rendering environment

setOutputFormat

public void setOutputFormat(java.lang.String outputFormat)

sets the output format, i.e., HTML, PDF, etc.

Parameters:

outputFormat - the output format, i.e., html, pdf, etc.

setActionHandler

public void setActionHandler(IHTMLActionHandler ah)

Parameters:

ah - the HTML action handler used to create a URL based on an action

getImageMIMEType

public java.lang.String getImageMIMEType()

Returns:

the image MIME type (e.g. "image/svg+xml")

setSupportedImageFormats

public void setSupportedImageFormats(java.lang.String supportedImageFormats)

sets the image formats that are supported for this output format. Formats are separated by semi-colon. For example, the argument could be JPG;PNG;BMP;SVG

Parameters:

supportedImageFormats - the image formats that the presentation engine could support.

deserialize

public void deserialize(java.io.InputStream istream)

deserializes generation time state information about the extended item

Parameters:

istream - the input stream to deserialize generation time state from

getOutputType

public int getOutputType()

returns the output type, which could be IMAGE, TEXT, HTML TEXT, DRAWING, etc. For now, only Image is supported.

Returns:

output type, for now OUTPUT_AS_IMAGE only

onRowSets

public java.lang.Object onRowSets(IRowSet[] rowSets)
                           throws org.eclipse.birt.core.exception.BirtException

processes the extended item in report presentation environment.

Parameters:

rowSets - rowSets an array of row sets that is passed to the extension

Returns:

the returned value could be different depending on the type of the output. For image, returns an input stream or byte array that the engine could retrieve data from

Throws:

org.eclipse.birt.core.exception.BirtException - throws exception when there is a problem processing the extended item

getSize

public org.eclipse.birt.report.engine.extension.Size getSize()

Get the size of the extended item. The size is a Dimension object. The width and height can only be in absolute units (inch, mm, etc.) or pixel. It can not be a relative size such as 150% or 1.2em. Notice that an extended item can obtain its design-time size information by querying DE. This function is needed because the actual size may not be the same as the design-time size.

Returns:

the size of the extended item. Return null if the size does not matter or can not be determined.

finish

public void finish()

Performs clean up work

setDynamicStyle

public void setDynamicStyle(IStyle style)

Set dynamic style.