org.jfree.report: abstract public class: AbstractRootLevelBand

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

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

All Implemented Interfaces:
RootLevelBand, ReportElement, DataTarget

Direct Known Subclasses:
GroupHeader, ReportFooter, ItemBand, ReportHeader, NoDataBand, GroupFooter

The root-level band is the container that is processed by a report-state. The root-level band processing is atomic - so either the full band is processed or not processed at all.

author: Thomas - Morgner

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

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

Constructor:

Constructor:
protected AbstractRootLevelBand() { getStyle().setStyleProperty(ElementStyleKeys.AVOID_PAGEBREAK_INSIDE, Boolean.TRUE); } Constructs a new band (initially empty).
protected AbstractRootLevelBand(boolean pagebreakBefore, boolean pagebreakAfter) { super(pagebreakBefore, pagebreakAfter); getStyle().setStyleProperty(ElementStyleKeys.AVOID_PAGEBREAK_INSIDE, Boolean.TRUE); } Constructs a new band with the given pagebreak attributes. Pagebreak attributes have no effect on subbands. Parameters: `pagebreakAfter` - defines, whether a pagebreak should be done after that band was printed. `pagebreakBefore` - defines, whether a pagebreak should be done before that band gets printed.

 protected AbstractRootLevelBand() {
           
    getStyle().setStyleProperty(ElementStyleKeys.AVOID_PAGEBREAK_INSIDE, Boolean.TRUE);
}

Constructs a new band (initially empty).

 protected AbstractRootLevelBand(boolean pagebreakBefore,
    boolean pagebreakAfter) {
    super(pagebreakBefore, pagebreakAfter);
    getStyle().setStyleProperty(ElementStyleKeys.AVOID_PAGEBREAK_INSIDE, Boolean.TRUE);
}

Constructs a new band with the given pagebreak attributes. Pagebreak attributes have no effect on subbands.

Parameters:

pagebreakAfter - defines, whether a pagebreak should be done after that band was printed.

pagebreakBefore - defines, whether a pagebreak should be done before that band gets printed.

Method from org.jfree.report.AbstractRootLevelBand Summary:
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.AbstractRootLevelBand Detail:
public void addSubReport(SubReport report) { if (report == null) { throw new NullPointerException("Parameter 'report' must not be null"); } if (subReports == null) { subReports = new ArrayList(); } subReports.add(report); } Attaches a new subreport at the end of the list.
public Object clone() throws CloneNotSupportedException { final AbstractRootLevelBand rootLevelBand = (AbstractRootLevelBand) super.clone(); if (rootLevelBand.subReports != null) { rootLevelBand.subReports.clone(); } return rootLevelBand; } Clones this band and all elements contained in this band. After the cloning the band is no longer connected to a report definition.
public SubReport getSubReport(int index) { if (subReports == null) { throw new IndexOutOfBoundsException(); } return (SubReport) subReports.get(index); } Returns the subreport at the given index-position.
public int getSubReportCount() { if (subReports == null) { return 0; } return subReports.size(); } Returns the number of subreports attached to this root level band.
public SubReport[] getSubReports() { if (subReports == null) { return AbstractRootLevelBand.EMPTY_SUBREPORTS; } return (SubReport[]) subReports.toArray(new SubReport[subReports.size()]); } Returns all sub-reports as array.
public void removeSubreport(SubReport report) { if (report == null) { throw new NullPointerException("Parameter 'report' must not be null"); } if (subReports == null) { return; } subReports.remove(report); } Removes the given subreport from the list of attached sub-reports.

Method from org.jfree.report.AbstractRootLevelBand Detail:

 public  void addSubReport(SubReport report) {
    if (report == null)
    {
      throw new NullPointerException("Parameter 'report' must not be null");
    }
    if (subReports == null)
    {
      subReports = new ArrayList();
    }
    subReports.add(report);
}

Attaches a new subreport at the end of the list.

 public Object clone() throws CloneNotSupportedException {
    final AbstractRootLevelBand rootLevelBand = (AbstractRootLevelBand) super.clone();
    if (rootLevelBand.subReports != null)
    {
      rootLevelBand.subReports.clone();
    }
    return rootLevelBand;
}

Clones this band and all elements contained in this band. After the cloning the band is no longer connected to a report definition.

 public SubReport getSubReport(int index) {
    if (subReports == null)
    {
      throw new IndexOutOfBoundsException();
    }
    return (SubReport) subReports.get(index);
}

Returns the subreport at the given index-position.

 public int getSubReportCount() {
    if (subReports == null)
    {
      return 0;
    }
    return subReports.size();
}

Returns the number of subreports attached to this root level band.

 public SubReport[] getSubReports() {
    if (subReports == null)
    {
      return AbstractRootLevelBand.EMPTY_SUBREPORTS;
    }
    return (SubReport[]) subReports.toArray(new SubReport[subReports.size()]);
}

Returns all sub-reports as array.

 public  void removeSubreport(SubReport report) {
    if (report == null)
    {
      throw new NullPointerException("Parameter 'report' must not be null");
    }
    if (subReports == null)
    {
      return;
    }
    subReports.remove(report);
}

Removes the given subreport from the list of attached sub-reports.