org.jfree.report.demo.cards: public class: SelectCardFunction

org.jfree.report.demo.cards
public class: SelectCardFunction [javadoc | source]

java.lang.Object
   org.jfree.report.function.AbstractExpression
      org.jfree.report.function.AbstractFunction
         org.jfree.report.demo.cards.SelectCardFunction

All Implemented Interfaces:
Serializable, Function, Expression

The SelectCardFunction defines the visiblity of the card bands depending on the current card type. Valid property names are:

Account
Admin
User
Prepaid
Free
Empty

author: Thomas - Morgner.

Field Summary
public static final String	FIELD_PROPERTY	Literal text for the field property.
public static final String	BASECARD_PROPERTY	Literal text for the baseCard property.

Constructor:
public SelectCardFunction() { } Default constructor.

Constructor:

 public SelectCardFunction() {

}

Default constructor.

Method from org.jfree.report.demo.cards.SelectCardFunction Summary:
getValue, initialize, itemsAdvanced

Methods from org.jfree.report.function.AbstractFunction:
groupFinished, groupStarted, itemsAdvanced, itemsFinished, itemsStarted, reportDone, reportFinished, reportInitialized, reportStarted

Methods from org.jfree.report.function.AbstractExpression:
clone, getDataRow, getDependencyLevel, getInstance, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setActive, setDependencyLevel, setName, setPreserve, setRuntime

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.jfree.report.demo.cards.SelectCardFunction Detail:
public Object getValue() { return null; } Return the current expression value. The value depends (obviously) on the expression implementation.
public void initialize() throws FunctionInitializeException { super.initialize(); if (getProperty(BASECARD_PROPERTY) == null) { throw new FunctionInitializeException("'baseCard' property is not defined"); } if (getProperty(FIELD_PROPERTY) == null) { throw new FunctionInitializeException("'field' property is not defined"); } } Checks that the function has been correctly initialized. The only check performed at present is to make sure the name is not `null`.
public void itemsAdvanced(ReportEvent event) { final Element[] elements = event.getReport().getItemBand().getElementArray(); final String rootName = getProperty(BASECARD_PROPERTY, ""); // the itemband contains several cards, every card is contained in a single band. for (int i = 0; i < elements.length; i++) { if (elements[i] instanceof Band && elements[i].getName().equals(rootName)) { selectBand((Band) elements[i]); } } } Receives notification that a row of data is being processed.

Method from org.jfree.report.demo.cards.SelectCardFunction Detail:

 public Object getValue() {
    return null;
}

The value depends (obviously) on the expression implementation.

 public  void initialize() throws FunctionInitializeException {
    super.initialize();
    if (getProperty(BASECARD_PROPERTY) == null)
    {
      throw new FunctionInitializeException("'baseCard' property is not defined");
    }
    if (getProperty(FIELD_PROPERTY) == null)
    {
      throw new FunctionInitializeException("'field' property is not defined");
    }
}

The only check performed at present is to make sure the name is not null.

 public  void itemsAdvanced(ReportEvent event) {
    final Element[] elements = event.getReport().getItemBand().getElementArray();
    final String rootName = getProperty(BASECARD_PROPERTY, "");
    // the itemband contains several cards, every card is contained in a single band.
    for (int i = 0; i <  elements.length; i++)
    {
      if (elements[i] instanceof Band && elements[i].getName().equals(rootName))
      {
        selectBand((Band) elements[i]);
      }
    }
}

Receives notification that a row of data is being processed.