Interface IBandContent

All Superinterfaces:
org.eclipse.birt.report.engine.css.engine.CSSStylableElement, IContainerContent, IContent, IElement, IStyledElement
All Known Subinterfaces:
IListBandContent, ITableBandContent

public interface IBandContent extends IContainerContent
Provides the interface for the Band Content. All types of bands for table, group, list, such as table-header/detail/footer, group-header/detail/footer, list-header/detail/footer, are implemented as instances of this class.

The following types for the band content are predefined:

  • BAND_HEADER
  • BAND_FOOTER
  • GROUP_HEADER
  • GROUP_FOOTER
  • BAND_DETAIL
    • Field Details

    • Method Details

      • getBandType

        int getBandType()
        Get the type of the band content. The return result of this method is in int format, and the int value must be one of the following predefined values in class IBandContent:
      • BAND_HEADER
      • BAND_FOOTER
      • GROUP_HEADER
      • GROUP_FOOTER
      • BAND_DETAIL
      • Returns:
        type of the band content.
      • setBandType

        void setBandType(int bandType)
        Set the type of the band content. The value of parameter bandType must be one of the following predefined values in class IBandContent:
      • BAND_HEADER
      • BAND_FOOTER
      • GROUP_HEADER
      • GROUP_FOOTER
      • BAND_DETAIL
      • Parameters:
        bandType - the type of the band content.
      • getGroupID

        String getGroupID()
        Get the group id if the band content is in some group. This method will return null when the band content is not a group header and group footer.
        Returns:
        the group id.