com.lowagie.text.pdf

Class HyphenationAuto

public class HyphenationAuto extends Object implements HyphenationEvent

Hyphenates words automatically accordingly to the language and country. The hyphenator engine was taken from FOP and uses the TEX patterns. If a language is not provided and a TEX pattern for it exists, it can be easily adapted.

Author: Paulo Soares (psoares@consiste.pt)

Field Summary
protected Hyphenatorhyphenator
The hyphenator engine.
protected Stringpost
The second part of the hyphenated word.
Constructor Summary
HyphenationAuto(String lang, String country, int leftMin, int rightMin)
Creates a new hyphenation instance usable in Chunk.
Method Summary
StringgetHyphenatedWordPost()
Gets the second part of the hyphenated word.
StringgetHyphenatedWordPre(String word, BaseFont font, float fontSize, float remainingWidth)
Hyphenates a word and returns the first part of it.
StringgetHyphenSymbol()
Gets the hyphen symbol.

Field Detail

hyphenator

protected Hyphenator hyphenator
The hyphenator engine.

post

protected String post
The second part of the hyphenated word.

Constructor Detail

HyphenationAuto

public HyphenationAuto(String lang, String country, int leftMin, int rightMin)
Creates a new hyphenation instance usable in Chunk.

Parameters: lang the language ("en" for english, for example) country the country ("GB" for Great-Britain or "none" for no country, for example) leftMin the minimun number of letters before the hyphen rightMin the minimun number of letters after the hyphen

Method Detail

getHyphenatedWordPost

public String getHyphenatedWordPost()
Gets the second part of the hyphenated word. Must be called after getHyphenatedWordPre().

Returns: the second part of the hyphenated word

getHyphenatedWordPre

public String getHyphenatedWordPre(String word, BaseFont font, float fontSize, float remainingWidth)
Hyphenates a word and returns the first part of it. To get the second part of the hyphenated word call getHyphenatedWordPost().

Parameters: word the word to hyphenate font the font used by this word fontSize the font size used by this word remainingWidth the width available to fit this word in

Returns: the first part of the hyphenated word including the hyphen symbol, if any

getHyphenSymbol

public String getHyphenSymbol()
Gets the hyphen symbol.

Returns: the hyphen symbol