Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.poi.hssf.usermodel
Class HSSFHeader

    java.lang.Object
      org.apache.poi.hssf.usermodel.HeaderFooter
          org.apache.poi.hssf.usermodel.HSSFHeader

All Implemented Interfaces:
  Header, HeaderFooter

    public final class HSSFHeader

extends HeaderFooter
implements Header

Class to read and manipulate the header.

The header works by having a left, center, and right side. The total cannot be more that 255 bytes long. One uses this class by getting the HSSFHeader from HSSFSheet and then getting or setting the left, center, and right side. For special things (such as page numbers and date), one can use a the methods that return the characters used to represent these. One can also change the fonts by using similar methods.

Constructor Summary
`protected` | `HSSFHeader(PageSettingsBlock psb)`

Method Summary
`protected java.lang.String` | `getRawText()`
`protected void` | `setHeaderFooterText(java.lang.String text)`

Methods inherited from class org.apache.poi.hssf.usermodel.HeaderFooter
`date, endBold, endDoubleUnderline, endUnderline, file, font, fontSize, getCenter, getLeft, getRight, numPages, page, setCenter, setLeft, setRight, startBold, startDoubleUnderline, startUnderline, stripFields, tab, time`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface org.apache.poi.ss.usermodel.Header
`getCenter, getLeft, getRight, setCenter, setLeft, setRight`

Constructor Detail

### HSSFHeader

    protected HSSFHeader(PageSettingsBlock psb)

Method Detail

### getRawText

    protected java.lang.String getRawText()

  Specified by:
    `getRawText` in class `HeaderFooter`
  Returns:
    the internal text representation (combining center, left and right parts). Possibly empty string if no header or footer is set. Never `null`.

### setHeaderFooterText

    protected void setHeaderFooterText(java.lang.String text)

  Specified by:
    `setHeaderFooterText` in class `HeaderFooter`
  Parameters:
    `text` - the new header footer text (contains mark-up tags). Possibly empty string never `null`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 2017 The Apache Software Foundation or its licensors, as applicable.