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

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

All Implemented Interfaces:

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

public class HidePageBandForTableExportFunction
extends AbstractFunction
implements LayoutProcessorFunction

Hides the page header and footer if the export type is not pageable. Repeated groupheaders can be disabled by this function as well.

Author:

Thomas Morgner

See Also:

Serialized Form

Constructor Summary

HidePageBandForTableExportFunction()
Default Constructor.

Method Summary

String	getExportDescriptor()
Object	getValue() This method returns null, as formatting functions have no computed return value.
boolean	isDisableRepeatingHeader() Returns whether repeating group header and footer should made non-repeating.
boolean	isHidePageBands() Returns whether page bands should be hidden.
void	reportInitialized(ReportEvent event) Applies the defined flags to the report.
void	setDisableRepeatingHeader(boolean disableRepeatingHeader) Defines whether repeating group header and footer should made non-repeating.
void	setExportDescriptor(String exportDescriptor)
void	setHidePageBands(boolean hidePageBands) Defines whether page bands should be hidden.

Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractFunction

groupFinished, groupStarted, itemsAdvanced, itemsFinished, itemsStarted, reportDone, reportFinished, reportStarted

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

groupFinished, groupStarted, itemsAdvanced, itemsFinished, itemsStarted, reportDone, reportFinished, reportStarted

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

HidePageBandForTableExportFunction

public HidePageBandForTableExportFunction()

Default Constructor.

Method Detail

reportInitialized

public void reportInitialized(ReportEvent event)

Applies the defined flags to the report.

Specified by:

reportInitialized in interface ReportListener

Overrides:

reportInitialized in class AbstractFunction

Parameters:

event - the report event.

getExportDescriptor

public String getExportDescriptor()

setExportDescriptor

public void setExportDescriptor(String exportDescriptor)

isHidePageBands

public boolean isHidePageBands()

Returns whether page bands should be hidden.

Returns:

true, if page bands should be hidden, false otherwise.

setHidePageBands

public void setHidePageBands(boolean hidePageBands)

Defines whether page bands should be hidden.

Parameters:

hidePageBands - true, if page bands should be hidden, false otherwise.

isDisableRepeatingHeader

public boolean isDisableRepeatingHeader()

Returns whether repeating group header and footer should made non-repeating.

Returns:

true, if repeating header and footer will be disabled, false otherwise.

setDisableRepeatingHeader

public void setDisableRepeatingHeader(boolean disableRepeatingHeader)

Defines whether repeating group header and footer should made non-repeating.

Parameters:

disableRepeatingHeader - true, if repeating header and footer will be disabled, false otherwise.

getValue

public Object getValue()

This method returns null, as formatting functions have no computed return value.

Specified by:

getValue in interface Expression

Returns:

null.