Packageorg.purepdf.pdf
Classpublic class PdfAction
InheritancePdfAction Inheritance PdfDictionary Inheritance PdfObject Inheritance it.sephiroth.utils.ObjectHash

A PdfAction defines an action that can be triggered



Public Properties
 PropertyDefined By
 Inheritedsize : int
[read-only]
PdfDictionary
Protected Properties
 PropertyDefined By
 Inheritedbytes : Bytes
PdfObject
 InheriteddictionaryType : PdfName
PdfDictionary
 InheritedhashMap : HashMap
PdfDictionary
 InheritedindRef : PRIndirectReference
PdfObject
 Inheritedtype : int
PdfObject
Public Methods
 MethodDefined By
  
PdfAction
 Inherited
canBeInObjStm():Boolean
Whether this object can be contained in an object stream.
PdfObject
 Inherited
contains(key:PdfName):Boolean
PdfDictionary
 Inherited
dispose():void
PdfObject
  
[static]
PdfAction
  
fromNamed(named:int):PdfAction
[static] Creates a new PDfAction from a named action
PdfAction
  
fromURL(url:String, isMap:Boolean = false):PdfAction
[static]
PdfAction
 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
  
javaScript(code:String, writer:PdfWriter, unicode:Boolean = false):PdfAction
[static] Create a JavaScript action.
PdfAction
 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
  
rendition(file:String, fs:PdfFileSpecification, mimeType:String, ref:PdfIndirectReference):PdfAction
[static] Creates a Rendition action
PdfAction
 Inherited
Set the indirect reference
PdfObject
 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
  FIRSTPAGE : int = 1
[static]
PdfAction
 InheritedINDIRECT : int = 10
[static]
PdfObject
  LASTPAGE : int = 4
[static]
PdfAction
 InheritedNAME : int = 4
[static]
PdfObject
  NEXTPAGE : int = 3
[static]
PdfAction
 InheritedNOTHING : String
[static]
PdfObject
 InheritedNULL : int = 8
[static]
PdfObject
 InheritedNUMBER : int = 2
[static]
PdfObject
 InheritedOUTLINES : PdfName
[static]
PdfDictionary
 InheritedPAGE : PdfName
[static]
PdfDictionary
  PREVPAGE : int = 2
[static]
PdfAction
  PRINTDIALOG : int = 5
[static]
PdfAction
 InheritedSTREAM : int = 7
[static]
PdfObject
 InheritedSTRING : int = 3
[static]
PdfObject
 InheritedTEXT_PDFDOCENCODING : String = PDF
[static]
PdfObject
 InheritedTEXT_UNICODE : String = UnicodeBig
[static]
PdfObject
Constructor Detail
PdfAction()Constructor
public function PdfAction()



Method Detail
fromDestination()method
public static function fromDestination(destination:PdfIndirectReference):PdfAction

Parameters

destination:PdfIndirectReference

Returns
PdfAction
fromNamed()method 
public static function fromNamed(named:int):PdfAction

Creates a new PDfAction from a named action

Parameters

named:int

Returns
PdfAction

See also

fromURL()method 
public static function fromURL(url:String, isMap:Boolean = false):PdfAction

Parameters

url:String
 
isMap:Boolean (default = false)

Returns
PdfAction
javaScript()method 
public static function javaScript(code:String, writer:PdfWriter, unicode:Boolean = false):PdfAction

Create a JavaScript action. If the JavaScript is smaller than 50 characters it will be placed as a string, otherwise it will be placed as a compressed stream.

Parameters

code:String — the JavaScript code
 
writer:PdfWriter — the writer for this action
 
unicode:Boolean (default = false)

Returns
PdfAction — the JavaScript action
rendition()method 
public static function rendition(file:String, fs:PdfFileSpecification, mimeType:String, ref:PdfIndirectReference):PdfAction

Creates a Rendition action

Parameters

file:String
 
fs:PdfFileSpecification
 
mimeType:String
 
ref:PdfIndirectReference

Returns
PdfAction — a Media Clip action

Throws
IOError
Constant Detail
FIRSTPAGEConstant
public static const FIRSTPAGE:int = 1

LASTPAGEConstant 
public static const LASTPAGE:int = 4

NEXTPAGEConstant 
public static const NEXTPAGE:int = 3

PREVPAGEConstant 
public static const PREVPAGE:int = 2

PRINTDIALOGConstant 
public static const PRINTDIALOG:int = 5