|
fop 2.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.fop.fo.properties.CommonHyphenation
public final class CommonHyphenation
Store all common hyphenation properties. See Sec. 7.9 of the XSL-FO Standard. Public "structure" allows direct member access.
Field Summary | |
---|---|
StringProperty |
country
The "country" property |
EnumProperty |
hyphenate
The "hyphenate" property |
CharacterProperty |
hyphenationCharacter
The "hyphenation-character" property |
NumberProperty |
hyphenationPushCharacterCount
The "hyphenation-push-character-count" property |
NumberProperty |
hyphenationRemainCharacterCount
The "hyphenation-remain-character-count" property |
StringProperty |
language
The "language" property |
StringProperty |
script
The "script" property |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
|
char |
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 |
java.util.Locale |
getLocale()
Creates and returns a Locale representation of the language and country. |
int |
hashCode()
|
static java.util.Locale |
toLocale(java.lang.String language,
java.lang.String country)
Creates and returns a Locale representation of the given language, and the
given country if set. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public final StringProperty language
public final StringProperty country
public final StringProperty script
public final EnumProperty hyphenate
public final CharacterProperty hyphenationCharacter
public final NumberProperty hyphenationPushCharacterCount
public final NumberProperty hyphenationRemainCharacterCount
Method Detail |
---|
public static CommonHyphenation getInstance(PropertyList propertyList) throws PropertyException
CommonHyphenation
instance corresponding
to the values of the related properties present on the given
PropertyList
propertyList
- the PropertyList
PropertyException
- if a a property exception occurspublic char getHyphChar(Font font)
font
- the font
public int getHyphIPD(Font font)
font
- the font
public java.util.Locale getLocale()
Locale
representation of the language and country.
null
if the language has not been set (i.e., has been left to its initial value of
"none")public static java.util.Locale toLocale(java.lang.String language, java.lang.String country)
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".
null
if the
language is null or "none" (case insensitive)public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
|
fop 2.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |