Package 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

public class ElementVisibilityFunction
extends AbstractElementFormatFunction

Deprecated.

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

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

Constructors

Constructor	Description
ElementVisibilityFunction()	Deprecated. Default Constructor.

Method Summary

Modifier and Type	Method	Description
protected boolean	evaluateElement(ReportElement e)	Deprecated.
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.
protected boolean	isVisible()	Deprecated. Computes the visiblity of the element.
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

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

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.

evaluateElement

protected boolean evaluateElement(ReportElement e)

Deprecated.

Specified by:

evaluateElement in class AbstractElementFormatFunction

isVisible

protected boolean isVisible()

Deprecated.

Computes the visiblity of the element.

Returns:

true, if the field contains the Boolean.TRUE object, false otherwise.