org.axsl.ps

Interface Encoding

All Known Subinterfaces:

Cmap, Cmap04, Cmap12, PsEncoding

public interface Encoding

Superinterface for all character-to-glyph-index encoding schemes, including PsEncoding and Cmap.

Field Summary

Fields

Modifier and Type	Field and Description
static char	INVALID_UNICODE_CHAR The invalid Unicode character, suitable as a return value in methods that need to return an invalid character.

Method Summary

Modifier and Type	Method and Description
java.lang.String	asPostScript(Encoding baseEncoding) Returns this Encoding as a String in the format expected by PostScript.
boolean	canEncode(int codePoint) Determine whether a given Unicode code point can be encoded by this Encoding.
int	decodeCharacter(int encodedIndex) Finds the Unicode code point, if any, for a given encoding index.
int	encodeCharacter(int codePoint) Finds the encoding index for a given Unicode codepoint.
int	getFirstIndex() Returns the lowest glyph index used in this encoding.
int	getLastIndex() Returns the highest glyph index used in this encoding.
java.lang.String	getName() Return the name of this Encoding.
boolean	isPredefinedPdf() Indicates whether this is a predefined PDF encoding.
boolean	isPredefinedPs() Indicates whether this is a predefined PostScript encoding.

Field Detail

INVALID_UNICODE_CHAR

static final char INVALID_UNICODE_CHAR

The invalid Unicode character, suitable as a return value in methods that need to return an invalid character.

See Also:

Constant Field Values

Method Detail

encodeCharacter

int encodeCharacter(int codePoint)

Finds the encoding index for a given Unicode codepoint.

Parameters:

codePoint - The Unicode codepoint which should be encoded.

Returns:

The encoding index corresponding to codePoint, or 0 if there is none.

decodeCharacter

int decodeCharacter(int encodedIndex)

Finds the Unicode code point, if any, for a given encoding index.

Parameters:

encodedIndex - The encoded index which should be decoded into a Unicode code point.

Returns:

The Unicode code point for index, or INVALID_UNICODE_CHAR if there is none.

asPostScript

java.lang.String asPostScript(Encoding baseEncoding)

Returns this Encoding as a String in the format expected by PostScript.

Parameters:

baseEncoding - The encoding, if any, on which this encoding is based. If this encoding is similar to another encoding that will be in the same output document, setting baseEncoding to that Encoding will allow the return value of this method to include only the differences between the two encodings. Set this to null if this encoding is not based on some other encoding.

Returns:

The PostScript representation of this encoding.

getName

java.lang.String getName()

Return the name of this Encoding.

Returns:

The name of this Encoding.

isPredefinedPs

boolean isPredefinedPs()

Indicates whether this is a predefined PostScript encoding.

Returns:

True iff this Encoding is a predefined PostScript encoding.

isPredefinedPdf

boolean isPredefinedPdf()

Indicates whether this is a predefined PDF encoding.

Returns:

True iff this Encoding is a predefined PDF encoding.

getFirstIndex

int getFirstIndex()

Returns the lowest glyph index used in this encoding.

Returns:

The lowest glyph index used in this encoding.

getLastIndex

int getLastIndex()

Returns the highest glyph index used in this encoding.

Returns:

The highest glyph index used in this encoding.

canEncode

boolean canEncode(int codePoint)

Determine whether a given Unicode code point can be encoded by this Encoding.

Parameters:

codePoint - The Unicode code point to be tested.

Returns:

True if this Encoding can encode codePoint.