org.apache.fop.pdf

Class PDFCMap

Implemented Interfaces:
PDFWritable
Known Direct Subclasses:
PDFToUnicodeCMap

public class PDFCMap
extends PDFStream

Class representing the CMap encodings. CMaps are defined in the "Predefined CJK CMap names" table. In section 5.6.4 of PDF reference 1.4.

Field Summary

static String
ENC_83PV_RKSJ_H
83pv-RKSJ-H Mac OS, JIS X 0208 character set with KanjiTalk6 extensions, Shift-JIS encoding, Script Manager code 1
static String
ENC_90MSP_RKSJ_H
90msp-RKSJ-H Same as 90ms-RKSJ-H, but replaces half-width Latin characters with proportional forms
static String
ENC_90MSP_RKSJ_V
90msp-RKSJ-V Vertical version of 90msp-RKSJ-H
static String
ENC_90MS_RKSJ_H
90ms-RKSJ-H Microsoft Code Page 932 (lfCharSet 0x80), JIS X 0208 character set with NEC and IBM extensions
static String
ENC_90MS_RKSJ_V
90ms-RKSJ-V Vertical version of 90ms-RKSJ-H
static String
ENC_90PV_RKSJ_H
90pv-RKSJ-H Mac OS, JIS X 0208 character set with KanjiTalk7 extensions, Shift-JIS encoding, Script Manager code 1
static String
ENC_ADD_RKSJ_H
Add-RKSJ-H JIS X 0208 character set with Fujitsu FMR extensions, Shift-JIS encoding
static String
ENC_ADD_RKSJ_V
Add-RKSJ-V Vertical version of Add-RKSJ-H
static String
ENC_B5PC_H
B5pc-H Mac OS, Big Five character set, Big Five encoding, Script Manager code 2
static String
ENC_B5PC_V
B5pc-V Vertical version of B5pc-H
static String
ENC_CNS_EUC_H
CNS-EUC-H CNS 11643-1992 character set, EUC-TW encoding
static String
ENC_CNS_EUC_V
CNS-EUC-V Vertical version of CNS-EUC-H
static String
ENC_ETENMS_B5_H
ETenms-B5-H Same as ETen-B5-H, but replaces half-width Latin characters with proportional forms
static String
ENC_ETENMS_B5_V
ETenms-B5-V Vertical version of ETenms-B5-H
static String
ENC_ETEN_B5_H
ETen-B5-H Microsoft Code Page 950 (lfCharSet 0x88), Big Five character set with ETen extensions
static String
ENC_ETEN_B5_V
ETen-B5-V Vertical version of ETen-B5-H
static String
ENC_EUC_H
EUC-H JIS X 0208 character set, EUC-JP encoding
static String
ENC_EUC_V
EUC-V Vertical version of EUC-H
static String
ENC_EXT_RKSJ_H
Ext-RKSJ-H JIS C 6226 (JIS78) character set with NEC extensions, Shift-JIS encoding
static String
ENC_EXT_RKSJ_V
Ext-RKSJ-V Vertical version of Ext-RKSJ-H
static String
ENC_GBK2K_H
GBK2K-H GB 18030-2000 character set, mixed 1-, 2-, and 4-byte encoding
static String
ENC_GBK2K_V
GBK2K-V Vertical version of GBK2K-H
static String
ENC_GBKP_EUC_H
GBKp-EUC-H Same as GBK-EUC-H, but replaces half-width Latin characters with proportional forms and maps character code 0x24 to a dollar sign ($) instead of a yuan symbol
static String
ENC_GBKP_EUC_V
GBKp-EUC-V Vertical version of GBKp-EUC-H
static String
ENC_GBK_EUC_H
GBK-EUC-H Microsoft Code Page 936 (lfCharSet 0x86), GBK character set, GBK encoding
static String
ENC_GBK_EUC_V
GBK-EUC-V Vertical version of GBK-EUC-H
static String
ENC_GBPC_EUC_H
GBpc-EUC-H Mac OS, GB 2312-80 character set, EUC-CN encoding, Script Manager code 19
static String
ENC_GBPC_EUC_V
GBpc-EUC-V Vertical version of GBpc-EUC-H
static String
ENC_GB_EUC_H
GB-EUC-H Microsoft Code Page 936 (lfCharSet 0x86), GB 2312-80 character set, EUC-CN encoding
static String
ENC_GB_EUC_V
GB-EUC-V Vertical version of GB-EUC-H
static String
ENC_H
H JIS X 0208 character set, ISO-2022-JP encoding
static String
ENC_HKSCS_B5_H
HKscs-B5-H Hong Kong SCS, an extension to the Big Five character set and encoding
static String
ENC_HKSCS_B5_V
HKscs-B5-V Vertical version of HKscs-B5-H
static String
ENC_IDENTITY_H
Identity-H The horizontal identity mapping for 2-byte CIDs; may be used with CIDFonts using any Registry, Ordering, and Supplement values.
static String
ENC_IDENTTITY_V
Identity-V Vertical version of Identity-H.
static String
ENC_KSCMS_UHC_H
KSCms-UHC-H Microsoft Code Page 949 (lfCharSet 0x81), KS X 1001:1992 character set plus 8822 additional hangul, Unified Hangul Code (UHC) encoding
static String
ENC_KSCMS_UHC_HW_H
KSCms-UHC-HW-H Same as KSCms-UHC-H, but replaces proportional Latin characters with half-width forms
static String
ENC_KSCMS_UHC_HW_V
KSCms-UHC-HW-V Vertical version of KSCms-UHC-HW-H
static String
ENC_KSCMS_UHC_V
KSCms-UHC-V Vertical version of KSCms-UHC-H
static String
ENC_KSCPC_EUC_H
KSCpc-EUC-H Mac OS, KS X 1001:1992 character set with Mac OS KH extensions, Script Manager Code 3
static String
ENC_KSC_EUC_H
KSC-EUC-H KS X 1001:1992 character set, EUC-KR encoding
static String
ENC_KSC_EUC_V
KSC-EUC-V Vertical version of KSC-EUC-H
static String
ENC_UNICNS_UCS2_H
UniCNS-UCS2-H Unicode (UCS-2) encoding for the Adobe-CNS1 character collection
static String
ENC_UNICNS_UCS2_V
UniCNS-UCS2-V Vertical version of UniCNS-UCS2-H
static String
ENC_UNIGB_UCS2_H
UniGB-UCS2-H Unicode (UCS-2) encoding for the Adobe-GB1 character collection
static String
ENC_UNIGB_UCS2_V
UniGB-UCS2-V Vertical version of UniGB-UCS2-H
static String
ENC_UNIJIS_UCS2_H
UniJIS-UCS2-H Unicode (UCS-2) encoding for the Adobe-Japan1 character collection
static String
ENC_UNIJIS_UCS2_HW_H
UniJIS-UCS2-HW-H Same as UniJIS-UCS2-H, but replaces proportional Latin characters with half-width forms
static String
ENC_UNIJIS_UCS2_HW_V
UniJIS-UCS2-HW-V Vertical version of UniJIS-UCS2-HW-H
static String
ENC_UNIJIS_UCS2_V
UniJIS-UCS2-V Vertical version of UniJIS-UCS2-H
static String
ENC_UNIKSC_UCS2_H
UniKS-UCS2-H Unicode (UCS-2) encoding for the Adobe-Korea1 character collection
static String
ENC_UNIKSC_UCS2_V
UniKS-UCS2-V Vertical version of UniKS-UCS2-H
static String
ENC_V
V Vertical version of H
static byte
WMODE_HORIZONTAL
horizontal writing direction
static byte
WMODE_VERTICAL
vertical writing direction
protected Object
base
base CMap (String or PDFStream)
protected String
name
/CMapName attribute, one of the predefined constants
protected PDFCIDSystemInfo
sysInfo
/CIDSystemInfo attribute
protected byte
wMode
font's writing direction

Fields inherited from class org.apache.fop.pdf.PDFStream

data

Fields inherited from class org.apache.fop.pdf.PDFDictionary

entries, order

Fields inherited from class org.apache.fop.pdf.PDFObject

DATE_FORMAT, log

Constructor Summary

PDFCMap(String name, PDFCIDSystemInfo sysInfo)
create the /CMap object

Method Summary

protected CMapBuilder
createCMapBuilder(Writer writer)
Creates the CMapBuilder that will build the CMap's content.
protected int
output(OutputStream stream)
void
setUseCMap(String base)
set the base CMap
void
setUseCMap(PDFStream base)
set the base CMap
void
setWMode(byte mode)
set the writing direction

Methods inherited from class org.apache.fop.pdf.PDFStream

add, getBufferOutputStream, getDataLength, getSizeHint, output, outputRawStreamData, setData

Methods inherited from class org.apache.fop.pdf.AbstractPDFStream

encodeAndWriteStream, encodeStream, getFilterList, getSizeHint, output, outputRawStreamData, outputStreamData, populateStreamDict, prepareImplicitFilters, setupFilterList

Methods inherited from class org.apache.fop.pdf.PDFDictionary

get, output, put, put, writeDictionary

Methods inherited from class org.apache.fop.pdf.PDFObject

encode, encodeBinaryToHexString, encodeString, encodeText, formatDateTime, formatDateTime, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, output, outputInline, referencePDF, setDocument, setObjectNumber, setParent, toPDF, toPDFString

Field Details

ENC_83PV_RKSJ_H

public static final String ENC_83PV_RKSJ_H
83pv-RKSJ-H Mac OS, JIS X 0208 character set with KanjiTalk6 extensions, Shift-JIS encoding, Script Manager code 1

ENC_90MSP_RKSJ_H

public static final String ENC_90MSP_RKSJ_H
90msp-RKSJ-H Same as 90ms-RKSJ-H, but replaces half-width Latin characters with proportional forms

ENC_90MSP_RKSJ_V

public static final String ENC_90MSP_RKSJ_V
90msp-RKSJ-V Vertical version of 90msp-RKSJ-H

ENC_90MS_RKSJ_H

public static final String ENC_90MS_RKSJ_H
90ms-RKSJ-H Microsoft Code Page 932 (lfCharSet 0x80), JIS X 0208 character set with NEC and IBM extensions

ENC_90MS_RKSJ_V

public static final String ENC_90MS_RKSJ_V
90ms-RKSJ-V Vertical version of 90ms-RKSJ-H

ENC_90PV_RKSJ_H

public static final String ENC_90PV_RKSJ_H
90pv-RKSJ-H Mac OS, JIS X 0208 character set with KanjiTalk7 extensions, Shift-JIS encoding, Script Manager code 1

ENC_ADD_RKSJ_H

public static final String ENC_ADD_RKSJ_H
Add-RKSJ-H JIS X 0208 character set with Fujitsu FMR extensions, Shift-JIS encoding

ENC_ADD_RKSJ_V

public static final String ENC_ADD_RKSJ_V
Add-RKSJ-V Vertical version of Add-RKSJ-H

ENC_B5PC_H

public static final String ENC_B5PC_H
B5pc-H Mac OS, Big Five character set, Big Five encoding, Script Manager code 2

ENC_B5PC_V

public static final String ENC_B5PC_V
B5pc-V Vertical version of B5pc-H

ENC_CNS_EUC_H

public static final String ENC_CNS_EUC_H
CNS-EUC-H CNS 11643-1992 character set, EUC-TW encoding

ENC_CNS_EUC_V

public static final String ENC_CNS_EUC_V
CNS-EUC-V Vertical version of CNS-EUC-H

ENC_ETENMS_B5_H

public static final String ENC_ETENMS_B5_H
ETenms-B5-H Same as ETen-B5-H, but replaces half-width Latin characters with proportional forms

ENC_ETENMS_B5_V

public static final String ENC_ETENMS_B5_V
ETenms-B5-V Vertical version of ETenms-B5-H

ENC_ETEN_B5_H

public static final String ENC_ETEN_B5_H
ETen-B5-H Microsoft Code Page 950 (lfCharSet 0x88), Big Five character set with ETen extensions

ENC_ETEN_B5_V

public static final String ENC_ETEN_B5_V
ETen-B5-V Vertical version of ETen-B5-H

ENC_EUC_H

public static final String ENC_EUC_H
EUC-H JIS X 0208 character set, EUC-JP encoding

ENC_EUC_V

public static final String ENC_EUC_V
EUC-V Vertical version of EUC-H

ENC_EXT_RKSJ_H

public static final String ENC_EXT_RKSJ_H
Ext-RKSJ-H JIS C 6226 (JIS78) character set with NEC extensions, Shift-JIS encoding

ENC_EXT_RKSJ_V

public static final String ENC_EXT_RKSJ_V
Ext-RKSJ-V Vertical version of Ext-RKSJ-H

ENC_GBK2K_H

public static final String ENC_GBK2K_H
GBK2K-H GB 18030-2000 character set, mixed 1-, 2-, and 4-byte encoding

ENC_GBK2K_V

public static final String ENC_GBK2K_V
GBK2K-V Vertical version of GBK2K-H

ENC_GBKP_EUC_H

public static final String ENC_GBKP_EUC_H
GBKp-EUC-H Same as GBK-EUC-H, but replaces half-width Latin characters with proportional forms and maps character code 0x24 to a dollar sign ($) instead of a yuan symbol

ENC_GBKP_EUC_V

public static final String ENC_GBKP_EUC_V
GBKp-EUC-V Vertical version of GBKp-EUC-H

ENC_GBK_EUC_H

public static final String ENC_GBK_EUC_H
GBK-EUC-H Microsoft Code Page 936 (lfCharSet 0x86), GBK character set, GBK encoding

ENC_GBK_EUC_V

public static final String ENC_GBK_EUC_V
GBK-EUC-V Vertical version of GBK-EUC-H

ENC_GBPC_EUC_H

public static final String ENC_GBPC_EUC_H
GBpc-EUC-H Mac OS, GB 2312-80 character set, EUC-CN encoding, Script Manager code 19

ENC_GBPC_EUC_V

public static final String ENC_GBPC_EUC_V
GBpc-EUC-V Vertical version of GBpc-EUC-H

ENC_GB_EUC_H

public static final String ENC_GB_EUC_H
GB-EUC-H Microsoft Code Page 936 (lfCharSet 0x86), GB 2312-80 character set, EUC-CN encoding

ENC_GB_EUC_V

public static final String ENC_GB_EUC_V
GB-EUC-V Vertical version of GB-EUC-H

ENC_H

public static final String ENC_H
H JIS X 0208 character set, ISO-2022-JP encoding

ENC_HKSCS_B5_H

public static final String ENC_HKSCS_B5_H
HKscs-B5-H Hong Kong SCS, an extension to the Big Five character set and encoding

ENC_HKSCS_B5_V

public static final String ENC_HKSCS_B5_V
HKscs-B5-V Vertical version of HKscs-B5-H

ENC_IDENTITY_H

public static final String ENC_IDENTITY_H
Identity-H The horizontal identity mapping for 2-byte CIDs; may be used with CIDFonts using any Registry, Ordering, and Supplement values. It maps 2-byte character codes ranging from 0 to 65,535 to the same 2-byte CID value, interpreted high-order byte first.

ENC_IDENTTITY_V

public static final String ENC_IDENTTITY_V
Identity-V Vertical version of Identity-H. The mapping is the same as for Identity-H.

ENC_KSCMS_UHC_H

public static final String ENC_KSCMS_UHC_H
KSCms-UHC-H Microsoft Code Page 949 (lfCharSet 0x81), KS X 1001:1992 character set plus 8822 additional hangul, Unified Hangul Code (UHC) encoding

ENC_KSCMS_UHC_HW_H

public static final String ENC_KSCMS_UHC_HW_H
KSCms-UHC-HW-H Same as KSCms-UHC-H, but replaces proportional Latin characters with half-width forms

ENC_KSCMS_UHC_HW_V

public static final String ENC_KSCMS_UHC_HW_V
KSCms-UHC-HW-V Vertical version of KSCms-UHC-HW-H

ENC_KSCMS_UHC_V

public static final String ENC_KSCMS_UHC_V
KSCms-UHC-V Vertical version of KSCms-UHC-H

ENC_KSCPC_EUC_H

public static final String ENC_KSCPC_EUC_H
KSCpc-EUC-H Mac OS, KS X 1001:1992 character set with Mac OS KH extensions, Script Manager Code 3

ENC_KSC_EUC_H

public static final String ENC_KSC_EUC_H
KSC-EUC-H KS X 1001:1992 character set, EUC-KR encoding

ENC_KSC_EUC_V

public static final String ENC_KSC_EUC_V
KSC-EUC-V Vertical version of KSC-EUC-H

ENC_UNICNS_UCS2_H

public static final String ENC_UNICNS_UCS2_H
UniCNS-UCS2-H Unicode (UCS-2) encoding for the Adobe-CNS1 character collection

ENC_UNICNS_UCS2_V

public static final String ENC_UNICNS_UCS2_V
UniCNS-UCS2-V Vertical version of UniCNS-UCS2-H

ENC_UNIGB_UCS2_H

public static final String ENC_UNIGB_UCS2_H
UniGB-UCS2-H Unicode (UCS-2) encoding for the Adobe-GB1 character collection

ENC_UNIGB_UCS2_V

public static final String ENC_UNIGB_UCS2_V
UniGB-UCS2-V Vertical version of UniGB-UCS2-H

ENC_UNIJIS_UCS2_H

public static final String ENC_UNIJIS_UCS2_H
UniJIS-UCS2-H Unicode (UCS-2) encoding for the Adobe-Japan1 character collection

ENC_UNIJIS_UCS2_HW_H

public static final String ENC_UNIJIS_UCS2_HW_H
UniJIS-UCS2-HW-H Same as UniJIS-UCS2-H, but replaces proportional Latin characters with half-width forms

ENC_UNIJIS_UCS2_HW_V

public static final String ENC_UNIJIS_UCS2_HW_V
UniJIS-UCS2-HW-V Vertical version of UniJIS-UCS2-HW-H

ENC_UNIJIS_UCS2_V

public static final String ENC_UNIJIS_UCS2_V
UniJIS-UCS2-V Vertical version of UniJIS-UCS2-H

ENC_UNIKSC_UCS2_H

public static final String ENC_UNIKSC_UCS2_H
UniKS-UCS2-H Unicode (UCS-2) encoding for the Adobe-Korea1 character collection

ENC_UNIKSC_UCS2_V

public static final String ENC_UNIKSC_UCS2_V
UniKS-UCS2-V Vertical version of UniKS-UCS2-H

ENC_V

public static final String ENC_V
V Vertical version of H

WMODE_HORIZONTAL

public static final byte WMODE_HORIZONTAL
horizontal writing direction
Field Value:
0

WMODE_VERTICAL

public static final byte WMODE_VERTICAL
vertical writing direction
Field Value:
1

base

protected Object base
base CMap (String or PDFStream)

name

protected String name
/CMapName attribute, one of the predefined constants

sysInfo

protected PDFCIDSystemInfo sysInfo
/CIDSystemInfo attribute

wMode

protected byte wMode
font's writing direction

Constructor Details

PDFCMap

public PDFCMap(String name,
               PDFCIDSystemInfo sysInfo)
create the /CMap object
Parameters:
name - one the registered names (see Table 7.20 on p 215)
sysInfo - the attributes of the character collection of the CIDFont

Method Details

createCMapBuilder

protected CMapBuilder createCMapBuilder(Writer writer)
Creates the CMapBuilder that will build the CMap's content.
Parameters:
writer - a Writer to write the CMap's contents to
Returns:
the newly created CMapBuilder

output

protected int output(OutputStream stream)
            throws IOException
Overrides:
output in interface PDFStream

setUseCMap

public void setUseCMap(String base)
set the base CMap
Parameters:
base - the name of the base CMap

setUseCMap

public void setUseCMap(PDFStream base)
set the base CMap
Parameters:
base - the stream to be used as base CMap

setWMode

public void setWMode(byte mode)
set the writing direction
Parameters:
mode - is either WMODE_HORIZONTAL or WMODE_VERTICAL

Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.