de.intarsys.pdf.pd
Class PDFileSpecification

java.lang.Object
  de.intarsys.pdf.cos.COSBasedObject
      de.intarsys.pdf.pd.PDObject
          de.intarsys.pdf.pd.PDFileSpecification

All Implemented Interfaces:

ICOSObjectListener, de.intarsys.tools.attribute.IAttributeSupport

Direct Known Subclasses:

PDFileSpecificationURL

public class PDFileSpecification
extends PDObject

Repesents the PDF's FileSpecification-type

Nested Class Summary

static class

PDFileSpecification.MetaClass The meta class implementation

Field Summary

static COSName	CN_F_DOS File specification string for DOS files
static COSName	CN_F_Mac File specification string for Macintosh files
static COSName	CN_F_Unix File specification string for UNIX files
static COSName	CN_FS_URL File URL
static COSName	CN_Type_Alt_Filespec
static COSName	CN_Type_Filespec
static COSName	DK_Desc Description
static COSName	DK_EF Embedded file dict
static COSName	DK_F File
static COSName	DK_FS Name of the file system.
static COSName	DK_RF Embedded file array dict.
static COSName	DK_UF Unicode File
static PDFileSpecification.MetaClass	META The meta class instance

Fields inherited from class de.intarsys.pdf.pd.PDObject

DK_Subtype, DK_Type

Method Summary

String	getDescription()
PDEmbeddedFile	getEmbeddedFile(COSName flavor) The embedded file of a specific flavor (one of F, DOS, Mac, Unix),
COSDictionary	getEmbeddedFiles() The dictionary mapping the F/DOC/Mac/Unix entries of the file spec to embedded file dictionaries.
String	getFile()
String	getFileSpecificationString(COSName flavor)
COSName	getFileSystem()
void	setDescription(String description)
void	setEmbeddedFile(COSName flavor, PDEmbeddedFile embeddedFile)
void	setFile(String file)
void	setFileSpecificationString(COSName flavor, String spec)
void	setFileSystem(COSName bs)

Methods inherited from class de.intarsys.pdf.pd.PDObject

cosGetFieldDescendant, cosGetFieldInheritable, cosGetFieldInherited, cosGetSubtype, cosGetType, cosRemoveFieldInheritable, cosSetFieldInheritable, cosSetSubtype, cosSetType, getDoc, getGenericChildren, getGenericParent, setGenericParent, toString

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

Methods inherited from class java.lang.Object

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

Field Detail

CN_Type_Filespec

public static final COSName CN_Type_Filespec

CN_Type_Alt_Filespec

public static final COSName CN_Type_Alt_Filespec

META

public static final PDFileSpecification.MetaClass META

The meta class instance

DK_FS

public static final COSName DK_FS

Name of the file system.

DK_F

public static final COSName DK_F

File

DK_UF

public static final COSName DK_UF

Unicode File

CN_F_DOS

public static final COSName CN_F_DOS

File specification string for DOS files

CN_F_Mac

public static final COSName CN_F_Mac

File specification string for Macintosh files

CN_F_Unix

public static final COSName CN_F_Unix

File specification string for UNIX files

CN_FS_URL

public static final COSName CN_FS_URL

File URL

DK_EF

public static final COSName DK_EF

Embedded file dict

DK_RF

public static final COSName DK_RF

Embedded file array dict.

DK_Desc

public static final COSName DK_Desc

Description

Method Detail

getDescription

public String getDescription()

getEmbeddedFile

public PDEmbeddedFile getEmbeddedFile(COSName flavor)

The embedded file of a specific flavor (one of F, DOS, Mac, Unix),

Parameters:

flavor - One of F, DOC, Mac, Unix

Returns:

the embedded file of this flavor, if any, or null.

getEmbeddedFiles

public COSDictionary getEmbeddedFiles()

The dictionary mapping the F/DOC/Mac/Unix entries of the file spec to embedded file dictionaries.

getFile

public String getFile()

getFileSpecificationString

public String getFileSpecificationString(COSName flavor)

getFileSystem

public COSName getFileSystem()

setDescription

public void setDescription(String description)

setEmbeddedFile

public void setEmbeddedFile(COSName flavor,
                            PDEmbeddedFile embeddedFile)

setFile

public void setFile(String file)

setFileSpecificationString

public void setFileSpecificationString(COSName flavor,
                                       String spec)

setFileSystem

public void setFileSystem(COSName bs)