public abstract class AbstractElementFormatFunction extends AbstractFunction implements PageEventListener, LayoutProcessorFunction
processRootBand(org.pentaho.reporting.engine.classic.core.Section)
method.Modifier and Type | Method and Description |
---|---|
int |
getDependencyLevel()
Returns the dependency level for the expression (controls evaluation order for expressions and functions).
|
String |
getElement()
Returns the element name.
|
AbstractElementFormatFunction |
getInstance()
Return a completly separated copy of this function.
|
Object |
getValue()
Format-Functions usually are not expected to return anything.
|
void |
groupFinished(ReportEvent event)
Processes the group footer of the current group.
|
void |
groupStarted(ReportEvent event)
Processes the group header of the current group.
|
void |
itemsAdvanced(ReportEvent event)
Processes the ItemBand.
|
void |
itemsFinished(ReportEvent event)
Receives notification that a group of item bands has been completed.
|
void |
itemsStarted(ReportEvent event)
Processes the No-Data-Band.
|
void |
pageFinished(ReportEvent event)
Processes the page footer.
|
void |
pageStarted(ReportEvent event)
Processes the page header.
|
void |
reportDone(ReportEvent event)
Receives notification that report generation has completed, the report footer was printed, no more output is done.
|
void |
reportFinished(ReportEvent event)
Processes the Report-Footer.
|
void |
reportInitialized(ReportEvent event)
Receives notification that report generation initializes the current run.
|
void |
reportStarted(ReportEvent event)
Processes the Report-Header.
|
void |
setElement(String name)
Sets the element name.
|
summaryRowSelection
clone, getDataRow, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setActive, setDependencyLevel, setName, setPreserve, setRuntime
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
summaryRowSelection
clone, getDataRow, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setDependencyLevel, setName, setRuntime
public void setElement(String name)
name
- The element name.org.pentaho.reporting.engine.classic.core.function.FunctionUtilities#findAllElements(org.pentaho.reporting
.engine.classic.core.Band, String)
public String getElement()
setElement(String)
public void reportInitialized(ReportEvent event)
The event carries a ReportState.Started state. Use this to initialize the report.
reportInitialized
in interface ReportListener
reportInitialized
in class AbstractFunction
event
- The event.public void reportStarted(ReportEvent event)
reportStarted
in interface ReportListener
reportStarted
in class AbstractFunction
event
- the event.public void groupStarted(ReportEvent event)
groupStarted
in interface ReportListener
groupStarted
in class AbstractFunction
event
- the event.public void itemsStarted(ReportEvent event)
itemsStarted
in interface ReportListener
itemsStarted
in class AbstractFunction
event
- the report event.public void itemsAdvanced(ReportEvent event)
itemsAdvanced
in interface ReportListener
itemsAdvanced
in class AbstractFunction
event
- the event.public void itemsFinished(ReportEvent event)
The itemBand is finished, the report starts to close open groups.
itemsFinished
in interface ReportListener
itemsFinished
in class AbstractFunction
event
- The event.public void groupFinished(ReportEvent event)
groupFinished
in interface ReportListener
groupFinished
in class AbstractFunction
event
- the event.public void reportFinished(ReportEvent event)
reportFinished
in interface ReportListener
reportFinished
in class AbstractFunction
event
- the event.public void reportDone(ReportEvent event)
AbstractFunction
reportDone
in interface ReportListener
reportDone
in class AbstractFunction
event
- The event.public void pageFinished(ReportEvent event)
pageFinished
in interface PageEventListener
event
- the event.public void pageStarted(ReportEvent event)
pageStarted
in interface PageEventListener
event
- the event.public Object getValue()
getValue
in interface Expression
public final int getDependencyLevel()
AbstractExpression
getDependencyLevel
in interface Expression
getDependencyLevel
in class AbstractExpression
public AbstractElementFormatFunction getInstance()
AbstractExpression
getInstance
in interface Expression
getInstance
in class AbstractExpression