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

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.ElementVisibilityFunction

All Implemented Interfaces:

Serializable, Cloneable, EventListener, PageEventListener, ReportListener, Expression, Function, LayoutProcessorFunction

Deprecated. add a style-expression for the visible style-key instead.

public class ElementVisibilityFunction
extends AbstractElementFormatFunction

Triggers the visiblity of an element based on the boolean value read from the defined field.

Author:

Thomas Morgner

See Also:

Serialized Form

Constructor Summary

ElementVisibilityFunction()
Deprecated. Default Constructor.

Method Summary

String	getField() Deprecated. Returns the field name of the data-row column from where to read the boolean value.
Object	getValue() Deprecated. Returns whether the element will be visible or not.
void	setField(String field) Deprecated. Defines field name of the data-row column from where to read the boolean value.

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

getElement, 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

ElementVisibilityFunction

public ElementVisibilityFunction()

Deprecated.

Default Constructor.

Method Detail

getField

public String getField()

Deprecated.

Returns the field name of the data-row column from where to read the boolean value.

Returns:

the field name.

setField

public void setField(String field)

Deprecated.

Defines field name of the data-row column from where to read the boolean value.

Parameters:

field - the name of the field.

getValue

public Object getValue()

Deprecated.

Returns whether the element will be visible or not.

Specified by:

getValue in interface Expression

Overrides:

getValue in class AbstractElementFormatFunction

Returns:

Boolean.TRUE or Boolean.FALSE.