org.pentaho.reporting.engine.classic.core.function
Class CreateGroupAnchorsFunction

java.lang.Object
  org.pentaho.reporting.engine.classic.core.function.AbstractExpression
      org.pentaho.reporting.engine.classic.core.function.AbstractFunction
          org.pentaho.reporting.engine.classic.core.function.CreateGroupAnchorsFunction

All Implemented Interfaces:

Serializable, Cloneable, EventListener, ReportListener, Expression, Function

Deprecated. It is easier to create anchors using a Style-expression. The Anchor-Field has been deprecated now.

public class CreateGroupAnchorsFunction
extends AbstractFunction

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.

Author:

Thomas Morgner

See Also:

Serialized Form

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

CreateGroupAnchorsFunction

public CreateGroupAnchorsFunction()

Deprecated.

Default Constructor. Does nothing.

Method Detail

getAnchorPrefix

public String getAnchorPrefix()

Deprecated.

Returns the prefix for the generated anchor.

Returns:

the anchor prefix.

setAnchorPrefix

public void setAnchorPrefix(String anchorPrefix)

Deprecated.

Defines the prefix for the generated anchor.

Parameters:

anchorPrefix - the prefix for the anchor.

getGroup

public String getGroup()

Deprecated.

Returns the name of the group for which an anchor should be generated.

Returns:

the name of the group.

setGroup

public void setGroup(String group)

Deprecated.

Defines the name of the group for which an anchor should be generated.

Parameters:

group - the name of the group.

reportInitialized

public void reportInitialized(ReportEvent event)

Deprecated.

Receives notification that report generation initializes the current run.

The event carries a ReportState.Started state. Use this to initialize the report.

Specified by:

reportInitialized in interface ReportListener

Overrides:

reportInitialized in class AbstractFunction

Parameters:

event - The event.

groupStarted

public void groupStarted(ReportEvent event)

Deprecated.

Receives notification that a group has started.

Specified by:

groupStarted in interface ReportListener

Overrides:

groupStarted in class AbstractFunction

Parameters:

event - the event.

getValue

public Object getValue()

Deprecated.

Return the current expression value.

The value depends (obviously) on the expression implementation.

Returns:

the value of the function.