Class CommonHyphenation

java.lang.Object

org.apache.fop.fo.properties.CommonHyphenation

public final class CommonHyphenation
extends Object

Store all common hyphenation properties. See Sec. 7.9 of the XSL-FO Standard. Public "structure" allows direct member access.

Field Summary

Fields

Modifier and Type	Field	Description
private static final PropertyCache<CommonHyphenation>	CACHE
final StringProperty	country	The "country" property
private int	hash
private static final char	HYPHEN_MINUS
final EnumProperty	hyphenate	The "hyphenate" property
final OptionalCharacterProperty	hyphenationCharacter	The "hyphenation-character" property
final NumberProperty	hyphenationPushCharacterCount	The "hyphenation-push-character-count" property
final NumberProperty	hyphenationRemainCharacterCount	The "hyphenation-remain-character-count" property
final StringProperty	language	The "language" property
private static final org.apache.commons.logging.Log	LOG	Logger
private static final char	MINUS_SIGN
final StringProperty	script	The "script" property

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CommonHyphenation(StringProperty language, StringProperty country, StringProperty script, EnumProperty hyphenate, OptionalCharacterProperty hyphenationCharacter, NumberProperty hyphenationPushCharacterCount, NumberProperty hyphenationRemainCharacterCount)	Construct a CommonHyphenation object holding the given properties

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Character	getHyphChar(Font font)	Returns the effective hyphenation character for a font.
int	getHyphIPD(Font font)	Returns the IPD for the hyphenation character for a font.
static CommonHyphenation	getInstance(PropertyList propertyList)	Gets the canonical CommonHyphenation instance corresponding to the values of the related properties present on the given PropertyList
Locale	getLocale()	Creates and returns a Locale representation of the language and country.
int	hashCode()
private static boolean	isDefined(String property)
static Locale	toLocale(String language, String country)	Creates and returns a Locale representation of the given language, and the given country if set.

Methods inherited from class Object

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

Field Details

LOG

private static final org.apache.commons.logging.Log LOG

Logger

CACHE

private static final PropertyCache<CommonHyphenation> CACHE

hash

private int hash

language

public final StringProperty language

The "language" property

country

public final StringProperty country

The "country" property

script

public final StringProperty script

The "script" property

hyphenate

public final EnumProperty hyphenate

The "hyphenate" property

hyphenationCharacter

public final OptionalCharacterProperty hyphenationCharacter

The "hyphenation-character" property

hyphenationPushCharacterCount

public final NumberProperty hyphenationPushCharacterCount

The "hyphenation-push-character-count" property

hyphenationRemainCharacterCount

public final NumberProperty hyphenationRemainCharacterCount

The "hyphenation-remain-character-count" property

HYPHEN_MINUS

private static final char HYPHEN_MINUS

See Also:

• Constant Field Values

MINUS_SIGN

private static final char MINUS_SIGN

See Also:

• Constant Field Values

Constructor Details

CommonHyphenation

private CommonHyphenation(StringProperty language,
 StringProperty country,
 StringProperty script,
 EnumProperty hyphenate,
 OptionalCharacterProperty hyphenationCharacter,
 NumberProperty hyphenationPushCharacterCount,
 NumberProperty hyphenationRemainCharacterCount)

Construct a CommonHyphenation object holding the given properties

Method Details

getInstance

public static CommonHyphenation getInstance(PropertyList propertyList)
                                     throws PropertyException

Gets the canonical CommonHyphenation instance corresponding to the values of the related properties present on the given PropertyList

Parameters:

propertyList - the PropertyList

Returns:

a common hyphenation instance

Throws:

PropertyException - if a a property exception occurs

getHyphChar

public Character getHyphChar(Font font)

Returns the effective hyphenation character for a font. The hyphenation character specified in XSL-FO may be substituted if it's not available in the font.

Parameters:

font - the font

Returns:

the effective hyphenation character.

getHyphIPD

public int getHyphIPD(Font font)

Returns the IPD for the hyphenation character for a font.

Parameters:

font - the font

Returns:

the IPD in millipoints for the hyphenation character.

getLocale

public Locale getLocale()

Creates and returns a Locale representation of the language and country.

Returns:

the language (and the country if set) represented as a locale, null if the language has not been set (i.e., has been left to its initial value of "none")

toLocale

public static Locale toLocale(String language,
 String country)

Creates and returns a Locale representation of the given language, and the given country if set. The country is considered to be set if not null and not set to "none".

Returns:

the language and country represented as a locale, null if the language is null or "none" (case insensitive)

isDefined

private static boolean isDefined(String property)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object