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

java.lang.Object
  extended by org.pentaho.reporting.engine.classic.core.function.AbstractExpression
      extended by org.pentaho.reporting.engine.classic.core.function.AbstractFunction
          extended by org.pentaho.reporting.engine.classic.core.function.AbstractElementFormatFunction
              extended by org.pentaho.reporting.engine.classic.core.function.HideElementByNameFunction
All Implemented Interfaces:
Serializable, Cloneable, EventListener, PageEventListener, ReportListener, Expression, Function, LayoutProcessorFunction

Deprecated. Use a formula

public class HideElementByNameFunction
extends AbstractElementFormatFunction

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
HideElementByNameFunction()
          Deprecated. Default Constructor.
 
Method Summary
 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
getElement, getValue, groupFinished, groupStarted, itemsAdvanced, itemsFinished, itemsStarted, pageFinished, pageStarted, reportFinished, reportInitialized, reportStarted, setElement
 
Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractFunction
reportDone
 
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.event.ReportListener
reportDone
 
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

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.