HideElementByNameFunction (classic-core 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.core.function.AbstractElementFormatFunction
    - - org.pentaho.reporting.engine.classic.core.function.HideElementByNameFunction

All Implemented Interfaces:

Serializable, Cloneable, EventListener, PageEventListener, ReportListener, Expression, Function, LayoutProcessorFunction
```
public class HideElementByNameFunction
extends AbstractElementFormatFunction
```
Deprecated.
Use a formula

This function hides all elements with a given name, as long as the defined field does not contain the element name.

Author:

Thomas Morgner

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

HideElementByNameFunction()
Deprecated.

Default Constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`protected boolean`	`evaluateElement(ReportElement e)`	Deprecated.
`String`	`getField()`	Deprecated. Returns the field used by the function.
`void`	`setField(String field)`	Deprecated. Defines the field name for the function.

Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractElementFormatFunction
getDependencyLevel, getElement, getInstance, getValue, groupFinished, groupStarted, isExecutable, itemsAdvanced, itemsFinished, itemsStarted, pageFinished, pageStarted, processBand, processFooterBands, processGroupHeaders, processHeaderBands, processRootBand, recordCacheHit, recordCacheMiss, reportCachePerformance, reportDone, reportFinished, reportInitialized, reportStarted, setElement

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

Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractExpression
clone, getDataRow, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, 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
clone, getDataRow, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setDependencyLevel, setName, setRuntime

Methods inherited from interface org.pentaho.reporting.engine.classic.core.event.ReportListener
summaryRowSelection

- Constructor Detail
  - HideElementByNameFunction
```
public HideElementByNameFunction()
```
    Deprecated.
    
    Default Constructor.
- Method Detail
  - getField
```
public String getField()
```
    Deprecated.
    
    Returns the field used by the function. The field name corresponds to a column name in the report's data-row.
    
    Returns:
    
    The field name.
  - setField
```
public void setField(String field)
```
    Deprecated.
    
    Defines the field name for the function. The field name corresponds to a column name in the report's data-row.
    
    Parameters:
    
    field - the field name.
  - evaluateElement
```
protected boolean evaluateElement(ReportElement e)
```
    Deprecated.
    
    Specified by:
    
    evaluateElement in class AbstractElementFormatFunction