Class RMFontFile

  • All Implemented Interfaces:
    RMArchiver.Archiving, java.lang.Cloneable

    public class RMFontFile
    extends RMObject
    This class represents all the information about a font that is independent of size. This allows RMFont to be lighter weight (essentially just a font file at a given size).
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.awt.Font awt()
      Returns the AWT font represented by the font file.
      boolean canDisplay​(char aChar)
      Returns if this font can display the given char.
      float charAdvance​(char aChar)
      Returns the char advance for the given char.
      float charKern​(char aChar1, char aChar2)
      Returns the kerning for the given pair of characters (no way to do this in Java!).
      RMPath charPath​(char aChar)
      Returns the path for a given character.
      RMFontFile getBold()
      Returns the bold version of this font.
      java.lang.String getFamily()
      Returns the family name of this font.
      java.lang.String getFamilyEnglish()
      Returns the family name of this font in English.
      static RMFontFile getFontFile​(java.lang.String aName)
      Returns a font file for a given font name.
      java.lang.String getFontName()
      Returns the name of this font.
      java.lang.String getFontNameEnglish()
      Returns the name of this font in English.
      float getHeight()
      Returns the height of this font file.
      RMFontFile getItalic()
      Returns the italic version of this font.
      float getLeading()
      Returns the default distance between lines for this font.
      float getLineHeight()
      Returns the height of a line of text in this font.
      float getMaxAdvance()
      Returns the max advance of characters in this font.
      float getMaxAscent()
      Returns the max distance above the baseline that this font goes.
      float getMaxDescent()
      Returns the max distance below the baseline that this font goes.
      java.lang.String getPSName()
      Returns the PostScript name of this font.
      float getStrikethroughOffset()
      Returns the distance above the baseline that a strikethrough should be drawn.
      float getUnderlineOffset()
      Returns the distance below the baseline that an underline should be drawn.
      float getUnderlineThickness()
      Returns the default thickness that an underline should be drawn.
      boolean isBold()
      Returns whether this font is considered bold.
      boolean isItalic()
      Returns whether this font is considered italic.
      int style()
      Returns the awt style of this font.
      java.lang.String toString()
      Returns the font name of this font file.
      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Method Detail

      • getFontFile

        public static RMFontFile getFontFile​(java.lang.String aName)
        Returns a font file for a given font name.
      • awt

        public java.awt.Font awt()
        Returns the AWT font represented by the font file.
      • getFontName

        public java.lang.String getFontName()
        Returns the name of this font.
      • getFontNameEnglish

        public java.lang.String getFontNameEnglish()
        Returns the name of this font in English.
      • getFamily

        public java.lang.String getFamily()
        Returns the family name of this font.
      • getFamilyEnglish

        public java.lang.String getFamilyEnglish()
        Returns the family name of this font in English.
      • getPSName

        public java.lang.String getPSName()
        Returns the PostScript name of this font.
      • charAdvance

        public float charAdvance​(char aChar)
        Returns the char advance for the given char.
      • charKern

        public float charKern​(char aChar1,
                              char aChar2)
        Returns the kerning for the given pair of characters (no way to do this in Java!).
      • charPath

        public RMPath charPath​(char aChar)
        Returns the path for a given character.
      • getMaxAscent

        public float getMaxAscent()
        Returns the max distance above the baseline that this font goes.
      • getMaxDescent

        public float getMaxDescent()
        Returns the max distance below the baseline that this font goes.
      • getLeading

        public float getLeading()
        Returns the default distance between lines for this font.
      • getHeight

        public float getHeight()
        Returns the height of this font file.
      • getLineHeight

        public float getLineHeight()
        Returns the height of a line of text in this font.
      • getMaxAdvance

        public float getMaxAdvance()
        Returns the max advance of characters in this font.
      • getUnderlineOffset

        public float getUnderlineOffset()
        Returns the distance below the baseline that an underline should be drawn.
      • getUnderlineThickness

        public float getUnderlineThickness()
        Returns the default thickness that an underline should be drawn.
      • getStrikethroughOffset

        public float getStrikethroughOffset()
        Returns the distance above the baseline that a strikethrough should be drawn.
      • isBold

        public boolean isBold()
        Returns whether this font is considered bold.
      • isItalic

        public boolean isItalic()
        Returns whether this font is considered italic.
      • style

        public int style()
        Returns the awt style of this font.
      • canDisplay

        public boolean canDisplay​(char aChar)
        Returns if this font can display the given char.
      • getBold

        public RMFontFile getBold()
        Returns the bold version of this font.
      • getItalic

        public RMFontFile getItalic()
        Returns the italic version of this font.
      • toString

        public java.lang.String toString()
        Returns the font name of this font file.
        Overrides:
        toString in class java.lang.Object