com.itextpdf.layout.hyphenation

Class HyphenationConfig

java.lang.Object

com.itextpdf.layout.hyphenation.HyphenationConfig

public class HyphenationConfig
extends Object

This is the class used to configure hyphenation on layout level

Field Summary

Fields

Modifier and Type	Field and Description
protected Hyphenator	hyphenator The Hyphenator object.
protected char	hyphenSymbol The hyphenation symbol used when hyphenating.

Constructor Summary

Constructors

Constructor and Description
HyphenationConfig(Hyphenator hyphenator) Constructs a new HyphenationConfig by a Hyphenator which will be used to find hyphenation points.
HyphenationConfig(int leftMin, int rightMin) Constructs a new HyphenationConfig.
HyphenationConfig(String lang, String country, int leftMin, int rightMin) Constructs a new HyphenationConfig instance.

Method Summary

Modifier and Type	Method and Description
char	getHyphenSymbol() Gets the hyphenation symbol.
Hyphenation	hyphenate(String word) Hyphenates a given word.
void	setHyphenSymbol(char hyphenSymbol) Sets the hyphenation symbol to the specified value.

Methods inherited from class java.lang.Object

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

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(Hyphenator hyphenator)

Constructs a new HyphenationConfig by a Hyphenator which will be used to find hyphenation points.

Parameters:

hyphenator - the Hyphenator instance

HyphenationConfig

public HyphenationConfig(String 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(String word)

Hyphenates a given word.

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