Class HSSFHeader

java.lang.Object
loci.poi.hssf.usermodel.HSSFHeader

public class HSSFHeader extends Object
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.

Author:
Shawn Laubach (slaubach at apache dot org)
  • Constructor Details

    • HSSFHeader

      protected HSSFHeader(HeaderRecord headerRecord)
      Constructor. Creates a new header interface from a header record
      Parameters:
      headerRecord - Header record to create the header with
  • Method Details

    • getLeft

      public String getLeft()
      Get the left side of the header.
      Returns:
      The string representing the left side.
    • setLeft

      public void setLeft(String newLeft)
      Sets the left string.
      Parameters:
      newLeft - The string to set as the left side.
    • getCenter

      public String getCenter()
      Get the center of the header.
      Returns:
      The string representing the center.
    • setCenter

      public void setCenter(String newCenter)
      Sets the center string.
      Parameters:
      newCenter - The string to set as the center.
    • getRight

      public String getRight()
      Get the right side of the header.
      Returns:
      The string representing the right side.
    • setRight

      public void setRight(String newRight)
      Sets the right string.
      Parameters:
      newRight - The string to set as the right side.
    • fontSize

      public static String fontSize(short size)
      Returns the string that represents the change in font size.
      Parameters:
      size - the new font size
      Returns:
      The special string to represent a new font size
    • font

      public static String font(String font, String style)
      Returns the string that represents the change in font.
      Parameters:
      font - the new font
      style - the fonts style
      Returns:
      The special string to represent a new font size
    • page

      public static String page()
      Returns the string representing the current page number
      Returns:
      The special string for page number
    • numPages

      public static String numPages()
      Returns the string representing the number of pages.
      Returns:
      The special string for the number of pages
    • date

      public static String date()
      Returns the string representing the current date
      Returns:
      The special string for the date
    • time

      public static String time()
      Returns the string representing the current time
      Returns:
      The special string for the time
    • file

      public static String file()
      Returns the string representing the current file name
      Returns:
      The special string for the file name
    • tab

      public static String tab()
      Returns the string representing the current tab (sheet) name
      Returns:
      The special string for tab name
    • startUnderline

      public static String startUnderline()
      Returns the string representing the start underline
      Returns:
      The special string for start underline
    • endUnderline

      public static String endUnderline()
      Returns the string representing the end underline
      Returns:
      The special string for end underline
    • startDoubleUnderline

      public static String startDoubleUnderline()
      Returns the string representing the start double underline
      Returns:
      The special string for start double underline
    • endDoubleUnderline

      public static String endDoubleUnderline()
      Returns the string representing the end double underline
      Returns:
      The special string for end double underline