com.spire.doc
Class Hyphenation

java.lang.Object
  com.spire.doc.Hyphenation

public class Hyphenation
extends java.lang.Object

Class represents Hyphenation settings of the document.

Method Summary

boolean	getAutoHyphenation() Specifies whether to hyphenate the document contents automatically.
int	getConsecutiveHyphensLimit() Specifies the maximum number of consecutive lines of text that can end with a hyphen.
boolean	getHyphenateCaps() Specifies whether to hyphenate words in ALL CAPITAL LETTERS.
float	getHyphenationZone() Specifies the amount of whitespace which can be left at the end of a line (or added to justified lines) before hyphenation.
void	setAutoHyphenation(boolean value) Specifies whether to hyphenate the document contents automatically.
void	setConsecutiveHyphensLimit(int value) Specifies the maximum number of consecutive lines of text that can end with a hyphen.
void	setHyphenateCaps(boolean value) Specifies whether to hyphenate words in ALL CAPITAL LETTERS.
void	setHyphenationZone(float value) Specifies the amount of whitespace which can be left at the end of a line (or added to justified lines) before hyphenation.

Method Detail

getAutoHyphenation

public boolean getAutoHyphenation()

Specifies whether to hyphenate the document contents automatically.

Returns:

if automatically hyphenate the document contents, set to true.

setAutoHyphenation

public void setAutoHyphenation(boolean value)

Specifies whether to hyphenate the document contents automatically.

getHyphenateCaps

public boolean getHyphenateCaps()

Specifies whether to hyphenate words in ALL CAPITAL LETTERS.

Returns:

if hyphenate words in ALL CAPITAL LETTERS, set to true.

setHyphenateCaps

public void setHyphenateCaps(boolean value)

Specifies whether to hyphenate words in ALL CAPITAL LETTERS.

Parameters:

value - if hyphenate words in ALL CAPITAL LETTERS, set to true

getHyphenationZone

public float getHyphenationZone()

Specifies the amount of whitespace which can be left at the end of a line (or added to justified lines) before hyphenation.

Returns:

The hyphenation zone.

setHyphenationZone

public void setHyphenationZone(float value)

Specifies the amount of whitespace which can be left at the end of a line (or added to justified lines) before hyphenation.

Parameters:

value - The hyphenation zone.

getConsecutiveHyphensLimit

public int getConsecutiveHyphensLimit()

Specifies the maximum number of consecutive lines of text that can end with a hyphen.

Returns:

The consecutive hyphens limit.

setConsecutiveHyphensLimit

public void setConsecutiveHyphensLimit(int value)

Specifies the maximum number of consecutive lines of text that can end with a hyphen.

Parameters:

value - The consecutive hyphens limit.