Package com.itextpdf.text.pdf.hyphenation

Class Hyphenator

java.lang.Object

com.itextpdf.text.pdf.hyphenation.Hyphenator

public class Hyphenator
extends 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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static HyphenationTree	getFileHyphenationTree(String key)
static HyphenationTree	getHyphenationTree(String lang, String country)
static String	getHyphenDir()	Getter for property hyphenDir.
static HyphenationTree	getResourceHyphenationTree(String key)
Hyphenation	hyphenate(char[] word, int offset, int len)
Hyphenation	hyphenate(String word)
static Hyphenation	hyphenate(String lang, String country, char[] word, int offset, int len, int leftMin, int rightMin)
static Hyphenation	hyphenate(String lang, String country, String word, int leftMin, int rightMin)
static void	setHyphenDir(String _hyphenDir)	Setter for property hyphenDir.
void	setLanguage(String 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

Constructor Detail

Hyphenator

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

Parameters:

lang -

country -

leftMin -

rightMin -

Method Detail

getHyphenationTree

public static HyphenationTree getHyphenationTree(String lang,
                                                 String country)

Parameters:

lang -

country -

Returns:

the hyphenation tree

getResourceHyphenationTree

public static HyphenationTree getResourceHyphenationTree(String key)

Parameters:

key -

Returns:

a hyphenation tree

getFileHyphenationTree

public static HyphenationTree getFileHyphenationTree(String key)

Parameters:

key -

Returns:

a hyphenation tree

hyphenate

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

Parameters:

lang -

country -

word -

leftMin -

rightMin -

Returns:

a hyphenation object

hyphenate

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

Parameters:

lang -

country -

word -

offset -

len -

leftMin -

rightMin -

Returns:

a hyphenation object

setMinRemainCharCount

public void setMinRemainCharCount(int min)

Parameters:

min -

setMinPushCharCount

public void setMinPushCharCount(int min)

Parameters:

min -

setLanguage

public void setLanguage(String lang,
                        String country)

Parameters:

lang -

country -

hyphenate

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

Parameters:

word -

offset -

len -

Returns:

a hyphenation object

hyphenate

public Hyphenation hyphenate(String word)

Parameters:

word -

Returns:

a hyphenation object

getHyphenDir

public static String getHyphenDir()

Getter for property hyphenDir.

Returns:

Value of property hyphenDir.

setHyphenDir

public static void setHyphenDir(String _hyphenDir)

Setter for property hyphenDir.

Parameters:

_hyphenDir - New value of property hyphenDir.