org.pentaho.reporting.engine.classic.core
Class DetailsHeader

java.lang.Object
  org.pentaho.reporting.engine.classic.core.Element
      org.pentaho.reporting.engine.classic.core.Section
          org.pentaho.reporting.engine.classic.core.Band
              org.pentaho.reporting.engine.classic.core.DetailsHeader

All Implemented Interfaces:

Serializable, Cloneable, DataTarget, ReportElement, RootLevelBand

public class DetailsHeader
extends Band
implements RootLevelBand

A details header is printed between the last group-header and the first detail band. The header is printed on the itemsStarted(..) event. A details-header cannot carry subreports.

This behavior can be easily changed with a style-expression on the visible-style-property. ("=NOT(ISEMPTYDATA())"

Author:

Thomas Morgner

See Also:

Serialized Form

Field Summary

Fields inherited from class org.pentaho.reporting.engine.classic.core.Band

ANONYMOUS_BAND_PREFIX, CONTENT_TYPE

Fields inherited from class org.pentaho.reporting.engine.classic.core.Element

ANONYMOUS_ELEMENT_PREFIX

Constructor Summary

DetailsHeader()
Constructs a new band (initially empty).

Method Summary

SubReport	getSubReport(int index) Throws an IndexOutOfBoundsException as page-footer cannot have sub-reports.
int	getSubReportCount() Returns the number of subreports on this band.
SubReport[]	getSubReports() Returns an empty array, as page-footer cannot have subreports.
boolean	isRepeat() Checks whether this group header should be repeated on new pages.
boolean	isSticky() Returns true if the footer should be shown on all subreports.
void	setRepeat(boolean repeat) Defines, whether this group header should be repeated on new pages.
void	setSticky(boolean b) Defines whether the footer should be shown on all subreports.

Methods inherited from class org.pentaho.reporting.engine.classic.core.Band

addElement, addElement, addElements, clear, clone, derive, getElement, getElement, getElementArray, getElementCount, isPagebreakAfterPrint, isPagebreakBeforePrint, removeElement, setElementAt, setPagebreakAfterPrint, setPagebreakBeforePrint, toString, unsafeGetElementArray

Methods inherited from class org.pentaho.reporting.engine.classic.core.Element

derive, getAttribute, getAttributeExpression, getAttributeExpressionNames, getAttributeExpressionNamespaces, getAttributeNames, getAttributeNamespaces, getAttributes, getChangeTracker, getContentBase, getDataSource, getDefinitionSource, getElementType, getElementTypeName, getHRefTarget, getId, getMetaData, getName, getObjectID, getParent, getParentSection, getReportDefinition, getStyle, getStyleExpression, getStyleExpressions, getTreeLock, getValue, isDynamicContent, isVisible, notifyNodeChildAdded, notifyNodeChildRemoved, notifyNodePropertiesChanged, notifyNodePropertiesChanged, notifyNodeStructureChanged, setAttribute, setAttribute, setAttributeExpression, setDataSource, setDynamicContent, setElementType, setHRefTarget, setId, setName, setStyleExpression, setVisible

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pentaho.reporting.engine.classic.core.ReportElement

getAttribute, getAttributeExpression, getAttributeExpressionNames, getAttributeExpressionNamespaces, getAttributeNames, getAttributeNamespaces, getAttributes, getId, getMetaData, getName, getObjectID, getParentSection, getReportDefinition, getStyle, getStyleExpression, getStyleExpressions, getTreeLock, setAttribute, setAttributeExpression, setStyleExpression

Constructor Detail

DetailsHeader

public DetailsHeader()

Constructs a new band (initially empty).

Method Detail

getSubReportCount

public final int getSubReportCount()

Returns the number of subreports on this band. This returns zero, as page-bands cannot have subreports.

Specified by:

getSubReportCount in interface RootLevelBand

Returns:

the subreport count.

getSubReport

public final SubReport getSubReport(int index)

Throws an IndexOutOfBoundsException as page-footer cannot have sub-reports.

Specified by:

getSubReport in interface RootLevelBand

Parameters:

index - the index.

Returns:

nothing, as an exception is thrown instead.

getSubReports

public SubReport[] getSubReports()

Returns an empty array, as page-footer cannot have subreports.

Specified by:

getSubReports in interface RootLevelBand

Returns:

the sub-reports as array.

isRepeat

public boolean isRepeat()

Checks whether this group header should be repeated on new pages.

Returns:

true, if the header will be repeated, false otherwise

setRepeat

public void setRepeat(boolean repeat)

Defines, whether this group header should be repeated on new pages.

Parameters:

repeat - true, if the header will be repeated, false otherwise

isSticky

public boolean isSticky()

Returns true if the footer should be shown on all subreports.

Returns:

true or false.

setSticky

public void setSticky(boolean b)

Defines whether the footer should be shown on all subreports.

Parameters:

b - a flag indicating whether or not the footer is shown on the first page.