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

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

All Implemented Interfaces:

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

Deprecated. add a style expression for the 'paint' style instead

public class ElementColorFunction
extends AbstractElementFormatFunction

A function that alternates between true and false for each item within a group. The functions value affects a defined elements color. If the function evaluates to true, the named element is painted with the colorTrue, else the element is painted with colorFalse.

Use the property element to name an element contained in the ItemBand whose color should be affected by this function. All colors have the color 'black' by default.

Author:

Thomas Morgner

See Also:

Serialized Form

Constructor Summary

ElementColorFunction()
Deprecated. Default constructor.

Method Summary

Color	getColorFalse() Deprecated. Returns the color for false values.
Color	getColorTrue() Deprecated. Returns the color for true values.
String	getField() Deprecated. Returns the field used by the function.
void	setColorFalse(Color colorFalse) Deprecated. Sets the color for false values.
void	setColorTrue(Color colorTrue) Deprecated. Sets the color for true values.
void	setField(String field) Deprecated. Sets 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

ElementColorFunction

public ElementColorFunction()

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.

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

setColorTrue

public void setColorTrue(Color colorTrue)

Deprecated.

Sets the color for true values.

Parameters:

colorTrue - the color.

setColorFalse

public void setColorFalse(Color colorFalse)

Deprecated.

Sets the color for false values.

Parameters:

colorFalse - the color.

getColorTrue

public Color getColorTrue()

Deprecated.

Returns the color for true values.

Returns:

A color.

getColorFalse

public Color getColorFalse()

Deprecated.

Returns the color for false values.

Returns:

A color.