iText 9.6.0 API
Public Member Functions | Package Attributes | List of all members
iText.Layout.Hyphenation.HyphenationConfig Class Reference

This is the class used to configure hyphenation on layout level More...

Public Member Functions
  HyphenationConfig (int leftMin, int rightMin)
  Constructs a new HyphenationConfig. More...
 
  HyphenationConfig (Hyphenator hyphenator)
  Constructs a new HyphenationConfig by a Hyphenator which will be used to find hyphenation points. More...
 
  HyphenationConfig (String lang, String country, int leftMin, int rightMin)
  Constructs a new HyphenationConfig instance. More...
 
virtual iText.Layout.Hyphenation.Hyphenation  Hyphenate (String word)
  Hyphenates a given word. More...
 
virtual char  GetHyphenSymbol ()
  Gets the hyphenation symbol. More...
 
virtual void  SetHyphenSymbol (char hyphenSymbol)
  Sets the hyphenation symbol to the specified value. More...
 

Package Attributes
Hyphenator  hyphenator
  The Hyphenator object. More...
 
char  hyphenSymbol = '-'
  The hyphenation symbol used when hyphenating. More...
 

Detailed Description

This is the class used to configure hyphenation on layout level

Constructor & Destructor Documentation

◆ HyphenationConfig() [1/3]

iText.Layout.Hyphenation.HyphenationConfig.HyphenationConfig ( int  leftMin,
int  rightMin 
)
inline

Constructs a new HyphenationConfig.

Constructs a new HyphenationConfig . No language hyphenation files will be used. Only soft hyphen symbols ('\u00ad') 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() [2/3]

iText.Layout.Hyphenation.HyphenationConfig.HyphenationConfig ( Hyphenator  hyphenator )
inline

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

Parameters
hyphenator the Hyphenator instance

◆ HyphenationConfig() [3/3]

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

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

Member Function Documentation

◆ GetHyphenSymbol()

virtual char iText.Layout.Hyphenation.HyphenationConfig.GetHyphenSymbol ( )
inlinevirtual

Gets the hyphenation symbol.

Returns
the hyphenation symbol

◆ Hyphenate()

virtual iText.Layout.Hyphenation.Hyphenation iText.Layout.Hyphenation.HyphenationConfig.Hyphenate ( String  word )
inlinevirtual

Hyphenates a given word.

Returns

Hyphenation object representing possible hyphenation points or null if no hyphenation points are found.

Parameters
word Tee word to hyphenate

◆ SetHyphenSymbol()

virtual void iText.Layout.Hyphenation.HyphenationConfig.SetHyphenSymbol ( char  hyphenSymbol )
inlinevirtual

Sets the hyphenation symbol to the specified value.

Parameters
hyphenSymbol the new hyphenation symbol

Member Data Documentation

◆ hyphenator

Hyphenator iText.Layout.Hyphenation.HyphenationConfig.hyphenator
package

The Hyphenator object.

◆ hyphenSymbol

char iText.Layout.Hyphenation.HyphenationConfig.hyphenSymbol = '-'
package

The hyphenation symbol used when hyphenating.