com.lowagie.text.pdf.hyphenation
Class Hyphenator

java.lang.Object
  com.lowagie.text.pdf.hyphenation.Hyphenator

public class Hyphenator
extends java.lang.Object

This class is the main entry point to the hyphenation package. You can use only the static methods or create an instance.

Author:

Carlos Villegas

Field Summary

private static boolean	errorDump
private static java.lang.String	hyphenDir Holds value of property hyphenDir.
private HyphenationTree	hyphenTree
(package private) static java.util.Hashtable	hyphenTrees
private int	pushCharCount
private int	remainCharCount

Constructor Summary

Hyphenator(java.lang.String lang, java.lang.String country, int leftMin, int rightMin)

Method Summary

static HyphenationTree	getFopHyphenationTree(java.lang.String key)
static HyphenationTree	getHyphenationTree(java.lang.String lang, java.lang.String country)
static java.lang.String	getHyphenDir() Getter for property hyphenDir.
private static java.io.InputStream	getResourceStream(java.lang.String key)
static HyphenationTree	getUserHyphenationTree(java.lang.String key, java.lang.String hyphenDir) load tree from serialized file or xml file using configuration settings
Hyphenation	hyphenate(char[] word, int offset, int len)
Hyphenation	hyphenate(java.lang.String word)
static Hyphenation	hyphenate(java.lang.String lang, java.lang.String country, char[] word, int offset, int len, int leftMin, int rightMin)
static Hyphenation	hyphenate(java.lang.String lang, java.lang.String country, java.lang.String word, int leftMin, int rightMin)
static void	setHyphenDir(java.lang.String _hyphenDir) Setter for property hyphenDir.
void	setLanguage(java.lang.String lang, java.lang.String country)
void	setMinPushCharCount(int min)
void	setMinRemainCharCount(int min)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

hyphenTrees

static java.util.Hashtable hyphenTrees

hyphenTree

private HyphenationTree hyphenTree

remainCharCount

private int remainCharCount

pushCharCount

private int pushCharCount

errorDump

private static boolean errorDump

hyphenDir

private static java.lang.String hyphenDir

Holds value of property hyphenDir.

Constructor Detail

Hyphenator

public Hyphenator(java.lang.String lang,
                  java.lang.String country,
                  int leftMin,
                  int rightMin)

Method Detail

getHyphenationTree

public static HyphenationTree getHyphenationTree(java.lang.String lang,
                                                 java.lang.String country)

getResourceStream

private static java.io.InputStream getResourceStream(java.lang.String key)

getFopHyphenationTree

public static HyphenationTree getFopHyphenationTree(java.lang.String key)

getUserHyphenationTree

public static HyphenationTree getUserHyphenationTree(java.lang.String key,
                                                     java.lang.String hyphenDir)

load tree from serialized file or xml file using configuration settings

hyphenate

public static Hyphenation hyphenate(java.lang.String lang,
                                    java.lang.String country,
                                    java.lang.String word,
                                    int leftMin,
                                    int rightMin)

hyphenate

public static Hyphenation hyphenate(java.lang.String lang,
                                    java.lang.String country,
                                    char[] word,
                                    int offset,
                                    int len,
                                    int leftMin,
                                    int rightMin)

setMinRemainCharCount

public void setMinRemainCharCount(int min)

setMinPushCharCount

public void setMinPushCharCount(int min)

setLanguage

public void setLanguage(java.lang.String lang,
                        java.lang.String country)

hyphenate

public Hyphenation hyphenate(char[] word,
                             int offset,
                             int len)

hyphenate

public Hyphenation hyphenate(java.lang.String word)

getHyphenDir

public static java.lang.String getHyphenDir()

Getter for property hyphenDir.

Returns:

Value of property hyphenDir.

setHyphenDir

public static void setHyphenDir(java.lang.String _hyphenDir)

Setter for property hyphenDir.

Parameters:

_hyphenDir - New value of property hyphenDir.