This class is the main entry point to the hyphenation package. More...

Public Member Functions
	Hyphenator (String lang, String country, int leftMin, int rightMin)
	Creates a new hyphenator. More...

	Hyphenator (String lang, String country, int leftMin, int rightMin, IDictionary< String, String > hyphPathNames)
	Creates a new hyphenator. More...

iText.Layout.Hyphenation.Hyphenation	Hyphenate (String word)
	Hyphenates a word. More...

Static Public Member Functions
static void	RegisterAdditionalHyphenationFileDirectory (String directory)
	Registers additional file directories. More...

static HyphenationTreeCache	GetHyphenationTreeCache ()
	Returns the default hyphenation tree cache. More...

static void	ClearHyphenationTreeCache ()
	Clears the default hyphenation tree cache. More...

static HyphenationTree	GetHyphenationTree (String lang, String country, IDictionary< String, String > hyphPathNames)
	Returns a hyphenation tree for a given language and country, with fallback from (lang,country) to (lang). More...

static HyphenationTree	GetHyphenationTree2 (String lang, String country, IDictionary< String, String > hyphPathNames)
	Returns a hyphenation tree for a given language and country. More...

static HyphenationTree	GetHyphenationTree (String searchDirectory, String key)
	Load tree from xml file using configuration settings. More...

static HyphenationTree	GetHyphenationTree (Stream @in, String name)
	Load tree from the stream. More...

static iText.Layout.Hyphenation.Hyphenation	Hyphenate (String lang, String country, IDictionary< String, String > hyphPathNames, String word, int leftMin, int rightMin)
	Hyphenates a word. More...

static iText.Layout.Hyphenation.Hyphenation	Hyphenate (String lang, String country, String word, int leftMin, int rightMin)
	Hyphenates a word. More...

Package Attributes
String	lang

String	country

Detailed Description

This class is the main entry point to the hyphenation package.

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@u.nosp@m.nisc.nosp@m.ope.c.nosp@m.o.jp).

Constructor & Destructor Documentation

◆ Hyphenator() [1/2]

iText.Layout.Hyphenation.Hyphenator.Hyphenator	(	String	lang,
		String	country,
		int	leftMin,
		int	rightMin
	)

inline

Creates a new hyphenator.

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

◆ Hyphenator() [2/2]

iText.Layout.Hyphenation.Hyphenator.Hyphenator	(	String	lang,
		String	country,
		int	leftMin,
		int	rightMin,
		IDictionary< String, String >	hyphPathNames
	)

inline

Creates a new hyphenator.

Parameters

lang	the language
country	the optional country code (may be null or "none")
hyphPathNames	the map with user-configured hyphenation pattern file names
leftMin	the minimum number of characters before the hyphenation point
rightMin	the minimum number of characters after the hyphenation point

Member Function Documentation

◆ ClearHyphenationTreeCache()

static void iText.Layout.Hyphenation.Hyphenator.ClearHyphenationTreeCache ( )

inlinestatic

Clears the default hyphenation tree cache.

Clears the default hyphenation tree cache. This method can be used if the underlying data files are changed at runtime.

◆ GetHyphenationTree() [1/3]

static HyphenationTree iText.Layout.Hyphenation.Hyphenator.GetHyphenationTree	(	Stream @	in,
		String	name
	)

inlinestatic

Load tree from the stream.

Parameters

in	the input stream to load the tree from
name	unique key representing country-language combination

Returns: the requested HyphenationTree or null if it is not available

◆ GetHyphenationTree() [2/3]

static HyphenationTree iText.Layout.Hyphenation.Hyphenator.GetHyphenationTree	(	String	lang,
		String	country,
		IDictionary< String, String >	hyphPathNames
	)

inlinestatic

Returns a hyphenation tree for a given language and country, with fallback from (lang,country) to (lang).

Returns a hyphenation tree for a given language and country, with fallback from (lang,country) to (lang). The hyphenation trees are cached.

Parameters

lang	the language
country	the country (may be null or "none")
hyphPathNames	the map with user-configured hyphenation pattern file names

Returns: the hyphenation tree

◆ GetHyphenationTree() [3/3]

static HyphenationTree iText.Layout.Hyphenation.Hyphenator.GetHyphenationTree	(	String	searchDirectory,
		String	key
	)

inlinestatic

Load tree from xml file using configuration settings.

Parameters

searchDirectory	the directory to search the file into
key	language key for the requested hyphenation file

Returns: the requested HyphenationTree or null if it is not available

◆ GetHyphenationTree2()

static HyphenationTree iText.Layout.Hyphenation.Hyphenator.GetHyphenationTree2	(	String	lang,
		String	country,
		IDictionary< String, String >	hyphPathNames
	)

inlinestatic

Returns a hyphenation tree for a given language and country.

Returns a hyphenation tree for a given language and country. The hyphenation trees are cached.

Parameters

lang	the language
country	the country (may be null or "none")
hyphPathNames	the map with user-configured hyphenation pattern file names

Returns: the hyphenation tree

◆ GetHyphenationTreeCache()

static HyphenationTreeCache iText.Layout.Hyphenation.Hyphenator.GetHyphenationTreeCache ( )

inlinestatic

Returns the default hyphenation tree cache.

Returns: the default (static) hyphenation tree cache

◆ Hyphenate() [1/3]

static iText.Layout.Hyphenation.Hyphenation iText.Layout.Hyphenation.Hyphenator.Hyphenate	(	String	lang,
		String	country,
		IDictionary< String, String >	hyphPathNames,
		String	word,
		int	leftMin,
		int	rightMin
	)

inlinestatic

Hyphenates a word.

Parameters

lang	the language
country	the optional country code (may be null or "none")
hyphPathNames	the map with user-configured hyphenation pattern file names
word	the word to hyphenate
leftMin	the minimum number of characters before the hyphenation point
rightMin	the minimum number of characters after the hyphenation point

Returns: the hyphenation result

◆ Hyphenate() [2/3]

static iText.Layout.Hyphenation.Hyphenation iText.Layout.Hyphenation.Hyphenator.Hyphenate	(	String	lang,
		String	country,
		String	word,
		int	leftMin,
		int	rightMin
	)

inlinestatic

Hyphenates a word.

Parameters

lang	the language
country	the optional country code (may be null or "none")
word	the word to hyphenate
leftMin	the minimum number of characters before the hyphenation point
rightMin	the minimum number of characters after the hyphenation point

Returns: the hyphenation result

◆ Hyphenate() [3/3]

iText.Layout.Hyphenation.Hyphenation iText.Layout.Hyphenation.Hyphenator.Hyphenate ( String word )

inline

Hyphenates a word.

Parameters

word	the word to hyphenate

Returns: the hyphenation result

◆ RegisterAdditionalHyphenationFileDirectory()

static void iText.Layout.Hyphenation.Hyphenator.RegisterAdditionalHyphenationFileDirectory ( String directory )

inlinestatic

Registers additional file directories.

Parameters

directory directory to register

Public Member Functions

Static Public Member Functions

Package Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Hyphenator() [1/2]

◆ Hyphenator() [2/2]

Member Function Documentation

◆ ClearHyphenationTreeCache()

◆ GetHyphenationTree() [1/3]

◆ GetHyphenationTree() [2/3]

◆ GetHyphenationTree() [3/3]

◆ GetHyphenationTree2()

◆ GetHyphenationTreeCache()

◆ Hyphenate() [1/3]

◆ Hyphenate() [2/3]

◆ Hyphenate() [3/3]

◆ RegisterAdditionalHyphenationFileDirectory()