Packageorg.purepdf.pdf
Classpublic class PdfFileSpecification
InheritancePdfFileSpecification Inheritance PdfDictionary Inheritance PdfObject Inheritance it.sephiroth.utils.ObjectHash



Public Properties
 PropertyDefined By
  reference : PdfIndirectReference
[read-only] Gets the indirect reference to this file specification.
PdfFileSpecification
 Inheritedsize : int
[read-only]
PdfDictionary
Protected Properties
 PropertyDefined By
 Inheritedbytes : Bytes
PdfObject
 InheriteddictionaryType : PdfName
PdfDictionary
 InheritedhashMap : HashMap
PdfDictionary
 InheritedindRef : PRIndirectReference
PdfObject
  ref : PdfIndirectReference
PdfFileSpecification
 Inheritedtype : int
PdfObject
  writer : PdfWriter
PdfFileSpecification
Public Methods
 MethodDefined By
  
PdfFileSpecification
  
addDescription(description:String, unicode:Boolean):void
Adds a description for the file that is specified here.
PdfFileSpecification
 Inherited
canBeInObjStm():Boolean
Whether this object can be contained in an object stream.
PdfObject
 Inherited
contains(key:PdfName):Boolean
PdfDictionary
 Inherited
dispose():void
PdfObject
  
fileEmbedded(writer:PdfWriter, fileDisplay:String, fileStore:ByteArray, compress:Boolean, mimeType:String = null, fileParameter:PdfDictionary = null):PdfFileSpecification
[static]
PdfFileSpecification
 Inherited
Returns a PdfObject as a PdfArray, resolving indirect references.
PdfDictionary
 Inherited
PdfDictionary
 Inherited
Returns a PdfObject as a PdfNumber, resolving indirect references.
PdfDictionary
 Inherited
PdfObject
 Inherited
Returns the PdfObject associated to the specified key, resolving a possible indirect reference to a direct object.
PdfDictionary
 Inherited
PdfObject
 Inherited
getKeys():KeySet
PdfDictionary
 Inherited
getType():int
PdfObject
 Inherited
PdfDictionary
 Inherited
isArray():Boolean
PdfObject
 Inherited
isBoolean():Boolean
PdfObject
 Inherited
isDictionary():Boolean
PdfObject
 Inherited
isIndirect():Boolean
PdfObject
 Inherited
isName():Boolean
PdfObject
 Inherited
isNull():Boolean
PdfObject
 Inherited
isNumber():Boolean
PdfObject
 Inherited
isStream():Boolean
Checks if this PdfObject is of the type PdfStream
PdfObject
 Inherited
isString():Boolean
PdfObject
 Inherited
merge(other:PdfDictionary):void
PdfDictionary
 Inherited
PdfDictionary
 Inherited
put(key:PdfName, object:PdfObject):void
PdfDictionary
 Inherited
putAll(other:PdfDictionary):void
PdfDictionary
 Inherited
putEx(key:PdfName, value:PdfObject):void
Associates the specified PdfObject as value to the specified PdfName as key in this map.
PdfDictionary
 Inherited
remove(key:PdfName):void
PdfDictionary
 Inherited
Set the indirect reference
PdfObject
  
setUnicodeFileName(filename:String, unicode:Boolean):void
PdfFileSpecification
 Inherited
toPdf(writer:PdfWriter, os:IOutputStream):void
[override]
PdfDictionary
 Inherited
toString():String
[override]
PdfDictionary
Protected Methods
 MethodDefined By
 Inherited
setContent(content:String):void
PdfObject
Public Constants
 ConstantDefined By
 InheritedARRAY : int = 5
[static]
PdfObject
 InheritedBOOLEAN : int = 1
[static]
PdfObject
 InheritedCATALOG : PdfName
[static]
PdfDictionary
 InheritedDICTIONARY : int = 6
[static]
PdfObject
 InheritedINDIRECT : int = 10
[static]
PdfObject
 InheritedNAME : int = 4
[static]
PdfObject
 InheritedNOTHING : String
[static]
PdfObject
 InheritedNULL : int = 8
[static]
PdfObject
 InheritedNUMBER : int = 2
[static]
PdfObject
 InheritedOUTLINES : PdfName
[static]
PdfDictionary
 InheritedPAGE : PdfName
[static]
PdfDictionary
 InheritedSTREAM : int = 7
[static]
PdfObject
 InheritedSTRING : int = 3
[static]
PdfObject
 InheritedTEXT_PDFDOCENCODING : String = PDF
[static]
PdfObject
 InheritedTEXT_UNICODE : String = UnicodeBig
[static]
PdfObject
Property Detail
refproperty
protected var ref:PdfIndirectReference

referenceproperty 
reference:PdfIndirectReference  [read-only]

Gets the indirect reference to this file specification. Multiple invocations will retrieve the same value.


Implementation
    public function get reference():PdfIndirectReference

Throws
IOException — on error
writerproperty 
protected var writer:PdfWriter

Constructor Detail
PdfFileSpecification()Constructor
public function PdfFileSpecification()



Method Detail
addDescription()method
public function addDescription(description:String, unicode:Boolean):void

Adds a description for the file that is specified here.

Parameters

description:String — some text
 
unicode:Boolean — if true, the text is added as a unicode string

fileEmbedded()method 
public static function fileEmbedded(writer:PdfWriter, fileDisplay:String, fileStore:ByteArray, compress:Boolean, mimeType:String = null, fileParameter:PdfDictionary = null):PdfFileSpecification

Parameters

writer:PdfWriter
 
fileDisplay:String
 
fileStore:ByteArray
 
compress:Boolean
 
mimeType:String (default = null)
 
fileParameter:PdfDictionary (default = null)

Returns
PdfFileSpecification
setUnicodeFileName()method 
public function setUnicodeFileName(filename:String, unicode:Boolean):void

Parameters

filename:String
 
unicode:Boolean