org.pentaho.reporting.engine.classic.core.filter.types.bands

Class AbstractSectionType

java.lang.Object

org.pentaho.reporting.engine.classic.core.filter.types.AbstractElementType

org.pentaho.reporting.engine.classic.core.filter.types.bands.AbstractSectionType

All Implemented Interfaces:

Serializable, Cloneable, DataSource, ElementType, SectionType

Direct Known Subclasses:

BandType, CrosstabCellBodyType, CrosstabCellType, CrosstabColumnGroupBodyType, CrosstabColumnGroupType, CrosstabElementType, CrosstabGroupType, CrosstabHeaderType, CrosstabOtherGroupBodyType, CrosstabOtherGroupType, CrosstabRowGroupBodyType, CrosstabRowGroupType, CrosstabSummaryHeaderType, CrosstabTitleHeaderType, DetailsFooterType, DetailsHeaderType, GroupDataBodyType, GroupFooterType, GroupHeaderType, ItemBandType, MasterReportType, NoDataBandType, PageFooterType, PageHeaderType, RelationalGroupType, ReportFooterType, ReportHeaderType, SubGroupBodyType, SubReportType, WatermarkType

public abstract class AbstractSectionType
extends AbstractElementType
implements SectionType

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
Object	getDesignValue(ExpressionRuntime runtime, ReportElement element) Compute a design-time value.
Object	getValue(ExpressionRuntime runtime, ReportElement element) Returns the current value for the data source.
boolean	isRestricted() A band that serves a specific purpose within a slotted parent should return "true" here.

Methods inherited from class org.pentaho.reporting.engine.classic.core.filter.types.AbstractElementType

clone, configureDesignTimeDefaults, create, equals, getMetaData, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.pentaho.reporting.engine.classic.core.metadata.ElementType

configureDesignTimeDefaults, create, getMetaData

Methods inherited from interface org.pentaho.reporting.engine.classic.core.filter.DataSource

clone

Method Detail

isRestricted

public boolean isRestricted()

Description copied from interface: SectionType

A band that serves a specific purpose within a slotted parent should return "true" here. Plain elemetns and bands that can be freely combined should return false.

Specified by:

isRestricted in interface SectionType

Returns:

true, if the usage is restricted.

getDesignValue

public Object getDesignValue(ExpressionRuntime runtime,
                             ReportElement element)

Description copied from interface: ElementType

Compute a design-time value. This value will be displayed when editing the element in the Pentaho Report Designer. If there is not enough data available to produce a sensible output, return a mock-object so that the user can interact with the element in a sensible fashion.

When the element is called, all style and attribute expressions have been resolved and can be accessed via the normal static style and attribute accessor methods. If the content of your element depends on style information, the fully computed style must be retrieved via the .Element#getComputedStyle() method. The local style-sheet for the element may not have all information.

Specified by:

getDesignValue in interface ElementType

Parameters:

runtime - the expression runtime holding the current report state.

element - the element.

Returns:

the computed value.

getValue

public Object getValue(ExpressionRuntime runtime,
                       ReportElement element)

Description copied from interface: DataSource

Returns the current value for the data source.

Specified by:

getValue in interface DataSource

Parameters:

runtime - the expression runtime that is used to evaluate formulas and expressions when computing the value of this filter.

element - the element for which the data is computed.

Returns:

the value.