Class CommonHyphenation


  • public final class CommonHyphenation
    extends java.lang.Object
    Store all common hyphenation properties. See Sec. 7.9 of the XSL-FO Standard. Public "structure" allows direct member access.
    • Field Detail

      • language

        public final StringProperty language
        The "language" property
      • hyphenate

        public final EnumProperty hyphenate
        The "hyphenate" property
      • hyphenationCharacter

        public final CharacterProperty hyphenationCharacter
        The "hyphenation-character" property
      • hyphenationPushCharacterCount

        public final NumberProperty hyphenationPushCharacterCount
        The "hyphenation-push-character-count" property
      • hyphenationRemainCharacterCount

        public final NumberProperty hyphenationRemainCharacterCount
        The "hyphenation-remain-character-count" property
    • Method Detail

      • getInstance

        public static CommonHyphenation getInstance​(PropertyList propertyList)
                                             throws PropertyException
        Gets the canonical CommonHyphenation instance corresponding to the values of the related properties present on the given PropertyList
        Parameters:
        propertyList - the PropertyList
        Returns:
        a common hyphenation instance
        Throws:
        PropertyException - if a a property exception occurs
      • getHyphChar

        public char getHyphChar​(Font font)
        Returns the effective hyphenation character for a font. The hyphenation character specified in XSL-FO may be substituted if it's not available in the font.
        Parameters:
        font - the font
        Returns:
        the effective hyphenation character.
      • getHyphIPD

        public int getHyphIPD​(Font font)
        Returns the IPD for the hyphenation character for a font.
        Parameters:
        font - the font
        Returns:
        the IPD in millipoints for the hyphenation character.
      • getLocale

        public java.util.Locale getLocale()
        Creates and returns a Locale representation of the language and country.
        Returns:
        the language (and the country if set) represented as a locale, null if the language has not been set (i.e., has been left to its initial value of "none")
      • toLocale

        public static java.util.Locale toLocale​(java.lang.String language,
                                                java.lang.String country)
        Creates and returns a Locale representation of the given language, and the given country if set. The country is considered to be set if not null and not set to "none".
        Returns:
        the language and country represented as a locale, null if the language is null or "none" (case insensitive)
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object