Interface FillContext
-
- All Superinterfaces:
JRFillExpressionEvaluator
- All Known Implementing Classes:
JRFillComponentElement
public interface FillContext extends JRFillExpressionEvaluator
A fill context provides access to data and functionality related to a report component fill.- Author:
- Lucian Chirita (lucianc@users.sourceforge.net)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Object
evaluate(JRExpression expression, byte evaluation)
Evaluates an expression in the main report dataset.JRComponentElement
getComponentElement()
Returns the component element that wraps the component.JRDefaultStyleProvider
getDefaultStyleProvider()
Returns the default style provider for the generated report.JROrigin
getElementOrigin()
Returns the origin of the current component element.int
getElementPrintY()
Returns the position on the vertical axis where the component element starts printing.int
getElementSourceId()
Returns the fill element Id associated to the component element.JRStyle
getElementStyle()
Returns the current style of the component element.FillContainerContext
getFillContainerContext()
JRBaseFiller
getFiller()
Returns the filler object.PrintElementOriginator
getPrintElementOriginator()
Returns a generator for print Ids for the component element.Locale
getReportLocale()
Returns the locale used to fill the current report.ResourceBundle
getReportResourceBundle()
Returns the resource bundle used for the current report.TimeZone
getReportTimezone()
Returns the time zone used to fill the current report.void
registerDelayedEvaluation(JRPrintElement printElement, EvaluationTimeEnum evaluationTime, String evaluationGroup)
Registers a delayed evaluation for a print element.-
Methods inherited from interface net.sf.jasperreports.engine.fill.JRFillExpressionEvaluator
getFillDataset
-
-
-
-
Method Detail
-
getComponentElement
JRComponentElement getComponentElement()
Returns the component element that wraps the component.- Returns:
- the current component element
-
getElementSourceId
int getElementSourceId()
Returns the fill element Id associated to the component element.- Returns:
- the Id of the component fill element
- See Also:
JRPrintElement.getSourceElementId()
,getPrintElementOriginator()
-
getPrintElementOriginator
PrintElementOriginator getPrintElementOriginator()
Returns a generator for print Ids for the component element.- Returns:
- a generator for print Ids
- See Also:
JRPrintElement.getSourceElementId()
,JRPrintElement.getPrintElementId()
-
evaluate
Object evaluate(JRExpression expression, byte evaluation) throws JRException
Evaluates an expression in the main report dataset.- Specified by:
evaluate
in interfaceJRFillExpressionEvaluator
- Parameters:
expression
- the expression to evaluateevaluation
- the evaluation type; usually directly passed fromFillComponent.evaluate(byte)
- Returns:
- the result of the evaluation
- Throws:
JRException
-
getDefaultStyleProvider
JRDefaultStyleProvider getDefaultStyleProvider()
Returns the default style provider for the generated report.- Returns:
- the default style provider of the generated report
-
getElementOrigin
JROrigin getElementOrigin()
Returns the origin of the current component element.- Returns:
- the origin of the component element
-
getElementPrintY
int getElementPrintY()
Returns the position on the vertical axis where the component element starts printing.- Returns:
- the position on the vertical axis of the component element
-
getElementStyle
JRStyle getElementStyle()
Returns the current style of the component element.- Returns:
- the current style of the component element
-
registerDelayedEvaluation
void registerDelayedEvaluation(JRPrintElement printElement, EvaluationTimeEnum evaluationTime, String evaluationGroup)
Registers a delayed evaluation for a print element.- Parameters:
printElement
- the print elementevaluationTime
- the delayed evaluation time; one ofevaluationGroup
- the evaluation group name, ifevaluationTime
isEvaluationTimeEnum.GROUP
- See Also:
FillComponent.evaluateDelayedElement(JRPrintElement, byte)
-
getReportResourceBundle
ResourceBundle getReportResourceBundle()
Returns the resource bundle used for the current report.- Returns:
- the report resource bundle
- See Also:
JRReport.getResourceBundle()
,JRParameter.REPORT_RESOURCE_BUNDLE
-
getReportLocale
Locale getReportLocale()
Returns the locale used to fill the current report.- Returns:
- the report locale
- See Also:
JRParameter.REPORT_LOCALE
-
getReportTimezone
TimeZone getReportTimezone()
Returns the time zone used to fill the current report.- Returns:
- the report time zone
- See Also:
JRParameter.REPORT_TIME_ZONE
-
getFiller
JRBaseFiller getFiller()
Returns the filler object.- Returns:
- the filler object
-
getFillContainerContext
FillContainerContext getFillContainerContext()
-
-