|
||||||||||
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.PageOfPagesFunction
public class PageOfPagesFunction
A report function that combines PageFunction
and PageTotalFunction
. Restrictions for both classes
apply to this one also.
Constructor Summary | |
---|---|
PageOfPagesFunction()
Default Constructor. |
|
PageOfPagesFunction(String name)
Constructs a named function. |
Method Summary | |
---|---|
Object |
clone()
Creates a copy of the function. |
int |
getDependencyLevel()
Returns the defined dependency level. |
String |
getFormat()
Returns the format used to print the value. |
Expression |
getInstance()
Return a completly separated copy of this function. |
Object |
getValue()
Return the value of this Function . |
void |
groupFinished(ReportEvent event)
Receives notification that a group has finished. |
void |
groupStarted(ReportEvent event)
Forwards the report event to both the base class and the page-total function delegate. |
void |
pageFinished(ReportEvent event)
Forwards the report event to both the base class and the page-total function delegate. |
void |
pageStarted(ReportEvent event)
Forwards the report event to both the base class and the page-total function delegate. |
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)
Forwards the report event to both the base class and the page-total function delegate. |
void |
setDependencyLevel(int level)
Defines the defined dependency level. |
void |
setFormat(String format)
Set the format of the value. |
void |
setGroup(String group)
Sets the name of the group that the function acts upon. |
void |
setRuntime(ExpressionRuntime runtime)
Defines the ExpressionRune used in this expression. |
void |
setStartPage(int startPage)
Defines the page number where the counting starts. |
Methods inherited from class org.pentaho.reporting.engine.classic.core.function.PageFunction |
---|
getGroup, getPage, getPageIncrement, getStartPage, isDeepTraversing, setIgnorePageCancelEvents, setPageIncrement |
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 |
---|
getDataRow, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isPreserve, setActive, setName, setPreserve |
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 |
---|
getDataRow, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isPreserve, setName |
Constructor Detail |
---|
public PageOfPagesFunction()
public PageOfPagesFunction(String name)
name
- the function name.Method Detail |
---|
public String getFormat()
MessageFormat
public void setFormat(String format)
MessageFormat
. The first parameter is
filled with the current page, the second with the total number of pages.
format
- the format string.public void reportInitialized(ReportEvent event)
reportInitialized
in interface ReportListener
reportInitialized
in class PageFunction
event
- the received report event.public void pageStarted(ReportEvent event)
pageStarted
in interface PageEventListener
pageStarted
in class PageFunction
event
- the received report event.public void pageFinished(ReportEvent event)
pageFinished
in interface PageEventListener
pageFinished
in class PageFunction
event
- the received report event.public void groupStarted(ReportEvent event)
groupStarted
in interface ReportListener
groupStarted
in class PageFunction
event
- the received report event.public void groupFinished(ReportEvent event)
AbstractFunction
groupFinished
in interface ReportListener
groupFinished
in class AbstractFunction
event
- the event.public void reportDone(ReportEvent event)
reportDone
in interface ReportListener
reportDone
in class AbstractFunction
event
- The event.public Object getValue()
Function
. The method uses the format definition from the properties and adds the
current page and the total number of pages as parameter.
getValue
in interface Expression
getValue
in class PageFunction
public void setGroup(String group)
setGroup
in class PageFunction
group
- the group name.public void setStartPage(int startPage)
setStartPage
in class PageFunction
startPage
- the page number of the first page.public void setDependencyLevel(int level)
setDependencyLevel
in interface Expression
setDependencyLevel
in class PageFunction
level
- the dependency level.public int getDependencyLevel()
getDependencyLevel
in interface Expression
getDependencyLevel
in class PageFunction
public Expression getInstance()
getInstance
in interface Expression
getInstance
in class AbstractExpression
public void setRuntime(ExpressionRuntime runtime)
setRuntime
in interface Expression
setRuntime
in class AbstractExpression
runtime
- the runtime information for the expressionpublic Object clone() throws CloneNotSupportedException
clone
in interface Expression
clone
in class AbstractExpression
CloneNotSupportedException
- if an error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |