Interface FontFormatting

All Known Implementing Classes:
HSSFFontFormatting, XSSFFontFormatting

public interface FontFormatting
High level representation for Font Formatting component of Conditional Formatting settings
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final short
    Escapement type - None
    static final short
    Escapement type - Subscript
    static final short
    Escapement type - Superscript
    static final byte
    Underline type - Double
    static final byte
    Underline type - Double Accounting
    static final byte
    Underline type - None
    static final byte
    Underline type - Single
    static final byte
    Underline type - Single Accounting
  • Method Summary

    Modifier and Type
    Method
    Description
    short
    get the type of super or subscript for the font
     
    short
     
    int
    gets the height of the font in 1/20th point units
    short
    get the type of underlining for the font
    boolean
    get whether the font weight is set to bold or not
    boolean
     
    boolean
     
    void
    set font style options to default values (non-italic, non-bold)
    void
    setEscapementType(short escapementType)
    set the escapement type for the font
    void
    Sets the colour to use
    void
    setFontColorIndex(short color)
    Sets the indexed colour to use
    void
    setFontHeight(int height)
    Sets the height of the font in 1/20th point units
    void
    setFontStyle(boolean italic, boolean bold)
    set font style options.
    void
    setUnderlineType(short underlineType)
    set the type of underlining type for the font
  • Field Details

  • Method Details

    • getEscapementType

      short getEscapementType()
      get the type of super or subscript for the font
      Returns:
      super or subscript option
      See Also:
    • setEscapementType

      void setEscapementType(short escapementType)
      set the escapement type for the font
      Parameters:
      escapementType - super or subscript option
      See Also:
    • getFontColorIndex

      short getFontColorIndex()
      Returns:
      font colour index, or 0 if not indexed (XSSF only)
    • setFontColorIndex

      void setFontColorIndex(short color)
      Sets the indexed colour to use
      Parameters:
      color - font colour index
    • getFontColor

      Color getFontColor()
      Returns:
      The colour of the font, or null if no colour applied
    • setFontColor

      void setFontColor(Color color)
      Sets the colour to use
      Parameters:
      color - font colour to use
    • getFontHeight

      int getFontHeight()
      gets the height of the font in 1/20th point units
      Returns:
      fontheight (in points/20); or -1 if not modified
    • setFontHeight

      void setFontHeight(int height)
      Sets the height of the font in 1/20th point units
      Parameters:
      height - the height in twips (in points/20)
    • getUnderlineType

      short getUnderlineType()
      get the type of underlining for the font
      Returns:
      font underlining type
      See Also:
    • setUnderlineType

      void setUnderlineType(short underlineType)
      set the type of underlining type for the font
      Parameters:
      underlineType - super or subscript option
      See Also:
    • isBold

      boolean isBold()
      get whether the font weight is set to bold or not
      Returns:
      bold - whether the font is bold or not
    • isItalic

      boolean isItalic()
      Returns:
      true if font style was set to italic
    • isStruckout

      boolean isStruckout()
      Returns:
      true if font strikeout is on
    • setFontStyle

      void setFontStyle(boolean italic, boolean bold)
      set font style options.
      Parameters:
      italic - - if true, set posture style to italic, otherwise to normal
      bold - if true, set font weight to bold, otherwise to normal
    • resetFontStyle

      void resetFontStyle()
      set font style options to default values (non-italic, non-bold)