|
||||||||||
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.CreateGroupAnchorsFunction
public class CreateGroupAnchorsFunction
Creates anchor objects for the current group. The anchors generated consist of the group's name and the current group count.
To use the CreateGroupAnchorsFunction set the group's name as the function's group-property value. Next, add a AnchorElement to where the anchor should be generated (usually either the group-header or footer) and give the function's name as fieldname in the anchor-field.
Constructor Summary | |
---|---|
CreateGroupAnchorsFunction()
Deprecated. Default Constructor. |
Method Summary | |
---|---|
String |
getAnchorPrefix()
Deprecated. Returns the prefix for the generated anchor. |
String |
getGroup()
Deprecated. Returns the name of the group for which an anchor should be generated. |
Object |
getValue()
Deprecated. Return the current expression value. |
void |
groupStarted(ReportEvent event)
Deprecated. Receives notification that a group has started. |
void |
reportInitialized(ReportEvent event)
Deprecated. Receives notification that report generation initializes the current run. |
void |
setAnchorPrefix(String anchorPrefix)
Deprecated. Defines the prefix for the generated anchor. |
void |
setGroup(String group)
Deprecated. Defines the name of the group for which an anchor should be generated. |
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, getDependencyLevel, getInstance, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setActive, setDependencyLevel, 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, getDependencyLevel, getInstance, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setDependencyLevel, setName, setRuntime |
Constructor Detail |
---|
public CreateGroupAnchorsFunction()
Method Detail |
---|
public String getAnchorPrefix()
public void setAnchorPrefix(String anchorPrefix)
anchorPrefix
- the prefix for the anchor.public String getGroup()
public void setGroup(String group)
group
- the name of the group.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 groupStarted(ReportEvent event)
groupStarted
in interface ReportListener
groupStarted
in class AbstractFunction
event
- the event.public Object getValue()
The value depends (obviously) on the expression implementation.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |