Class XSSFFirstHeader

  • All Implemented Interfaces:
    Header, HeaderFooter

    public class XSSFFirstHeader
    extends XSSFHeaderFooter
    implements Header

    First page header content. Corresponds to first printed page. The first logical page in the sheet may not be printed, for example, if the print area is specified to be a range such that it falls outside the first page's scope.

    The first page header is activated by the "Different First" Header/Footer property for the sheet. If this property is not set, the first page header is ignored.

    Creating a first page header or footer sets this property by default, so all you need to do to get an first page header or footer to display is to create one. Likewise, if both the first page header and footer are usnset, then this property is unset, and the first page header and footer are ignored.

    • Method Detail

      • getText

        public java.lang.String getText()
        Get the content text representing this header
        Specified by:
        getText in class XSSFHeaderFooter
      • setText

        public void setText​(java.lang.String text)
        Set a text for the header. If null unset the value. If unsetting this header results in no First Header, or footer for the sheet, the 'differentFirst' property is unset as well.
        text - - a string representing the header.
        See Also:
        to see how to create a string with Header/Footer Formatting Syntax