|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jrefinery.report.function.AbstractFunction
com.jrefinery.report.function.PageFunction
com.jrefinery.report.function.PageTotalFunction
This function will only work as expected in group mode if the named group has pagebreak set to true. This function depends on pageEvents, so use it with PageableProcessor only. FunctionFlow: if autmatic pagebreak: fireGroupFinish -> PageFull, group footer cannot be printed yet firePageFinish -> groupFooter is printed fireGroupStarted firePageFinish // manual pagebreak -> groupHeader is printed if manual pagebreak only fireGroupFinish -> print GroupFooter fireGroupStarted firePageFinish // manual pagebreak -> groupHeader is printed
Field Summary |
Fields inherited from interface com.jrefinery.report.function.Expression |
AUTOACTIVATE_PROPERTY |
Constructor Summary | |
PageTotalFunction()
Creates a new page total function. |
Method Summary | |
Expression |
getInstance()
Return a completly separated copy of this function. |
protected int |
getPage()
Returns the page number. |
java.lang.Object |
getValue()
Returns the page number (function value). |
void |
groupStarted(ReportEvent event)
Receives notification that a group has started. |
void |
initialize()
Checks that the function has been correctly initialized. |
void |
pageStarted(ReportEvent event)
Receives notification from the report engine that a new page is starting. |
void |
reportInitialized(ReportEvent event)
Receives notification that the report has started. |
protected void |
setPage(int page)
Sets the page number. |
Methods inherited from class com.jrefinery.report.function.PageFunction |
getGroup, getStartPage, isIgnorePageCancelEvents, pageCanceled, setGroup |
Methods inherited from class com.jrefinery.report.function.AbstractFunction |
clone, getDataRow, getDependencyLevel, getName, getProperties, getProperty, getProperty, groupFinished, isActive, itemsAdvanced, itemsFinished, itemsStarted, pageFinished, reportDone, reportFinished, reportStarted, setDataRow, setDependencyLevel, setName, setProperties, setProperty |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.jrefinery.report.event.PageEventListener |
pageFinished |
Constructor Detail |
public PageTotalFunction()
Method Detail |
public void reportInitialized(ReportEvent event)
reportInitialized
in interface ReportListener
reportInitialized
in class PageFunction
event
- the event.public void pageStarted(ReportEvent event)
Prepared data is bound to the display item, the current displayed row.
pageStarted
in interface PageEventListener
pageStarted
in class PageFunction
event
- Information about the event.public void groupStarted(ReportEvent event)
If no group is specified for the function, then the event is ignored.
groupStarted
in interface ReportListener
groupStarted
in class PageFunction
event
- the event.protected void setPage(int page)
setPage
in class PageFunction
page
- the page number.protected int getPage()
getPage
in class PageFunction
public java.lang.Object getValue()
getValue
in interface Expression
getValue
in class PageFunction
public void initialize() throws FunctionInitializeException
initialize
in interface Expression
initialize
in class PageFunction
FunctionInitializeException
- if the function name is not set or the call to
isInitialized returns false.public Expression getInstance()
getInstance
in interface Expression
getInstance
in class AbstractFunction
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |