Package org.apache.poi.ss.usermodel

Interface FontFormatting

All Known Implementing Classes:
HSSFFontFormatting, XSSFFontFormatting
public interface FontFormatting
High level representation for Font Formatting component of Conditional Formatting settings

  • 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)