TriggerPageFooterFunction (classic-core 9.3.0.0-424 API)

java.lang.Object
- org.pentaho.reporting.engine.classic.core.function.AbstractExpression
- - org.pentaho.reporting.engine.classic.core.function.AbstractFunction
  - - org.pentaho.reporting.engine.classic.core.function.TriggerPageFooterFunction

All Implemented Interfaces:

Serializable, Cloneable, EventListener, ReportListener, Expression, Function, LayoutProcessorFunction
```
public class TriggerPageFooterFunction
extends AbstractFunction
implements LayoutProcessorFunction
```
This function enables a "PageFooter only on last page" functionality.

Author:

Thomas Morgner

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

TriggerPageFooterFunction()
Creates a new TriggerPageFooterFunction with no name.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Object`	`getValue()`	This method returns nothing.
`void`	`reportDone(ReportEvent event)`	Receives notification that report generation has completed, the report footer was printed, no more output is done.
`void`	`reportInitialized(ReportEvent event)`	Receives notification that report generation initializes the current run.

Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractFunction
groupFinished, groupStarted, itemsAdvanced, itemsFinished, itemsStarted, reportFinished, reportStarted, summaryRowSelection

Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractExpression
clone, getDataRow, getDependencyLevel, getInstance, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setActive, setDependencyLevel, setName, setPreserve, setRuntime

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.pentaho.reporting.engine.classic.core.function.Expression
clone, getDataRow, getDependencyLevel, getInstance, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setDependencyLevel, setName, setRuntime

Methods inherited from interface org.pentaho.reporting.engine.classic.core.event.ReportListener
groupFinished, groupStarted, itemsAdvanced, itemsFinished, itemsStarted, reportFinished, reportStarted, summaryRowSelection

- Constructor Detail
  - TriggerPageFooterFunction
```
public TriggerPageFooterFunction()
```
    Creates a new TriggerPageFooterFunction with no name. You have to define one using "setName" or the function will not work.
- Method Detail
  - reportInitialized
```
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.
    
    Specified by:
    
    reportInitialized in interface ReportListener
    
    Overrides:
    
    reportInitialized in class AbstractFunction
    
    Parameters:
    
    event - The event.
  - reportDone
```
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.
    
    Specified by:
    
    reportDone in interface ReportListener
    
    Overrides:
    
    reportDone in class AbstractFunction
    
    Parameters:
    
    event - The event.
  - getValue
```
public Object getValue()
```
    This method returns nothing.
    
    Specified by:
    
    getValue in interface Expression
    
    Returns:
    
    the value of the function.