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

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.AbstractRootLevelBand
                  org.pentaho.reporting.engine.classic.core.GroupHeader

All Implemented Interfaces:

Serializable, Cloneable, DataTarget, ReportElement, RootLevelBand

public class GroupHeader
extends AbstractRootLevelBand

A report band that appears at the beginning of each instance of a group. A group-header can be marked as repeating header causing the header to be printed at the top of each page as long as the group is active. If the header is marked sticky, the header will even be printed for all sub-report pages.

Subreports defined for a repeating group header will be ignored for all repeating instances.

Author:

David Gilbert

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

GroupHeader()
Constructs a group header band, containing no elements.

Method Summary

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

addSubReport, addSubReport, clone, derive, getSubReport, getSubReportCount, getSubReports, removeSubreport

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

addElement, addElement, addElements, clear, 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

GroupHeader

public GroupHeader()

Constructs a group header band, containing no elements.

Method Detail

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.