Package com.nomagic.magicreport.engine

Interface IReferenceInsertionHandler

All Known Implementing Classes:

InsertionHandler

@OpenApiAll
public interface IReferenceInsertionHandler

Reference 'Stream insertion' event handler. Called with object that will be inserted into stream via value.toString().

Since:

February 13, 2008

Method Summary

Modifier and Type	Method	Description
Object	referenceInsert(String reference, Object value, Properties properties)	A call-back which is executed during template merge before a reference value is inserted into the output stream.

Method Details

referenceInsert

Object referenceInsert(String reference,
 Object value,
 Properties properties)

A call-back which is executed during template merge before a reference value is inserted into the output stream. All registered IReferenceInsertionHandler are called in sequence. If no IReferenceInsertionHandler are are registered then reference value is inserted into the output stream as is.

Parameters:

reference - Reference from template about to be inserted.

value - Value about to be inserted (after its toString() method is called).

properties - the engine properties

Returns:

Object on which toString() should be called for output.