Package org.pentaho.reporting.engine.classic.core.event

Interface PageEventListener

All Superinterfaces:

EventListener

All Known Implementing Classes:

AbstractElementFormatFunction, AttributeExpressionsEvaluator, CellFormatFunction, CreateHyperLinksFunction, DefaultOutputFunction, ElementColorFunction, ElementTrafficLightFunction, ElementVisibilityFunction, ElementVisibilitySwitchFunction, EventMonitorFunction, HideElementByNameFunction, HideElementIfDataAvailableExpression, HideNullValuesFunction, ItemHideFunction, MetaDataStyleEvaluator, NegativeNumberPaintChangeFunction, PageFunction, PageItemCountFunction, PageItemSumFunction, PageOfPagesFunction, PageTotalFunction, PaintDynamicComponentFunction, RowBandingFunction, SheetNameFunction, ShowElementByNameFunction, ShowElementIfDataAvailableExpression, StyleExpressionsEvaluator, StyleResolvingEvaluator, TotalPageItemCountFunction, TotalPageSumFunction, WizardItemHideFunction

public interface PageEventListener
extends EventListener

The PageEventListener gets informed of PageEvents.

This is an extracted interface of the original ReportEventListener. As page events are only fired by some (page sensitive) report processors, there is no need to support page events in the ReportEventListener interface.

Functions that should be informed of page events should implement this interface.

Information: The pageCanceled method is called, if a empty page was created and was removed from the report afterwards.

Author:

Thomas Morgner

Method Summary

Modifier and Type	Method	Description
void	pageFinished(ReportEvent event)	Receives notification that a page is completed.
void	pageStarted(ReportEvent event)	Receives notification that a new page is being started.

Method Detail

pageStarted

void pageStarted(ReportEvent event)

Receives notification that a new page is being started.

Parameters:

event - The event.

pageFinished

void pageFinished(ReportEvent event)

Receives notification that a page is completed.

Parameters:

event - The event.