de.intarsys.pdf.cos

Class COSCatalog

java.lang.Object

de.intarsys.pdf.cos.COSBasedObject

de.intarsys.pdf.cos.COSCatalog

All Implemented Interfaces:

ICOSObjectListener, de.intarsys.tools.attribute.IAttributeSupport

public class COSCatalog
extends COSBasedObject

The document catalog object of the PDF document.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	COSCatalog.MetaClass The meta class implementation

Field Summary

Fields

Modifier and Type	Field and Description
static COSName	CN_Type_Catalog
static COSName	CN_Version_1_4 Well known attribute names
static COSName	DK_AA
static COSName	DK_AcroForm
static COSName	DK_AF
static COSName	DK_Collection
static COSName	DK_Dests
static COSName	DK_EmbeddedFiles
static COSName	DK_FDF
static COSName	DK_JavaScript
static COSName	DK_Lang
static COSName	DK_MarkInfo
static COSName	DK_Metadata
static COSName	DK_Names
static COSName	DK_OCProperties
static COSName	DK_OpenAction
static COSName	DK_Outlines
static COSName	DK_OutputIntents
static COSName	DK_PageLabels
static COSName	DK_PageLayout
static COSName	DK_PageMode
static COSName	DK_Pages
static COSName	DK_PieceInfo
static COSName	DK_Sig
static COSName	DK_SpiderInfo
static COSName	DK_StructTreeRoot
static COSName	DK_Threads
static COSName	DK_Type
static COSName	DK_URI
static COSName	DK_Version
static COSName	DK_ViewerPreferences
static COSCatalog.MetaClass	META The meta class instance

Method Summary

Methods

Modifier and Type	Method and Description
COSArray	cosGetAF() The /AF field in the document catalog.
COSDictionary	cosGetCollection() The /Collection field in the document catalog.
COSDictionary	cosGetDests() The /Dests field in the document catalog.
COSDictionary	cosGetFDF() The /FDF field in the document catalog.
COSDictionary	cosGetNames() The /Names field in the document catalog.
COSObject	cosGetOpenAction() The object defining the open action for the document.
COSDictionary	cosGetOutline() The /Outlines field in the document catalog.
COSDictionary	cosGetSig() The /Sig field in the document catalog.
COSDictionary	cosSetCollection(COSDictionary pCollection) Set the /Collection field in the document catalog.
COSDictionary	cosSetDests(COSDictionary pDests) Set the /Dests field in the document catalog.
COSDictionary	cosSetFDF(COSDictionary fdfDict) Set the /FDF field in the document catalog.
COSDictionary	cosSetNames(COSDictionary pNames) Set the /Names field in the document catalog.
COSDictionary	cosSetOutline(COSDictionary dict) Set the /Outlines field in the document catalog.
COSDictionary	cosSetSig(COSDictionary sigDict) Set the /Sig field in the document catalog.
String	getPageMode() The /PageMode field in the document catalog.
String	getVersion() The /Version field in the document catalog.
void	setPageMode(String value) Set the /PageMode field in the document catalog.
void	setVersion(String value) Set the /Version field in the document catalog.

Methods inherited from class de.intarsys.pdf.cos.COSBasedObject

changed, cosGetArray, cosGetDict, cosGetDoc, cosGetField, cosGetObject, cosGetStream, cosHasField, cosRemoveField, cosSetField, getAttribute, getFieldBoolean, getFieldDate, getFieldFixed, getFieldFixedArray, getFieldInt, getFieldMLString, getFieldString, invalidateCaches, removeAttribute, setAttribute, setFieldBoolean, setFieldFixed, setFieldInt, setFieldMLString, setFieldName, setFieldObject, setFieldString, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DK_AcroForm

public static final COSName DK_AcroForm

DK_Collection

public static final COSName DK_Collection

DK_Dests

public static final COSName DK_Dests

DK_EmbeddedFiles

public static final COSName DK_EmbeddedFiles

DK_JavaScript

public static final COSName DK_JavaScript

DK_FDF

public static final COSName DK_FDF

DK_Names

public static final COSName DK_Names

DK_MarkInfo

public static final COSName DK_MarkInfo

DK_OpenAction

public static final COSName DK_OpenAction

DK_Outlines

public static final COSName DK_Outlines

DK_Sig

public static final COSName DK_Sig

DK_ViewerPreferences

public static final COSName DK_ViewerPreferences

DK_PageLabels

public static final COSName DK_PageLabels

DK_PageLayout

public static final COSName DK_PageLayout

DK_Threads

public static final COSName DK_Threads

DK_AA

public static final COSName DK_AA

DK_AF

public static final COSName DK_AF

DK_Lang

public static final COSName DK_Lang

DK_SpiderInfo

public static final COSName DK_SpiderInfo

DK_StructTreeRoot

public static final COSName DK_StructTreeRoot

DK_Type

public static final COSName DK_Type

DK_Metadata

public static final COSName DK_Metadata

DK_OutputIntents

public static final COSName DK_OutputIntents

DK_PageMode

public static final COSName DK_PageMode

DK_Pages

public static final COSName DK_Pages

DK_PieceInfo

public static final COSName DK_PieceInfo

CN_Type_Catalog

public static final COSName CN_Type_Catalog

DK_URI

public static final COSName DK_URI

DK_Version

public static final COSName DK_Version

DK_OCProperties

public static final COSName DK_OCProperties

CN_Version_1_4

public static final COSName CN_Version_1_4

Well known attribute names

META

public static final COSCatalog.MetaClass META

The meta class instance

Method Detail

cosGetAF

public COSArray cosGetAF()

The /AF field in the document catalog.

Returns:

The /AF field in the document catalog.

cosGetCollection

public COSDictionary cosGetCollection()

The /Collection field in the document catalog.

Returns:

The /Collection field in the document catalog.

cosGetDests

public COSDictionary cosGetDests()

The /Dests field in the document catalog.

Returns:

The /Dests field in the document catalog.

cosGetFDF

public COSDictionary cosGetFDF()

The /FDF field in the document catalog.

Returns:

The /FDF field in the document catalog.

cosGetNames

public COSDictionary cosGetNames()

The /Names field in the document catalog.

Returns:

The /Names field in the document catalog.

cosGetOpenAction

public COSObject cosGetOpenAction()

The object defining the open action for the document.

Returns:

COSDictionary or COSArray or COSNull if no entry defined.

cosGetOutline

public COSDictionary cosGetOutline()

The /Outlines field in the document catalog.

Returns:

The /Outlines field in the document catalog.

cosGetSig

public COSDictionary cosGetSig()

The /Sig field in the document catalog.

Returns:

The /Sig field in the document catalog.

cosSetCollection

public COSDictionary cosSetCollection(COSDictionary pCollection)

Set the /Collection field in the document catalog.

cosSetDests

public COSDictionary cosSetDests(COSDictionary pDests)

Set the /Dests field in the document catalog.

cosSetFDF

public COSDictionary cosSetFDF(COSDictionary fdfDict)

Set the /FDF field in the document catalog.

cosSetNames

public COSDictionary cosSetNames(COSDictionary pNames)

Set the /Names field in the document catalog.

cosSetOutline

public COSDictionary cosSetOutline(COSDictionary dict)

Set the /Outlines field in the document catalog.

cosSetSig

public COSDictionary cosSetSig(COSDictionary sigDict)

Set the /Sig field in the document catalog.

getPageMode

public String getPageMode()

The /PageMode field in the document catalog.

Returns:

The /PageMode field in the document catalog.

getVersion

public String getVersion()

The /Version field in the document catalog.

Returns:

The /Version field in the document catalog.

setPageMode

public void setPageMode(String value)

Set the /PageMode field in the document catalog.

setVersion

public void setVersion(String value)

Set the /Version field in the document catalog.