Class TriggerComplexPageFooterFunction

  • All Implemented Interfaces:
    Serializable, Cloneable, EventListener, org.pentaho.reporting.engine.classic.core.event.ReportListener, org.pentaho.reporting.engine.classic.core.function.Expression, org.pentaho.reporting.engine.classic.core.function.Function

    public class TriggerComplexPageFooterFunction
    extends org.pentaho.reporting.engine.classic.core.function.AbstractFunction
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Object getValue()
      Return the current expression value.
      void reportDone​(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)
      Receives notification that report generation has completed, the report footer was printed, no more output is done.
      void reportInitialized​(org.pentaho.reporting.engine.classic.core.event.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 interface org.pentaho.reporting.engine.classic.core.function.Expression

        clone, getDataRow, getDependencyLevel, getInstance, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setDependencyLevel, setName, setRuntime
    • Constructor Detail

      • TriggerComplexPageFooterFunction

        public TriggerComplexPageFooterFunction()
        Creates an unnamed function. Make sure the name of the function is set using AbstractExpression.setName(java.lang.String) before the function is added to the report's function collection.
    • Method Detail

      • reportDone

        public void reportDone​(org.pentaho.reporting.engine.classic.core.event.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 org.pentaho.reporting.engine.classic.core.event.ReportListener
        Overrides:
        reportDone in class org.pentaho.reporting.engine.classic.core.function.AbstractFunction
        Parameters:
        event - The event.
      • reportInitialized

        public void reportInitialized​(org.pentaho.reporting.engine.classic.core.event.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 org.pentaho.reporting.engine.classic.core.event.ReportListener
        Overrides:
        reportInitialized in class org.pentaho.reporting.engine.classic.core.function.AbstractFunction
        Parameters:
        event - The event.
      • getValue

        public Object getValue()
        Return the current expression value.

        The value depends (obviously) on the expression implementation.

        Returns:
        the value of the function.