IndexTextGeneratorFunction (classic-extensions-toc 9.3.0.0-424 API)

java.lang.Object
- org.pentaho.reporting.engine.classic.core.function.AbstractExpression
- - org.pentaho.reporting.engine.classic.core.function.AbstractFunction
  - - org.pentaho.reporting.engine.classic.extensions.toc.IndexNumberGeneratorFunction
    - - org.pentaho.reporting.engine.classic.extensions.toc.IndexTextGeneratorFunction

All Implemented Interfaces:

Serializable, Cloneable, EventListener, org.pentaho.reporting.engine.classic.core.event.ReportListener, org.pentaho.reporting.engine.classic.core.function.Expression, org.pentaho.reporting.engine.classic.core.function.Function
```
public class IndexTextGeneratorFunction
extends IndexNumberGeneratorFunction
```
A data-collector that collects table-of-contents items at group-starts. The function collects these items accross subreport boundaries.

Author:

Thomas Morgner.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

IndexTextGeneratorFunction()
Creates an unnamed function.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getIndexSeparator()`
`Object`	`getValue()`	Return the current expression value.
`boolean`	`isCondensedStyle()`
`void`	`setCondensedStyle(boolean condensedStyle)`
`void`	`setIndexSeparator(String indexSeparator)`

Methods inherited from class org.pentaho.reporting.engine.classic.extensions.toc.IndexNumberGeneratorFunction
clone, getDepth, getInstance, groupFinished, groupStarted, isCollectDetails, isDeepTraversing, itemsAdvanced, itemsFinished, itemsStarted, reportInitialized, reportStarted, setCollectDetails, setDepth

Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractFunction
reportDone, reportFinished, summaryRowSelection

Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractExpression
getDataRow, getDependencyLevel, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isPreserve, setActive, setDependencyLevel, setName, setPreserve, setRuntime

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.pentaho.reporting.engine.classic.core.function.Expression
getDataRow, getDependencyLevel, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isPreserve, setDependencyLevel, setName, setRuntime

- Constructor Detail
  - IndexTextGeneratorFunction
```
public IndexTextGeneratorFunction()
```
    Creates an unnamed function. Make sure the name of the function is set using AbstractExpression.setName(java.lang.String) before the function is added to the report's function collection.
- Method Detail
  - getIndexSeparator
```
public String getIndexSeparator()
```
  - setIndexSeparator
```
public void setIndexSeparator(String indexSeparator)
```
  - isCondensedStyle
```
public boolean isCondensedStyle()
```
  - setCondensedStyle
```
public void setCondensedStyle(boolean condensedStyle)
```
  - getValue
```
public Object getValue()
```
    Return the current expression value.
    The value depends (obviously) on the expression implementation.
    
    Specified by:
    
    getValue in interface org.pentaho.reporting.engine.classic.core.function.Expression
    
    Overrides:
    
    getValue in class IndexNumberGeneratorFunction
    
    Returns:
    
    the value of the function.