Enum Class HSLFFontInfoPredefined

java.lang.Object
java.lang.Enum<HSLFFontInfoPredefined>
org.apache.poi.hslf.usermodel.HSLFFontInfoPredefined
All Implemented Interfaces:
Serializable, Comparable<HSLFFontInfoPredefined>, Constable, FontInfo

public enum HSLFFontInfoPredefined extends Enum<HSLFFontInfoPredefined> implements FontInfo
Predefined fonts
Since:
POI 3.17-beta2
  • Enum Constant Details

  • Method Details

    • values

      public static HSLFFontInfoPredefined[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static HSLFFontInfoPredefined valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • getIndex

      public Integer getIndex()
      Description copied from interface: FontInfo
      Get the index within the collection of Font objects
      Specified by:
      getIndex in interface FontInfo
      Returns:
      unique index number of the underlying record this Font represents (probably you don't care unless you're comparing which one is which)
    • setIndex

      public void setIndex(int index)
      Description copied from interface: FontInfo
      Sets the index within the collection of Font objects
      Specified by:
      setIndex in interface FontInfo
      Parameters:
      index - the index within the collection of Font objects
    • getTypeface

      public String getTypeface()
      Specified by:
      getTypeface in interface FontInfo
      Returns:
      the full name of the font, i.e. font family + type face
    • setTypeface

      public void setTypeface(String typeface)
      Description copied from interface: FontInfo
      Sets the font name
      Specified by:
      setTypeface in interface FontInfo
      Parameters:
      typeface - the full name of the font, when null removes the font definition - removal is implementation specific
    • getCharset

      public FontCharset getCharset()
      Specified by:
      getCharset in interface FontInfo
      Returns:
      the font charset
    • setCharset

      public void setCharset(FontCharset charset)
      Description copied from interface: FontInfo
      Sets the charset
      Specified by:
      setCharset in interface FontInfo
      Parameters:
      charset - the charset
    • getFamily

      public FontFamily getFamily()
      Specified by:
      getFamily in interface FontInfo
      Returns:
      the family class
    • setFamily

      public void setFamily(FontFamily family)
      Description copied from interface: FontInfo
      Sets the font family class
      Specified by:
      setFamily in interface FontInfo
      Parameters:
      family - the font family class
    • getPitch

      public FontPitch getPitch()
      Specified by:
      getPitch in interface FontInfo
      Returns:
      the font pitch or null if unsupported
    • setPitch

      public void setPitch(FontPitch pitch)
      Description copied from interface: FontInfo
      Set the font pitch
      Specified by:
      setPitch in interface FontInfo
      Parameters:
      pitch - the font pitch