Class HSSFFont

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

public class HSSFFont extends Object
Represents a Font used in a workbook.
Version:
1.0-pre
Author:
Andrew C. Oliver
See Also:
  • Field Details

    • FONT_ARIAL

      public static final String FONT_ARIAL
      Arial font
      See Also:
    • BOLDWEIGHT_NORMAL

      public static final short BOLDWEIGHT_NORMAL
      Normal boldness (not bold)
      See Also:
    • BOLDWEIGHT_BOLD

      public static final short BOLDWEIGHT_BOLD
      Bold boldness (bold)
      See Also:
    • COLOR_NORMAL

      public static final short COLOR_NORMAL
      normal type of black color.
      See Also:
    • COLOR_RED

      public static final short COLOR_RED
      Dark Red color
      See Also:
    • SS_NONE

      public static final short SS_NONE
      no type offsetting (not super or subscript)
      See Also:
    • SS_SUPER

      public static final short SS_SUPER
      superscript
      See Also:
    • SS_SUB

      public static final short SS_SUB
      subscript
      See Also:
    • U_NONE

      public static final byte U_NONE
      not underlined
      See Also:
    • U_SINGLE

      public static final byte U_SINGLE
      single (normal) underline
      See Also:
    • U_DOUBLE

      public static final byte U_DOUBLE
      double underlined
      See Also:
    • U_SINGLE_ACCOUNTING

      public static final byte U_SINGLE_ACCOUNTING
      accounting style single underline
      See Also:
    • U_DOUBLE_ACCOUNTING

      public static final byte U_DOUBLE_ACCOUNTING
      accounting style double underline
      See Also:
    • ANSI_CHARSET

      public static final byte ANSI_CHARSET
      ANSI character set
      See Also:
    • DEFAULT_CHARSET

      public static final byte DEFAULT_CHARSET
      Default character set.
      See Also:
    • SYMBOL_CHARSET

      public static final byte SYMBOL_CHARSET
      Symbol character set
      See Also:
  • Constructor Details

    • HSSFFont

      protected HSSFFont(short index, FontRecord rec)
      Creates a new instance of HSSFFont
  • Method Details

    • setFontName

      public void setFontName(String name)
      set the name for the font (i.e. Arial)
      Parameters:
      name - String representing the name of the font to use
      See Also:
    • getFontName

      public String getFontName()
      get the name for the font (i.e. Arial)
      Returns:
      String representing the name of the font to use
      See Also:
    • getIndex

      public short getIndex()
      get the index within the HSSFWorkbook (sequence within the collection of Font objects)
      Returns:
      unique index number of the underlying record this Font represents (probably you don't care unless you're comparing which one is which)
    • setFontHeight

      public void setFontHeight(short height)
      set the font height in unit's of 1/20th of a point. Maybe you might want to use the setFontHeightInPoints which matches to the familiar 10, 12, 14 etc..
      Parameters:
      height - height in 1/20ths of a point
      See Also:
    • setFontHeightInPoints

      public void setFontHeightInPoints(short height)
      set the font height
      Parameters:
      height - height in the familiar unit of measure - points
      See Also:
    • getFontHeight

      public short getFontHeight()
      get the font height in unit's of 1/20th of a point. Maybe you might want to use the getFontHeightInPoints which matches to the familiar 10, 12, 14 etc..
      Returns:
      short - height in 1/20ths of a point
      See Also:
    • getFontHeightInPoints

      public short getFontHeightInPoints()
      get the font height
      Returns:
      short - height in the familiar unit of measure - points
      See Also:
    • setItalic

      public void setItalic(boolean italic)
      set whether to use italics or not
      Parameters:
      italic - italics or not
    • getItalic

      public boolean getItalic()
      get whether to use italics or not
      Returns:
      italics or not
    • setStrikeout

      public void setStrikeout(boolean strikeout)
      set whether to use a strikeout horizontal line through the text or not
      Parameters:
      strikeout - or not
    • getStrikeout

      public boolean getStrikeout()
      get whether to use a strikeout horizontal line through the text or not
      Returns:
      strikeout or not
    • setColor

      public void setColor(short color)
      set the color for the font
      Parameters:
      color - to use
      See Also:
    • getColor

      public short getColor()
      get the color for the font
      Returns:
      color to use
      See Also:
    • setBoldweight

      public void setBoldweight(short boldweight)
      set the boldness to use
      Parameters:
      boldweight -
      See Also:
    • getBoldweight

      public short getBoldweight()
      get the boldness to use
      Returns:
      boldweight
      See Also:
    • setTypeOffset

      public void setTypeOffset(short offset)
      set normal,super or subscript.
      Parameters:
      offset - type to use (none,super,sub)
      See Also:
    • getTypeOffset

      public short getTypeOffset()
      get normal,super or subscript.
      Returns:
      offset type to use (none,super,sub)
      See Also:
    • setUnderline

      public void setUnderline(byte underline)
      set type of text underlining to use
      Parameters:
      underline - type
      See Also:
    • getUnderline

      public byte getUnderline()
      get type of text underlining to use
      Returns:
      underlining type
      See Also:
    • getCharSet

      public byte getCharSet()
      get character-set to use.
      Returns:
      character-set
      See Also:
    • setCharSet

      public void setCharSet(byte charset)
      set character-set to use.
      See Also:
    • toString

      public String toString()
      Overrides:
      toString in class Object