jPod PDF library

de.intarsys.pdf.cos
Class COSTrailer

java.lang.Object
  extended by de.intarsys.pdf.cos.COSBasedObject
      extended by de.intarsys.pdf.cos.COSTrailer
All Implemented Interfaces:
ICOSObjectListener, de.intarsys.tools.attribute.IAttributeSupport

public class COSTrailer
extends COSBasedObject

The document trailer.


Nested Class Summary
static class COSTrailer.MetaClass
          The meta class implementation
 
Field Summary
static COSName DK_Encrypt
           
static COSName DK_ID
           
static COSName DK_Info
          The well known attribute names
static COSName DK_Prev
           
static COSName DK_Root
           
static COSName DK_Size
           
static COSName DK_XRefStm
           
static COSTrailer.MetaClass META
          The meta class instance
 
Method Summary
 COSString cosGetDynamicFileID()
          The dynamic file id part.
 COSDictionary cosGetEncryption()
          The /Encrypt field of the trailer.
 COSArray cosGetFileID()
          The current file id or null
 COSArray cosGetID()
          The /ID field of the trailer.
 COSString cosGetPermanentFileID()
          The permanent file id part.
 void cosSetEncryption(COSDictionary encryption)
          Set the /Encrypt field of the trailer.
 COSInfoDict getInfoDict()
          The COSInfoDict containing metadata.
 int getPrev()
           
 COSCatalog getRoot()
          Get the root object (the catalog) for the document.
 int getSize()
           
 void invalidateCaches()
          Invalidate all local caches as the base object may have changed.
 void setInfoDict(COSInfoDict infoDict)
          Set the info dictionary containing metadata.
 void setRoot(COSCatalog root)
          Set the catalog.
 void updateFileID()
          Generates a unique file ID array (10.3).
 
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, 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_Info

public static final COSName DK_Info
The well known attribute names


DK_Prev

public static final COSName DK_Prev

DK_Root

public static final COSName DK_Root

DK_Size

public static final COSName DK_Size

DK_Encrypt

public static final COSName DK_Encrypt

DK_ID

public static final COSName DK_ID

DK_XRefStm

public static final COSName DK_XRefStm

META

public static final COSTrailer.MetaClass META
The meta class instance

Method Detail

cosGetDynamicFileID

public COSString cosGetDynamicFileID()
The dynamic file id part.


cosGetEncryption

public COSDictionary cosGetEncryption()
The /Encrypt field of the trailer.

Returns:
The /Encrypt field of the trailer.

cosGetFileID

public COSArray cosGetFileID()
The current file id or null


cosGetID

public COSArray cosGetID()
The /ID field of the trailer.

Returns:
The /ID field of the trailer.

cosGetPermanentFileID

public COSString cosGetPermanentFileID()
The permanent file id part.


cosSetEncryption

public void cosSetEncryption(COSDictionary encryption)
Set the /Encrypt field of the trailer.

Parameters:
encryption - The new encryption dictionary

getInfoDict

public COSInfoDict getInfoDict()
The COSInfoDict containing metadata.

Returns:
The COSInfoDict containing metadata.

getPrev

public int getPrev()
Returns:
Offset of previous trailer dict or -1 if none exists

getRoot

public COSCatalog getRoot()
Get the root object (the catalog) for the document.

Returns:
The root object (the catalog) for the document.

getSize

public int getSize()
Returns:
Total number of indirect objects in the document

invalidateCaches

public void invalidateCaches()
Description copied from class: COSBasedObject
Invalidate all local caches as the base object may have changed.

Overrides:
invalidateCaches in class COSBasedObject

setInfoDict

public void setInfoDict(COSInfoDict infoDict)
Set the info dictionary containing metadata.

Parameters:
infoDict - The info dictionary containing metadata.

setRoot

public void setRoot(COSCatalog root)
Set the catalog.

Parameters:
root - The document catalog

updateFileID

public void updateFileID()
Generates a unique file ID array (10.3).


jPod PDF library

Copyright © 2008 intarsys consulting GmbH. All Rights Reserved.