org.jfree.report.function
Class AbstractElementFormatFunction

java.lang.Object
  |
  +--org.jfree.report.function.AbstractExpression
        |
        +--org.jfree.report.function.AbstractFunction
              |
              +--org.jfree.report.function.AbstractElementFormatFunction

Direct Known Subclasses:

CreateHyperLinksFunction, ElementColorFunction, ElementTrafficLightFunction, ElementVisibilityFunction, FontChangeFunction, HideElementByNameFunction, HideElementIfDataAvailableExpression, HideNullValuesFunction, NegativeNumberPaintChangeFunction, ShowElementByNameFunction, ShowElementIfDataAvailableExpression

public abstract class AbstractElementFormatFunction

extends AbstractFunction

implements PageEventListener

See Also:

Serialized Form

Constructor Summary

protected

AbstractElementFormatFunction() Creates an unnamed function.

Method Summary

java.lang.String	getElement() Returns the element name.
void	groupFinished(ReportEvent event) Receives notification that a group has finished.
void	groupStarted(ReportEvent event) Receives notification that a group has started.
void	itemsAdvanced(ReportEvent event) Receives notification that a row of data is being processed.
void	pageCanceled(ReportEvent event) Receives notification that a page was canceled by the ReportProcessor.
void	pageFinished(ReportEvent event) Receives notification that a page is completed.
void	pageRolledBack(ReportEvent event) This event is fired, whenever an automatic pagebreak has been detected and the report state had been reverted to the previous state.
void	pageStarted(ReportEvent event) Receives notification that a new page is being started.
protected abstract void	processRootBand(Band b)
void	reportFinished(ReportEvent event) Receives notification that the report has finished.
void	reportStarted(ReportEvent event) Receives notification that the report has started.
void	setElement(java.lang.String name) Sets the element name.

Methods inherited from class org.jfree.report.function.AbstractFunction

clone, itemsFinished, itemsStarted, reportDone, reportInitialized

Methods inherited from class org.jfree.report.function.AbstractExpression

getDataRow, getDependencyLevel, getInstance, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, setActive, setDependencyLevel, setName, setRuntime

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractElementFormatFunction

protected AbstractElementFormatFunction()

Creates an unnamed function. Make sure the name of the function is set using AbstractExpression.setName(java.lang.String) before the function is added to the report's function collection.

Method Detail

setElement

public void setElement(java.lang.String name)

Sets the element name. The name denotes an element within the item band. The element will be retrieved using the getElement(String) function.

Parameters:

name - The element name.

See Also:

Band.getElement(String)

getElement

public java.lang.String getElement()

Returns the element name.

Returns:

The element name.

itemsAdvanced

public void itemsAdvanced(ReportEvent event)

Receives notification that a row of data is being processed.

Overrides:

itemsAdvanced in class AbstractFunction

Parameters:

event - the event.

reportFinished

public void reportFinished(ReportEvent event)

Receives notification that the report has finished.

Overrides:

reportFinished in class AbstractFunction

Parameters:

event - the event.

reportStarted

public void reportStarted(ReportEvent event)

Receives notification that the report has started.

Overrides:

reportStarted in class AbstractFunction

Parameters:

event - the event.

groupStarted

public void groupStarted(ReportEvent event)

Receives notification that a group has started.

Overrides:

groupStarted in class AbstractFunction

Parameters:

event - the event.

groupFinished

public void groupFinished(ReportEvent event)

Receives notification that a group has finished.

Overrides:

groupFinished in class AbstractFunction

Parameters:

event - the event.

pageCanceled

public void pageCanceled(ReportEvent event)

Receives notification that a page was canceled by the ReportProcessor. This method is called, when a page was removed from the report after it was generated.

Specified by:

pageCanceled in interface PageEventListener

Parameters:

event - The event.

pageFinished

public void pageFinished(ReportEvent event)

Receives notification that a page is completed.

Specified by:

pageFinished in interface PageEventListener

Parameters:

event - The event.

pageStarted

public void pageStarted(ReportEvent event)

Receives notification that a new page is being started.

Specified by:

pageStarted in interface PageEventListener

Parameters:

event - The event.

pageRolledBack

public void pageRolledBack(ReportEvent event)

This event is fired, whenever an automatic pagebreak has been detected and the report state had been reverted to the previous state.

Specified by:

pageRolledBack in interface PageEventListener

Parameters:

event -

processRootBand

protected abstract void processRootBand(Band b)