|
fop 1.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.fop.afp.fonts.CharacterSet
public class CharacterSet
The IBM Font Object Content Architecture (FOCA) supports presentation of character shapes by defining their characteristics, which include font description information for identifying the characters, font metric information for positioning the characters, and character shape information for presenting the character images.
Presenting a graphic character on a presentation surface requires information on the rotation and position of character on the physical or logical page. This class proivdes font metric information for a particular font as identified by the character set name. This information is obtained directly from the AFP font files which must be installed in the path specified in the afp-fonts xml definition file.
Field Summary | |
---|---|
protected java.lang.String |
codePage
The code page to which the character set relates |
static java.lang.String |
DEFAULT_CODEPAGE
default codepage |
static java.lang.String |
DEFAULT_ENCODING
default encoding |
protected java.lang.String |
encoding
The encoding used for the code page |
protected static org.apache.commons.logging.Log |
LOG
Static logging instance |
protected java.lang.String |
name
The character set relating to the font |
Constructor Summary | |
---|---|
CharacterSet(java.lang.String codePage,
java.lang.String encoding,
java.lang.String name,
java.lang.String path)
Deprecated. Please use #CharacterSet(String, String, String, URI) instead. |
Method Summary | |
---|---|
void |
addCharacterSetOrientation(CharacterSetOrientation cso)
Add character set metric information for the different orientations |
byte[] |
encodeChars(java.lang.CharSequence chars)
Encodes a character sequence to a byte array. |
int |
getAscender()
Ascender height is the distance from the character baseline to the top of the character box. |
int |
getCapHeight()
Cap height is the average height of the uppercase characters in a font. |
java.lang.String |
getCodePage()
Returns the AFP code page identifier |
int |
getDescender()
Descender depth is the distance from the character baseline to the bottom of a character box. |
int |
getEmSpaceIncrement()
Returns the increment for an em space. |
java.lang.String |
getEncoding()
Returns the AFP code page encoding |
char |
getFirstChar()
Returns the first character in the character set |
char |
getLastChar()
Returns the last character in the character set |
java.lang.String |
getName()
Returns the AFP character set identifier |
byte[] |
getNameBytes()
Returns the AFP character set identifier as a byte array |
int |
getNominalVerticalSize()
Returns the nominal vertical size of the font in the case of bitmap fonts. |
ResourceAccessor |
getResourceAccessor()
Returns the resource accessor to load the font resources with. |
int |
getSpaceIncrement()
Returns the increment for an space. |
int |
getWidth(char character)
Get the width (in 1/1000ths of a point size) of the character identified by the parameter passed. |
int[] |
getWidths()
Get the width (in 1/1000ths of a point size) of all characters |
int |
getXHeight()
XHeight refers to the height of the lower case letters above the baseline. |
boolean |
hasChar(char c)
Indicates whether the given char in the character set. |
char |
mapChar(char c)
Map a Unicode character to a code point in the font. |
void |
setNominalVerticalSize(int nominalVerticalSize)
Sets the nominal vertical size of the font in the case of bitmap fonts. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final org.apache.commons.logging.Log LOG
public static final java.lang.String DEFAULT_CODEPAGE
public static final java.lang.String DEFAULT_ENCODING
protected java.lang.String codePage
protected java.lang.String encoding
protected java.lang.String name
Constructor Detail |
---|
public CharacterSet(java.lang.String codePage, java.lang.String encoding, java.lang.String name, java.lang.String path)
#CharacterSet(String, String, String, URI)
instead.
codePage
- the code page identifierencoding
- the encoding of the fontname
- the character set namepath
- the path to the installed afp fontsMethod Detail |
---|
public void addCharacterSetOrientation(CharacterSetOrientation cso)
cso
- the metrics for the orientationpublic void setNominalVerticalSize(int nominalVerticalSize)
nominalVerticalSize
- the nominal vertical size (in millipoints)public int getNominalVerticalSize()
public int getAscender()
public int getCapHeight()
public int getDescender()
public char getFirstChar()
public char getLastChar()
public ResourceAccessor getResourceAccessor()
public int[] getWidths()
public int getXHeight()
public int getWidth(char character)
character
- the Unicode character from which the width will be calculated
public java.lang.String getName()
public byte[] getNameBytes()
public java.lang.String getCodePage()
public java.lang.String getEncoding()
public boolean hasChar(char c)
c
- the character to check
public byte[] encodeChars(java.lang.CharSequence chars) throws java.nio.charset.CharacterCodingException
chars
- the characters
java.nio.charset.CharacterCodingException
- if the encoding operation failspublic char mapChar(char c)
c
- the Unicode character to map
public int getSpaceIncrement()
public int getEmSpaceIncrement()
|
fop 1.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |