Class TextRenderingOptions


  • public class TextRenderingOptions
    extends java.lang.Object
    Text rendering options, including the default language of the document and a flag to enable font glyph substitution (if FOP is available).
    Since:
    3.1.15
    See Also:
    Document.setTextRenderingOptions(TextRenderingOptions)
    • Constructor Summary

      Constructors 
      Constructor Description
      TextRenderingOptions()
      Creates a text rendering options instance with the default options: glyph substitution enabled and "dflt" as document language.
      TextRenderingOptions​(java.lang.String documentLanguage, boolean glyphSubstitutionEnabled)
      Creates a text rendering options instance.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDocumentLanguage()
      The default language of the document.
      boolean isGlyphSubstitutionEnabled()
      Returns the glyph substitution enabled flag.
      void setDocumentLanguage​(java.lang.String documentLanguage)
      Sets the default language of the document.
      void setGlyphSubstitutionEnabled​(boolean glyphSubstitutionEnabled)
      Sets the font glyph substitution enabled flag.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • DOCUMENT_LANGUAGE_DEFAULT

        public static final java.lang.String DOCUMENT_LANGUAGE_DEFAULT
        See Also:
        Constant Field Values
      • documentLanguage

        private java.lang.String documentLanguage
        The default language of the document. Can be set to values like "en_US". This language is used in FopGlyphProcessor to determine which glyphs are to be substituted. The default "dflt" means that all glyphs which can be replaced will be substituted.
      • glyphSubstitutionEnabled

        private boolean glyphSubstitutionEnabled
    • Constructor Detail

      • TextRenderingOptions

        public TextRenderingOptions()
        Creates a text rendering options instance with the default options: glyph substitution enabled and "dflt" as document language.
      • TextRenderingOptions

        public TextRenderingOptions​(java.lang.String documentLanguage,
                                    boolean glyphSubstitutionEnabled)
        Creates a text rendering options instance.
        Parameters:
        documentLanguage - the wanted language
        glyphSubstitutionEnabled - whether glyph substitution is enabled
    • Method Detail

      • getDocumentLanguage

        public java.lang.String getDocumentLanguage()
        The default language of the document. Can be set to values like "en_US". This language is used in FopGlyphProcessor to determine which glyphs are to be substituted.

        The default "dflt" means that all glyphs which can be replaced will be substituted.

        Returns:
        the current document language
      • setDocumentLanguage

        public void setDocumentLanguage​(java.lang.String documentLanguage)
        Sets the default language of the document.
        Parameters:
        documentLanguage - the document language
        See Also:
        getDocumentLanguage()
      • setGlyphSubstitutionEnabled

        public void setGlyphSubstitutionEnabled​(boolean glyphSubstitutionEnabled)
        Sets the font glyph substitution enabled flag.
        Parameters:
        glyphSubstitutionEnabled - whether glyph substitution is enabled