Class HSLFFontInfo

java.lang.Object
org.apache.poi.hslf.usermodel.HSLFFontInfo
All Implemented Interfaces:
FontInfo

public class HSLFFontInfo extends Object implements FontInfo
Represents a Font used in a presentation.

In PowerPoint Font is a shared resource and can be shared among text object in the presentation.

Since:
POI 3.17-beta2
  • Constructor Details

    • HSLFFontInfo

      public HSLFFontInfo(String typeface)
      Creates a new instance of HSLFFontInfo with more or sensible defaults.

      If you don't use default fonts (see HSLFFontInfoPredefined) then the results of the font substitution will be better, if you also specify the other properties.

      Parameters:
      typeface - the font name
    • HSLFFontInfo

      public HSLFFontInfo(FontEntityAtom fontAtom)
      Creates a new instance of HSLFFontInfo and initialize it from the supplied font atom
    • HSLFFontInfo

      public HSLFFontInfo(FontInfo fontInfo)
  • Method Details

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

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

      public FontCharset getCharset()
      Specified by:
      getCharset in interface FontInfo
      Returns:
      the font 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
    • getRenderType

      public HSLFFontInfo.FontRenderType getRenderType()
    • setRenderType

      public void setRenderType(HSLFFontInfo.FontRenderType renderType)
    • isEmbedSubsetted

      public boolean isEmbedSubsetted()
    • setEmbedSubsetted

      public void setEmbedSubsetted(boolean embedSubset)
    • isFontSubstitutable

      public boolean isFontSubstitutable()
    • setFontSubstitutable

      public void setFontSubstitutable(boolean isSubstitutable)
    • createRecord

      public FontEntityAtom createRecord()