|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pentaho.reporting.engine.classic.core.function.AbstractExpression
org.pentaho.reporting.engine.classic.core.function.AbstractFunction
org.pentaho.reporting.engine.classic.core.function.PageFunction
org.pentaho.reporting.engine.classic.core.function.PageTotalFunction
public class PageTotalFunction
Prints the total number of pages of an report. If a group is specified, this function expects the group to have the manual pagebreak enabled.
This function will only work as expected in group mode if the named group has pagebreak-before set to true on the header for pagebreak-after set to true on the group's footer.
Constructor Summary | |
---|---|
PageTotalFunction()
Creates a new page total function. |
Method Summary | |
---|---|
Expression |
getInstance()
Return a completly separated copy of this function. |
Object |
getValue()
Returns the page number (function value). |
void |
groupFinished(ReportEvent event)
Receives notification that a group has finished. |
void |
groupStarted(ReportEvent event)
Receives notification that a group has started. |
void |
pageFinished(ReportEvent event)
Receives notification that a page is completed. |
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 the report has started. |
Methods inherited from class org.pentaho.reporting.engine.classic.core.function.PageFunction |
---|
getDependencyLevel, getGroup, getPage, getPageIncrement, getStartPage, isDeepTraversing, pageStarted, setDependencyLevel, setGroup, setIgnorePageCancelEvents, setPageIncrement, setStartPage |
Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractFunction |
---|
itemsAdvanced, itemsFinished, itemsStarted, reportFinished, reportStarted |
Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractExpression |
---|
clone, getDataRow, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isPreserve, setActive, setName, setPreserve, setRuntime |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.pentaho.reporting.engine.classic.core.function.Expression |
---|
clone, getDataRow, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isPreserve, setName, setRuntime |
Constructor Detail |
---|
public PageTotalFunction()
Method Detail |
---|
public void reportInitialized(ReportEvent event)
reportInitialized
in interface ReportListener
reportInitialized
in class PageFunction
event
- the event.public void groupStarted(ReportEvent event)
PageFunction
groupStarted
in interface ReportListener
groupStarted
in class PageFunction
event
- the event.public void groupFinished(ReportEvent event)
AbstractFunction
groupFinished
in interface ReportListener
groupFinished
in class AbstractFunction
event
- the event.public void pageFinished(ReportEvent event)
PageFunction
pageFinished
in interface PageEventListener
pageFinished
in class PageFunction
event
- The event.public void reportDone(ReportEvent event)
AbstractFunction
reportDone
in interface ReportListener
reportDone
in class AbstractFunction
event
- The event.public Expression getInstance()
getInstance
in interface Expression
getInstance
in class AbstractExpression
public Object getValue()
PageFunction
getValue
in interface Expression
getValue
in class PageFunction
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |