|
fop 1.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.fop.hyphenation.Hyphenator
public final class Hyphenator
This class is the main entry point to the hyphenation package. You can use only the static methods or create an instance.
This work was authored by Carlos Villegas (cav@uniscope.co.jp).
Field Summary | |
---|---|
protected static org.apache.commons.logging.Log |
log
logging instance |
Method Summary | |
---|---|
static HyphenationTree |
getFopHyphenationTree(java.lang.String key)
Returns a hyphenation tree. |
static HyphenationTree |
getHyphenationTree(java.lang.String lang,
java.lang.String country,
HyphenationTreeResolver resolver,
java.util.Map hyphPatNames)
Returns a hyphenation tree for a given language and country, with fallback from (lang,country) to (lang). |
static HyphenationTreeCache |
getHyphenationTreeCache()
|
static HyphenationTree |
getUserHyphenationTree(java.lang.String key,
HyphenationTreeResolver resolver)
Load tree from serialized file or xml file using configuration settings |
static HyphenationTree |
getUserHyphenationTree(java.lang.String key,
java.lang.String hyphenDir)
Load tree from serialized file or xml file using configuration settings |
static Hyphenation |
hyphenate(java.lang.String lang,
java.lang.String country,
HyphenationTreeResolver resolver,
java.util.Map hyphPatNames,
java.lang.String word,
int leftMin,
int rightMin)
Hyphenates a word. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final org.apache.commons.logging.Log log
Method Detail |
---|
public static HyphenationTreeCache getHyphenationTreeCache()
public static HyphenationTree getHyphenationTree(java.lang.String lang, java.lang.String country, HyphenationTreeResolver resolver, java.util.Map hyphPatNames)
lang
- the languagecountry
- the country (may be null or "none")resolver
- resolver to find the hyphenation fileshyphPatNames
- the map with user-configured hyphenation pattern file names
public static HyphenationTree getFopHyphenationTree(java.lang.String key)
key
- the language/country key
public static HyphenationTree getUserHyphenationTree(java.lang.String key, java.lang.String hyphenDir)
key
- language key for the requested hyphenation filehyphenDir
- base directory to find hyphenation files in
public static HyphenationTree getUserHyphenationTree(java.lang.String key, HyphenationTreeResolver resolver)
key
- language key for the requested hyphenation fileresolver
- resolver to find the hyphenation files
public static Hyphenation hyphenate(java.lang.String lang, java.lang.String country, HyphenationTreeResolver resolver, java.util.Map hyphPatNames, java.lang.String word, int leftMin, int rightMin)
lang
- the languagecountry
- the optional country code (may be null or "none")resolver
- resolver to find the hyphenation fileshyphPatNames
- the map with user-configured hyphenation pattern file namesword
- the word to hyphenateleftMin
- the minimum number of characters before the hyphenation pointrightMin
- the minimum number of characters after the hyphenation point
|
fop 1.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |