|
||||||||||
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
public class PageFunction
A report function that counts pages. This method is only useable when a report processor is used, which generated PageEvents. The PageableReportProcessor is one of them.
As with all page dependent functions: The function will only be active, when the page events get fired, this usually only happens during the last pagination run and the printing. The function level will be negative when this happens.
Constructor Summary | |
---|---|
PageFunction()
Constructs an unnamed function. |
|
PageFunction(String name)
Constructs a named function. |
Method Summary | |
---|---|
int |
getDependencyLevel()
Returns the defined dependency level. |
String |
getGroup()
Returns the group name. |
int |
getPage()
Returns the current page. |
int |
getPageIncrement()
Returns the page increment. |
int |
getStartPage()
Returns the page number where the counting starts. |
Object |
getValue()
Returns the page number (function value). |
void |
groupStarted(ReportEvent event)
Receives notification that a group has started. |
boolean |
isDeepTraversing()
Checks whether this expression is a deep-traversing expression. |
void |
pageFinished(ReportEvent event)
Receives notification that a page is completed. |
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. |
void |
setDependencyLevel(int dependencyLevel)
Defines the defined dependency level. |
void |
setGroup(String group)
Sets the name of the group that the function acts upon. |
void |
setIgnorePageCancelEvents(boolean ignorePageCancelEvents)
Deprecated. No longer used. |
void |
setPageIncrement(int pageIncrement)
Defines the page increment. |
void |
setStartPage(int startPage)
Defines the page number where the counting starts. |
Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractFunction |
---|
groupFinished, itemsAdvanced, itemsFinished, itemsStarted, reportDone, reportFinished, reportStarted |
Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractExpression |
---|
clone, getDataRow, getInstance, 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, getInstance, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isPreserve, setName, setRuntime |
Constructor Detail |
---|
public PageFunction()
This constructor is intended for use by the SAX handler class only.
public PageFunction(String name)
name
- the function name.Method Detail |
---|
public boolean isDeepTraversing()
isDeepTraversing
in interface Expression
isDeepTraversing
in class AbstractExpression
public int getDependencyLevel()
getDependencyLevel
in interface Expression
getDependencyLevel
in class AbstractExpression
public void setDependencyLevel(int dependencyLevel)
setDependencyLevel
in interface Expression
setDependencyLevel
in class AbstractExpression
dependencyLevel
- the dependency level.public int getPageIncrement()
public void setPageIncrement(int pageIncrement)
pageIncrement
- the page increment.public String getGroup()
public void setGroup(String group)
group
- the group name.public int getStartPage()
public void setStartPage(int startPage)
startPage
- the page number of the first page.public int getPage()
public void reportInitialized(ReportEvent event)
reportInitialized
in interface ReportListener
reportInitialized
in class AbstractFunction
event
- the event.public void groupStarted(ReportEvent event)
groupStarted
in interface ReportListener
groupStarted
in class AbstractFunction
event
- the event.public void pageStarted(ReportEvent event)
pageStarted
in interface PageEventListener
event
- the event.public void pageFinished(ReportEvent event)
pageFinished
in interface PageEventListener
event
- The event.public Object getValue()
getValue
in interface Expression
public void setIgnorePageCancelEvents(boolean ignorePageCancelEvents)
ignorePageCancelEvents
- ignored.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |