org.apache.fop.layout.hyphenation
Class Hyphenator


public class Hyphenator

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
 (package private) static HashtablehyphenTrees
           

Constructor Summary
Hyphenator(String lang, String country, int leftMin, int rightMin)
           

Method Summary
 static HyphenationTreegetFopHyphenationTree(String key)
           
 static HyphenationTreegetHyphenationTree(String lang, String country)
           
 static HyphenationTreegetUserHyphenationTree(String key, String hyphenDir)
          load tree from serialized file or xml file using configuration settings
 static Hyphenationhyphenate(String lang, String country, String word, int leftMin, int rightMin)
           
 static Hyphenationhyphenate(String lang, String country, char[] word, int offset, int len, int leftMin, int rightMin)
           
 Hyphenationhyphenate(char[] word, int offset, int len)
           
 Hyphenationhyphenate(String word)
           
 voidsetLanguage(String lang, String country)
           
 voidsetMinPushCharCount(int min)
           
 voidsetMinRemainCharCount(int min)
           

Field Detail

hyphenTrees

static Hashtable hyphenTrees
Constructor Detail

Hyphenator

public Hyphenator(String lang, String country, int leftMin, int rightMin)
Method Detail

getFopHyphenationTree

public static HyphenationTree getFopHyphenationTree(String key)

getHyphenationTree

public static HyphenationTree getHyphenationTree(String lang, String country)

getUserHyphenationTree

public static HyphenationTree getUserHyphenationTree(String key, String hyphenDir)
load tree from serialized file or xml file using configuration settings

hyphenate

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

hyphenate

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

hyphenate

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

hyphenate

public Hyphenation hyphenate(String word)

setLanguage

public void setLanguage(String lang, String country)

setMinPushCharCount

public void setMinPushCharCount(int min)

setMinRemainCharCount

public void setMinRemainCharCount(int min)

Association Links

to Class java.util.Hashtable

to Class org.apache.fop.layout.hyphenation.HyphenationTree