Save This Page
Home » pentaho-reporting-engine-classic-0.8.10 » org » jfree » report » [javadoc | source]
org.jfree.report
public class: Band [javadoc | source]
java.lang.Object
   org.jfree.report.Element
      org.jfree.report.Section
         org.jfree.report.Band

All Implemented Interfaces:
    ReportElement, DataTarget

Direct Known Subclasses:
    GroupHeader, ReportFooter, AbstractRootLevelBand, DetailsFooter, Watermark, ItemBand, ReportHeader, NoDataBand, GroupFooter, PageFooter, PageHeader, DetailsHeader

A report band is a collection of other elements and bands, similiar to an AWT-Container.

This implementation is not synchronized, to take care that you externally synchronize it when using multiple threads to modify instances of this class.

Trying to add a parent of an band as child to the band, will result in an exception.

Field Summary
public static final  String CONTENT_TYPE    The defined content type for the band.
     
    public static final  String ANONYMOUS_BAND_PREFIX    The prefix for anonymous bands, bands without an userdefined name. 
    Fields inherited from org.jfree.report.Element:
    ANONYMOUS_ELEMENT_PREFIX
    Constructor:
     public Band() 
     public Band(boolean pagebreakBefore,
        boolean pagebreakAfter) 
    Method from org.jfree.report.Band Summary:
    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 java.lang.Object:
    equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
    Method from org.jfree.report.Band Detail:
     public  void addElement(Element element) 
      Adds a report element to the band.
     public  void addElement(int position,
        Element element) 
      Adds a report element to the band. The element will be inserted at the specified position.
     public  void addElements(Collection elements) 
      Adds a collection of elements to the band.
     public  void clear() 
     public Object clone() throws CloneNotSupportedException 
      Clones this band and all elements contained in this band. After the cloning the band is no longer connected to a report definition.
     protected ElementDefaultStyleSheet createGlobalDefaultStyle() 
      Returns the global stylesheet for all bands. This stylesheet provides the predefined default values for some of the stylekeys.
     public Element getElement(String name) 
     public ReportElement getElement(int index) 
      Returns the element stored add the given index.
     public Element[] getElementArray() 
      Returns an array of the elements in the band. If the band is empty, an empty array is returned.

      Implementation note: The array returned is a copy of the internal backend. Any modification of the array will no longer result in modifications of the internal object state. To avoid unneccessary object creations, you can use the Band#unsafeGetElementArray() method now.

     public int getElementCount() 
      Returns the number of elements in this band.
     public boolean isPagebreakAfterPrint() 
      Returns, whether the page layout manager should perform a pagebreak before this page is printed. This will have no effect on empty pages or if the band is no root-level band.
     public boolean isPagebreakBeforePrint() 
      Returns, whether the page layout manager should perform a pagebreak before this page is printed. This will have no effect on empty pages or if the band is no root-level band.
     public  void removeElement(Element e) 
      Removes an element from the band.
     public  void setPagebreakAfterPrint(boolean pagebreakAfterPrint) 
      Defines, whether the page layout manager should perform a pagebreak before this page is printed. This will have no effect on empty pages or if the band is no root-level band.
     public  void setPagebreakBeforePrint(boolean pagebreakBeforePrint) 
      Defines, whether the page layout manager should perform a pagebreak before this page is printed. This will have no effect on empty pages or if the band is no root-level band.
     public String toString() 
      Returns a string representation of the band, useful mainly for debugging purposes.
     public final Element[] unsafeGetElementArray()