Package com.lowagie.text.pdf

Class PdfEncodings

java.lang.Object

com.lowagie.text.pdf.PdfEncodings

public class PdfEncodings
extends Object

Supports fast encodings for winansi and PDFDocEncoding. Supports conversions from CJK encodings to CID. Supports custom encodings.

Author:

Paulo Soares (psoares@consiste.pt)

Field Summary

Fields

Modifier and Type	Field	Description
protected static int	CIDCHAR
protected static int	CIDNONE
protected static int	CIDRANGE
static byte[][]	CRLF_CID_NEWLINE	Assumes that '\\n' and '\\r\\n' are the newline sequences.

Constructor Summary

Constructors

Constructor	Description
PdfEncodings()

Method Summary

Modifier and Type	Method	Description
static void	addExtraEncoding(String name, ExtraEncoding enc)	Adds an extra encoding.
static void	clearCmap(String name)	Clears the CJK cmaps from the cache.
static String	convertCmap(String name, byte[] seq)	Converts a byte array encoded as name to a CID string.
static String	convertCmap(String name, byte[] seq, int start, int length)	Converts a byte array encoded as name to a CID string.
static byte[]	convertToBytes(char char1, String encoding)	Converts a String to a byte array according to the font's encoding.
static byte[]	convertToBytes(String text, String encoding)	Converts a String to a byte array according to the font's encoding.
static String	convertToString(byte[] bytes, String encoding)	Converts a byte array to a String according to the some encoding.
static boolean	isPdfDocEncoding(String text)	Checks is text only has PdfDocEncoding characters.
static void	loadCmap(String name, byte[][] newline)	Loads a CJK cmap to the cache with the option of associating sequences to the newline.

Methods inherited from class java.lang.Object

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

Field Detail

CIDNONE

protected static final int CIDNONE

See Also:

Constant Field Values

CIDRANGE

protected static final int CIDRANGE

See Also:

Constant Field Values

CIDCHAR

protected static final int CIDCHAR

See Also:

Constant Field Values

CRLF_CID_NEWLINE

public static final byte[][] CRLF_CID_NEWLINE

Assumes that '\\n' and '\\r\\n' are the newline sequences. It may not work for all CJK encodings. To be used with loadCmap().

Constructor Detail

PdfEncodings

public PdfEncodings()

Method Detail

convertToBytes

public static final byte[] convertToBytes(String text,
                                          String encoding)

Converts a String to a byte array according to the font's encoding.

Parameters:

encoding - the encoding

text - the String to be converted

Returns:

an array of byte representing the conversion according to the font's encoding

convertToBytes

public static final byte[] convertToBytes(char char1,
                                          String encoding)

Converts a String to a byte array according to the font's encoding.

Parameters:

encoding - the encoding

char1 - the char to be converted

Returns:

an array of byte representing the conversion according to the font's encoding

convertToString

public static final String convertToString(byte[] bytes,
                                           String encoding)

Converts a byte array to a String according to the some encoding.

Parameters:

bytes - the bytes to convert

encoding - the encoding

Returns:

the converted String

isPdfDocEncoding

public static boolean isPdfDocEncoding(String text)

Checks is text only has PdfDocEncoding characters.

Parameters:

text - the String to test

Returns:

true if only PdfDocEncoding characters are present

clearCmap

public static void clearCmap(String name)

Clears the CJK cmaps from the cache. If name is the empty string then all the cache is cleared. Calling this method has no consequences other than the need to reload the cmap if needed.

Parameters:

name - the name of the cmap to clear or all the cmaps if the empty string

loadCmap

public static void loadCmap(String name,
                            byte[][] newline)

Loads a CJK cmap to the cache with the option of associating sequences to the newline.

Parameters:

name - the CJK cmap name

newline - the sequences to be replaced by a newline in the resulting CID. See CRLF_CID_NEWLINE

convertCmap

public static String convertCmap(String name,
                                 byte[] seq)

Converts a byte array encoded as name to a CID string. This is needed to reach some CJK characters that don't exist in 16 bit Unicode.

The font to use this result must use the encoding "Identity-H" or "Identity-V".

See ftp://ftp.oreilly.com/pub/examples/nutshell/cjkv/adobe/.

Parameters:

name - the CJK encoding name

seq - the byte array to be decoded

Returns:

the CID string

convertCmap

public static String convertCmap(String name,
                                 byte[] seq,
                                 int start,
                                 int length)

Converts a byte array encoded as name to a CID string. This is needed to reach some CJK characters that don't exist in 16 bit Unicode.

The font to use this result must use the encoding "Identity-H" or "Identity-V".

See ftp://ftp.oreilly.com/pub/examples/nutshell/cjkv/adobe/.

Parameters:

name - the CJK encoding name

start - the start offset in the data

length - the number of bytes to convert

seq - the byte array to be decoded

Returns:

the CID string

addExtraEncoding

public static void addExtraEncoding(String name,
                                    ExtraEncoding enc)

Adds an extra encoding.

Parameters:

name - the name of the encoding. The encoding recognition is case insensitive

enc - the conversion class