Class HyphenationConfig


  • public class HyphenationConfig
    extends java.lang.Object
    This is the class used to configure hyphenation on layout level
    • Field Detail

      • hyphenator

        protected Hyphenator hyphenator
        The Hyphenator object.
      • hyphenSymbol

        protected char hyphenSymbol
        The hyphenation symbol used when hyphenating.
    • Constructor Detail

      • HyphenationConfig

        public HyphenationConfig​(int leftMin,
                                 int rightMin)
        Constructs a new HyphenationConfig. No language hyphenation files will be used. Only soft hyphen symbols ('­') will be taken into account.
        Parameters:
        leftMin - the minimum number of characters before the hyphenation point
        rightMin - the minimum number of characters after the hyphenation point
      • HyphenationConfig

        public HyphenationConfig​(java.lang.String lang,
                                 java.lang.String country,
                                 int leftMin,
                                 int rightMin)
        Constructs a new HyphenationConfig instance.
        Parameters:
        lang - the language
        country - the optional country code (may be null or "none")
        leftMin - the minimum number of characters before the hyphenation point
        rightMin - the minimum number of characters after the hyphenation point
    • Method Detail

      • hyphenate

        public Hyphenation hyphenate​(java.lang.String word)
        Hyphenates a given word.
        Parameters:
        word - Tee word to hyphenate
        Returns:
        Hyphenation object representing possible hyphenation points or null if no hyphenation points are found.
      • getHyphenSymbol

        public char getHyphenSymbol()
        Gets the hyphenation symbol.
        Returns:
        the hyphenation symbol
      • setHyphenSymbol

        public void setHyphenSymbol​(char hyphenSymbol)
        Sets the hyphenation symbol to the specified value.
        Parameters:
        hyphenSymbol - the new hyphenation symbol