Save This Page
Home » pentaho-reporting-engine-classic-0.8.10 » org » jfree » report » event » [javadoc | source]
org.jfree.report.event
public interface: ReportListener [javadoc | source]

All Implemented Interfaces:
    EventListener

All Known Implementing Classes:
    PaintDynamicComponentFunction, HideArticleDetailsFunction, ItemSumFunction, ShowElementByNameFunction, AttributeExpressionsEvaluator, ElementTrafficLightFunction, TriggerTypeFunction, HidePageBandForTableExportFunction, ItemMinFunction, CellFormatFunction, ElementColorFunction, DataSchemaFormatFunction, PageFunction, SimplePageLayoutDelegate, PaintComponentFunction, CSVWriter, HideElementIfDataAvailableExpression, AbstractElementFormatFunction, ItemMaxFunction, MetaDataStyleEvaluator, FlowPageLayouter, EventMonitorFunction, XMLWriter, SelectCardFunction, TotalGroupSumQuotientPercentFunction, StructureFunction, TriggerPageFooterFunction, GroupCountFunction, TotalPageItemCountFunction, ItemPercentageFunction, TotalItemCountFunction, SimplePageLayouter, TriggerNestedGroupFunction, TriggerComplexPageFooterFunction, ShowElementIfDataAvailableExpression, TotalGroupCountFunction, FormulaFunction, PageLayouter, TotalCalculationFunction, TotalGroupSumFunction, Function, TotalItemMaxFunction, TotalGroupSumQuotientFunction, FontChangeFunction, HideNullValuesFunction, CountDistinctFunction, HideElementByNameFunction, LayoutProcessorFunction, ItemCountFunction, TotalItemMinFunction, StyleExpressionsEvaluator, PageItemSumFunction, DefaultOutputFunction, NettoProfitFunction, SheetNameFunction, ItemHideFunction, PageTotalFunction, ElementVisibilitySwitchFunction, AbstractFunction, PageItemCountFunction, TableWriter, NegativeNumberPaintChangeFunction, ItemAvgFunction, LevelledExpressionList, CreateHyperLinksFunction, ElementVisibilityFunction, SingleValueQueryFunction, ImageRenderFunction, CreateGroupAnchorsFunction, PageOfPagesFunction, OutputFunction, ConditionalItemSumFunction, RowBandingFunction

ReportListeners get informed whenever the state of a report changes.

You should be aware that most events occur more than once. For example, the reportStarted event will be triggered every time the report is regenerated.

When handling these events, use the reportState to track the current changes of the report.

Method from org.jfree.report.event.ReportListener Summary:
groupFinished,   groupStarted,   itemsAdvanced,   itemsFinished,   itemsStarted,   reportDone,   reportFinished,   reportInitialized,   reportStarted
Method from org.jfree.report.event.ReportListener Detail:
 public  void groupFinished(ReportEvent event)
    Receives notification that a group is finished. 
     The group can be determined by
the report state's getCurrentGroup() function.
 public  void groupStarted(ReportEvent event)
    Receives notification that a new group has started. 
     The group can be determined
by the report state's getCurrentGroup() function.
 public  void itemsAdvanced(ReportEvent event)
    Receives notification that a new row has been read. 
     This event is raised before
an ItemBand is printed.
 public  void itemsFinished(ReportEvent event)
    Receives notification that a group of item bands has been completed. 
     The itemBand
is finished, the report starts to close open groups.
 public  void itemsStarted(ReportEvent event)
    Receives notification that a group of item bands is about to be processed. 
     The
next events will be itemsAdvanced events until the itemsFinished event is raised.
 public  void reportDone(ReportEvent event)
    Receives notification that report generation has completed, the report footer was
printed, no more output is done. This is a helper event to shut down the output
service.
 public  void reportFinished(ReportEvent event)
    Receives notification that report generation has finished (the last record is read
and all groups are closed).
 public  void reportInitialized(ReportEvent event)
    Receives notification that report generation initializes the current run. 
     The
event carries a ReportState.Started state. Use this to initialize the report.
 public  void reportStarted(ReportEvent event)
    Receives notification that report generation has started. 
     The event carries a
ReportState.Started state. Use this to prepare the report header.