org.jfree.report: public class: GroupHeader

org.jfree.report
public class: GroupHeader [javadoc | source]

java.lang.Object
   org.jfree.report.Element
      org.jfree.report.Section
         org.jfree.report.Band
            org.jfree.report.AbstractRootLevelBand
               org.jfree.report.GroupHeader

All Implemented Interfaces:
RootLevelBand, ReportElement, DataTarget

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

Fields inherited from org.jfree.report.Band:
CONTENT_TYPE, ANONYMOUS_BAND_PREFIX

Fields inherited from org.jfree.report.Element:
ANONYMOUS_ELEMENT_PREFIX

Constructor:
public GroupHeader() { setElementType(new GroupHeaderType()); } Constructs a group header band, containing no elements.

Constructor:

 public GroupHeader() {
    setElementType(new GroupHeaderType());
}

Constructs a group header band, containing no elements.

Method from org.jfree.report.GroupHeader Summary:
isRepeat, isSticky, setRepeat, setSticky

Methods from org.jfree.report.AbstractRootLevelBand:
addSubReport, clone, getSubReport, getSubReportCount, getSubReports, removeSubreport

Methods from org.jfree.report.Band:
addElement, addElement, addElements, clear, clone, createGlobalDefaultStyle, getElement, getElement, getElementArray, getElementCount, isPagebreakAfterPrint, isPagebreakBeforePrint, removeElement, setPagebreakAfterPrint, setPagebreakBeforePrint, toString, unsafeGetElementArray

Methods from org.jfree.report.Section:
createGlobalDefaultStyle, getElement, getElementCount, registerAsChild, removeElement, unregisterAsChild, unregisterParent, validateLooping

Methods from org.jfree.report.Element:
clone, createGlobalDefaultStyle, getAttribute, getAttributeExpression, getAttributeExpressionNames, getAttributeExpressionNamespaces, getAttributeNames, getAttributeNamespaces, getAttributes, getContentBase, getDataSource, getDefinitionSource, getElementType, getElementTypeName, getHRefTarget, getId, getMetaData, getName, getObjectID, getParent, getParentSection, getReportDefinition, getStyle, getStyleExpression, getStyleExpressions, getTreeLock, getValue, isDynamicContent, isVisible, setAttribute, setAttributeExpression, setDataSource, setDynamicContent, setElementType, setHRefTarget, setId, setName, setParent, setStyleExpression, setVisible

Methods from org.jfree.report.Element:

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

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.jfree.report.GroupHeader Detail:
public boolean isRepeat() { return getStyle().getBooleanStyleProperty(BandStyleKeys.REPEAT_HEADER); } Checks whether this group header should be repeated on new pages.
public boolean isSticky() { return getStyle().getBooleanStyleProperty(BandStyleKeys.STICKY, false); } Returns true if the footer should be shown on all subreports.
public void setRepeat(boolean repeat) { getStyle().setBooleanStyleProperty(BandStyleKeys.REPEAT_HEADER, repeat); } Defines, whether this group header should be repeated on new pages.
public void setSticky(boolean b) { getStyle().setBooleanStyleProperty(BandStyleKeys.STICKY, b); } Defines whether the footer should be shown on all subreports.

Method from org.jfree.report.GroupHeader Detail:

 public boolean isRepeat() {
    return getStyle().getBooleanStyleProperty(BandStyleKeys.REPEAT_HEADER);
}

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

 public boolean isSticky() {
    return getStyle().getBooleanStyleProperty(BandStyleKeys.STICKY, false);
}

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

 public  void setRepeat(boolean repeat) {
    getStyle().setBooleanStyleProperty(BandStyleKeys.REPEAT_HEADER, repeat);
}

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

 public  void setSticky(boolean b) {
    getStyle().setBooleanStyleProperty(BandStyleKeys.STICKY, b);
}

Defines whether the footer should be shown on all subreports.