Package org.docx4j.fonts.fop.fonts

Class SingleByteFont

java.lang.Object
org.docx4j.fonts.fop.fonts.Typeface
org.docx4j.fonts.fop.fonts.CustomFont
org.docx4j.fonts.fop.fonts.SingleByteFont
All Implemented Interfaces:
FontDescriptor, FontMetrics, MutableFont
public class SingleByteFont
extends CustomFont
Generic SingleByte font

  • Constructor Details

  • Method Details

    • isEmbeddable

      public boolean isEmbeddable()
      Indicates if this font may be embedded.
      Specified by:
      isEmbeddable in interface FontDescriptor
      Overrides:
      isEmbeddable in class CustomFont
      Returns:
      True, if embedding is possible/permitted

    • getEncodingName

      public java.lang.String getEncodingName()
      Get the encoding of the font.
      Specified by:
      getEncodingName in class Typeface
      Returns:
      the encoding

    • getEncoding

      public SingleByteEncoding getEncoding()
      Returns the code point mapping (encoding) of this font.
      Returns:
      the code point mapping

    • getWidth

      public int getWidth​(int i, int size)
      Return the width (in 1/1000ths of point size) of the character at code point i.
      Parameters:
      i - code point index
      size - font size
      Returns:
      the width of the character

    • getWidths

      public int[] getWidths()
      Return the array of widths.

      This is used to get an array for inserting in an output format. It should not be used for lookup.

      Returns:
      an array of widths

    • mapChar

      public char mapChar​(char c)
      Map a Unicode character to a code point in the font.
      Specified by:
      mapChar in class Typeface
      Parameters:
      c - character to map
      Returns:
      the mapped character

    • hasChar

      public boolean hasChar​(char c)
      Determines whether this font contains a particular character/glyph.
      Specified by:
      hasChar in class Typeface
      Parameters:
      c - character to check
      Returns:
      True if the character is supported, Falso otherwise

    • updateMapping

      protected void updateMapping​(java.lang.String encoding)
      Updates the mapping variable based on the encoding.
      Parameters:
      encoding - the name of the encoding

    • setEncoding

      public void setEncoding​(java.lang.String encoding)
      Sets the encoding of the font.
      Parameters:
      encoding - the encoding (ex. "WinAnsiEncoding" or "SymbolEncoding")

    • setEncoding

      public void setEncoding​(CodePointMapping encoding)
      Sets the encoding of the font.
      Parameters:
      encoding - the encoding information

    • setUseNativeEncoding

      public void setUseNativeEncoding​(boolean value)
      Controls whether the font is configured to use its native encoding or if it may need to be re-encoded for the target format.
      Parameters:
      value - true indicates that the configured encoding is the font's native encoding

    • isUsingNativeEncoding

      public boolean isUsingNativeEncoding()
      Indicates whether this font is configured to use its native encoding. This method is used to determine whether the font needs to be re-encoded.
      Returns:
      true if the font uses its native encoding.

    • setWidth

      public void setWidth​(int index, int w)
      Sets a width for a character.
      Parameters:
      index - index of the character
      w - the width of the character

    • addUnencodedCharacter

      public void addUnencodedCharacter​(NamedCharacter ch, int width)
      Adds an unencoded character (one that is not supported by the primary encoding).
      Parameters:
      ch - the named character
      width - the width of the character

    • encodeAllUnencodedCharacters

      public void encodeAllUnencodedCharacters()
      Makes all unencoded characters available through additional encodings. This method is used in cases where the fonts need to be encoded in the target format before all text of the document is processed (for example in PostScript when resource optimization is disabled).

    • hasAdditionalEncodings

      public boolean hasAdditionalEncodings()
      Indicates whether the encoding has additional encodings besides the primary encoding.
      Returns:
      true if there are additional encodings.

    • getAdditionalEncodingCount

      public int getAdditionalEncodingCount()
      Returns the number of additional encodings this single-byte font maintains.
      Returns:
      the number of additional encodings

    • getAdditionalEncoding

      public SimpleSingleByteEncoding getAdditionalEncoding​(int index) throws java.lang.IndexOutOfBoundsException
      Returns an additional encoding.
      Parameters:
      index - the index of the additional encoding
      Returns:
      the additional encoding
      Throws:
      java.lang.IndexOutOfBoundsException - if the index is out of bounds

    • getAdditionalWidths

      public int[] getAdditionalWidths​(int index)
      Returns an array with the widths for an additional encoding.
      Parameters:
      index - the index of the additional encoding
      Returns:
      the width array