org.jfree.report.function
Class ItemHideFunction

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

public class ItemHideFunction

extends AbstractFunction

implements java.io.Serializable, PageEventListener

The ItemHideFunction hides equal values in a group. Only the first changed value is printed. This function uses the property element to define the name of the element in the ItemBand that should be made visible or invisible by this function. The property field defines the field in the datasource or the expression which should be used to determine the visibility.

Author:

Thomas Morgner

See Also:

Serialized Form

Constructor Summary

ItemHideFunction()
Constructs an unnamed function.

ItemHideFunction(java.lang.String name)
Constructs a named function.

Method Summary

java.lang.String	getElement() Returns the name of the element in the item band that should be set visible/invisible.
java.lang.String	getField() Returns the field used by the function.
Expression	getInstance() Return a completly separated copy of this function.
java.lang.Object	getValue() Returns the function value, in this case the visibility of the defined element.
boolean	isIgnoreGroupBreaks()
boolean	isIgnorePageBreaks()
void	itemsAdvanced(ReportEvent event) Receives notification that a row of data is being processed.
void	itemsStarted(ReportEvent event) Resets the state of the function when a new ItemGroup has started.
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.
void	reportInitialized(ReportEvent event) Receives notification that the report has started.
void	setElement(java.lang.String name) Sets the name of the element in the item band that should be set visible/invisible.
void	setField(java.lang.String field) Sets the field name for the function.
void	setIgnoreGroupBreaks(boolean ignoreGroupBreaks)
void	setIgnorePageBreaks(boolean ignorePageBreaks)

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

clone, groupFinished, groupStarted, itemsFinished, reportDone, reportFinished, reportStarted

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

getDataRow, getDependencyLevel, 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

ItemHideFunction

public ItemHideFunction()

Constructs an unnamed function.

Make sure to set the function name before it is used, or function initialisation will fail.

ItemHideFunction

public ItemHideFunction(java.lang.String name)

Constructs a named function.

The field must be defined before using the function.

Parameters:

name - The function name.

Method Detail

isIgnoreGroupBreaks

public boolean isIgnoreGroupBreaks()

setIgnoreGroupBreaks

public void setIgnoreGroupBreaks(boolean ignoreGroupBreaks)

isIgnorePageBreaks

public boolean isIgnorePageBreaks()

setIgnorePageBreaks

public void setIgnorePageBreaks(boolean ignorePageBreaks)

getElement

public java.lang.String getElement()

Returns the name of the element in the item band that should be set visible/invisible.

Returns:

The element name.

setElement

public void setElement(java.lang.String name)

Sets the name of the element in the item band that should be set visible/invisible.

Parameters:

name - the element name (must not be null).

getField

public java.lang.String getField()

Returns the field used by the function.

The field name corresponds to a column name in the report's TableModel or to an expression.

Returns:

The field name.

setField

public void setField(java.lang.String field)

Sets the field name for the function.

The field name corresponds to a column name in the report's TableModel.

Parameters:

field - the field name (null not permitted).

itemsAdvanced

public void itemsAdvanced(ReportEvent event)

Receives notification that a row of data is being processed. Reads the data from the field defined for this function and hides the field if the value is equal to the last value and the this is not the first row of the item group.

Overrides:

itemsAdvanced in class AbstractFunction

Parameters:

event - Information about the event.

itemsStarted

public void itemsStarted(ReportEvent event)

Resets the state of the function when a new ItemGroup has started.

Overrides:

itemsStarted in class AbstractFunction

Parameters:

event - the report event.

getValue

public java.lang.Object getValue()

Returns the function value, in this case the visibility of the defined element.

Returns:

The function value.

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.

getInstance

public Expression getInstance()

Return a completly separated copy of this function. The copy does no longer share any changeable objects with the original function.

Overrides:

getInstance in class AbstractExpression

Returns:

a copy of this function.

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 -

reportInitialized

public void reportInitialized(ReportEvent event)

Receives notification that the report has started.

Overrides:

reportInitialized in class AbstractFunction

Parameters:

event - the event.