Package | org.purepdf.pdf |
Class | public class PdfAnnotation |
Inheritance | PdfAnnotation PdfDictionary PdfObject it.sephiroth.utils.ObjectHash |
Subclasses | PdfFormField |
Property | Defined By | ||
---|---|---|---|
action : PdfAction [write-only] | PdfAnnotation | ||
_annotation : Boolean = true | PdfAnnotation | ||
annotation : Boolean | PdfAnnotation | ||
appearanceState : String [write-only] | PdfAnnotation | ||
borderStyle : PdfBorderDictionary [write-only] | PdfAnnotation | ||
color : RGBColor [write-only] | PdfAnnotation | ||
defaultAppearanceString : PdfContentByte [write-only] | PdfAnnotation | ||
flags : int [write-only] | PdfAnnotation | ||
form : Boolean | PdfAnnotation | ||
indirectReference : PdfIndirectReference [read-only]
Returns an indirect reference to the annotation
| PdfAnnotation | ||
isAnnotation : Boolean [read-only] | PdfAnnotation | ||
isForm : Boolean [read-only] | PdfAnnotation | ||
mkBackgroundColor : RGBColor [write-only] | PdfAnnotation | ||
mkBorderColor : RGBColor [write-only] | PdfAnnotation | ||
mkRotation : int [write-only] | PdfAnnotation | ||
placeInPage : int [read-only] | PdfAnnotation | ||
popup : PdfAnnotation [write-only] | PdfAnnotation | ||
size : int [read-only] | PdfDictionary | ||
_templates : HashMap | PdfAnnotation | ||
templates : HashMap | PdfAnnotation | ||
writer : PdfWriter | PdfAnnotation |
Property | Defined By | ||
---|---|---|---|
bytes : Bytes | PdfObject | ||
dictionaryType : PdfName | PdfDictionary | ||
_form : Boolean = false | PdfAnnotation | ||
hashMap : HashMap | PdfDictionary | ||
indRef : PRIndirectReference | PdfObject | ||
mk : PdfDictionary [read-only] | PdfAnnotation | ||
_placeInPage : int = -1 | PdfAnnotation | ||
reference : PdfIndirectReference | PdfAnnotation | ||
type : int | PdfObject | ||
used : Boolean = false | PdfAnnotation | ||
_writer : PdfWriter | PdfAnnotation |
Method | Defined By | ||
---|---|---|---|
PdfAnnotation | |||
canBeInObjStm():Boolean
Whether this object can be contained in an object stream. | PdfObject | ||
PdfDictionary | |||
[static]
| PdfAnnotation | ||
createFileAttachment(writer:PdfWriter, rect:RectangleElement, contents:String, fileStore:ByteArray, fileDisplay:String):PdfAnnotation [static]
Creates a file attachment annotation. | PdfAnnotation | ||
createFreeText(writer:PdfWriter, rect:RectangleElement, contents:String, defaultAppearance:PdfContentByte):PdfAnnotation [static]
Add some free text to the document. | PdfAnnotation | ||
createLine(writer:PdfWriter, rect:RectangleElement, contents:String, x1:Number, y1:Number, x2:Number, y2:Number):PdfAnnotation [static]
Adds a line to the document. | PdfAnnotation | ||
createLink(writer:PdfWriter, rect:RectangleElement, highlight:PdfName, action:PdfAction):PdfAnnotation [static]
Creates an Annotation with an Action. | PdfAnnotation | ||
createLink2(writer:PdfWriter, rect:RectangleElement, highlight:PdfName, namedDestination:String):PdfAnnotation [static]
Creates an Annotation with an local destination. | PdfAnnotation | ||
createLink3(writer:PdfWriter, rect:RectangleElement, highlight:PdfName, page:int, dest:PdfDestination):PdfAnnotation [static]
Creates an Annotation with a PdfDestination. | PdfAnnotation | ||
[static]
Adds a popup to your document. | PdfAnnotation | ||
createScreen(writer:PdfWriter, rect:RectangleElement, clipTitle:String, fs:PdfFileSpecification, mimeType:String, playOnDisplay:Boolean):PdfAnnotation [static]
Creates a screen PdfAnnotation
| PdfAnnotation | ||
createSquareCircle(writer:PdfWriter, rect:RectangleElement, contents:String, square:Boolean):PdfAnnotation [static]
Adds a circle or a square that shows a tooltip when you pass over it. | PdfAnnotation | ||
createText(writer:PdfWriter, rect:RectangleElement, title:String, contents:String, opened:Boolean, icon:String):PdfAnnotation [static] | PdfAnnotation | ||
dispose():void | PdfObject | ||
Returns a PdfObject as a PdfArray,
resolving indirect references. | PdfDictionary | ||
PdfDictionary | |||
Returns a PdfObject as a PdfNumber,
resolving indirect references. | PdfDictionary | ||
PdfObject | |||
Returns the PdfObject associated to the specified
key, resolving a possible indirect reference to a direct
object. | PdfDictionary | ||
PdfObject | |||
getKeys():KeySet | PdfDictionary | ||
[static] | PdfAnnotation | ||
getType():int | PdfObject | ||
getUsed():Boolean | PdfAnnotation | ||
PdfDictionary | |||
isArray():Boolean | PdfObject | ||
isBoolean():Boolean | PdfObject | ||
isDictionary():Boolean | PdfObject | ||
isIndirect():Boolean | PdfObject | ||
isName():Boolean | PdfObject | ||
isNull():Boolean | PdfObject | ||
isNumber():Boolean | PdfObject | ||
isStream():Boolean
Checks if this PdfObject is of the type PdfStream
| PdfObject | ||
isString():Boolean | PdfObject | ||
merge(other:PdfDictionary):void | PdfDictionary | ||
mergeDifferent(other:PdfDictionary):void | PdfDictionary | ||
PdfDictionary | |||
putAll(other:PdfDictionary):void | PdfDictionary | ||
Associates the specified PdfObject as value to the
specified PdfName as key in this map. | PdfDictionary | ||
PdfDictionary | |||
PdfAnnotation | |||
PdfAnnotation | |||
PdfAnnotation | |||
setIndRef(indRef:PRIndirectReference):void
Set the indirect reference
| PdfObject | ||
setPage():void | PdfAnnotation | ||
setUsed():void | PdfAnnotation | ||
[override] | PdfDictionary | ||
toString():String [override] | PdfDictionary |
Method | Defined By | ||
---|---|---|---|
[static]
Creates a link. | PdfAnnotation | ||
setContent(content:String):void | PdfObject |
Constant | Defined By | ||
---|---|---|---|
AA_BLUR : PdfName [static] | PdfAnnotation | ||
AA_DOWN : PdfName [static] | PdfAnnotation | ||
AA_ENTER : PdfName [static] | PdfAnnotation | ||
AA_EXIT : PdfName [static] | PdfAnnotation | ||
AA_FOCUS : PdfName [static] | PdfAnnotation | ||
AA_JS_CHANGE : PdfName [static] | PdfAnnotation | ||
AA_JS_FORMAT : PdfName [static] | PdfAnnotation | ||
AA_JS_KEY : PdfName [static] | PdfAnnotation | ||
AA_JS_OTHER_CHANGE : PdfName [static] | PdfAnnotation | ||
AA_UP : PdfName [static] | PdfAnnotation | ||
APPEARANCE_DOWN : PdfName [static] | PdfAnnotation | ||
APPEARANCE_NORMAL : PdfName [static] | PdfAnnotation | ||
APPEARANCE_ROLLOVER : PdfName [static] | PdfAnnotation | ||
ARRAY : int = 5 [static] | PdfObject | ||
BOOLEAN : int = 1 [static] | PdfObject | ||
CATALOG : PdfName [static] | PdfDictionary | ||
DICTIONARY : int = 6 [static] | PdfObject | ||
FLAGS_HIDDEN : int = 2 [static] | PdfAnnotation | ||
FLAGS_INVISIBLE : int = 1 [static] | PdfAnnotation | ||
FLAGS_LOCKED : int = 128 [static] | PdfAnnotation | ||
FLAGS_NOROTATE : int = 16 [static] | PdfAnnotation | ||
FLAGS_NOVIEW : int = 32 [static] | PdfAnnotation | ||
FLAGS_NOZOOM : int = 8 [static] | PdfAnnotation | ||
FLAGS_PRINT : int = 4 [static] | PdfAnnotation | ||
FLAGS_READONLY : int = 64 [static] | PdfAnnotation | ||
FLAGS_TOGGLENOVIEW : int = 256 [static] | PdfAnnotation | ||
HIGHLIGHT_INVERT : PdfName [static] | PdfAnnotation | ||
HIGHLIGHT_NONE : PdfName [static] | PdfAnnotation | ||
HIGHLIGHT_OUTLINE : PdfName [static] | PdfAnnotation | ||
HIGHLIGHT_PUSH : PdfName [static] | PdfAnnotation | ||
HIGHLIGHT_TOGGLE : PdfName [static] | PdfAnnotation | ||
INDIRECT : int = 10 [static] | PdfObject | ||
MARKUP_HIGHLIGHT : int = 0 [static] | PdfAnnotation | ||
MARKUP_SQUIGGLY : int = 3 [static] | PdfAnnotation | ||
MARKUP_STRIKEOUT : int = 2 [static] | PdfAnnotation | ||
MARKUP_UNDERLINE : int = 1 [static] | PdfAnnotation | ||
NAME : int = 4 [static] | PdfObject | ||
NOTHING : String [static] | PdfObject | ||
NULL : int = 8 [static] | PdfObject | ||
NUMBER : int = 2 [static] | PdfObject | ||
OUTLINES : PdfName [static] | PdfDictionary | ||
PAGE : PdfName [static] | PdfDictionary | ||
STREAM : int = 7 [static] | PdfObject | ||
STRING : int = 3 [static] | PdfObject | ||
TEXT_PDFDOCENCODING : String = PDF [static] | PdfObject | ||
TEXT_UNICODE : String = UnicodeBig [static] | PdfObject |
_annotation | property |
public var _annotation:Boolean = true
_form | property |
protected var _form:Boolean = false
_placeInPage | property |
protected var _placeInPage:int = -1
_templates | property |
public var _templates:HashMap
_writer | property |
protected var _writer:PdfWriter
action | property |
annotation | property |
annotation:Boolean
public function get annotation():Boolean
public function set annotation(value:Boolean):void
appearanceState | property |
appearanceState:String
[write-only] public function set appearanceState(value:String):void
borderStyle | property |
borderStyle:PdfBorderDictionary
[write-only] public function set borderStyle(value:PdfBorderDictionary):void
color | property |
defaultAppearanceString | property |
defaultAppearanceString:PdfContentByte
[write-only] public function set defaultAppearanceString(value:PdfContentByte):void
flags | property |
flags:int
[write-only] public function set flags(value:int):void
form | property |
form:Boolean
public function get form():Boolean
public function set form(value:Boolean):void
indirectReference | property |
indirectReference:PdfIndirectReference
[read-only] Returns an indirect reference to the annotation
public function get indirectReference():PdfIndirectReference
isAnnotation | property |
isAnnotation:Boolean
[read-only] public function get isAnnotation():Boolean
isForm | property |
isForm:Boolean
[read-only] public function get isForm():Boolean
mk | property |
mkBackgroundColor | property |
mkBackgroundColor:RGBColor
[write-only] public function set mkBackgroundColor(value:RGBColor):void
mkBorderColor | property |
mkBorderColor:RGBColor
[write-only] public function set mkBorderColor(value:RGBColor):void
mkRotation | property |
mkRotation:int
[write-only] public function set mkRotation(value:int):void
placeInPage | property |
placeInPage:int
[read-only] public function get placeInPage():int
popup | property |
reference | property |
protected var reference:PdfIndirectReference
templates | property |
templates:HashMap
public function get templates():HashMap
public function set templates(value:HashMap):void
used | property |
protected var used:Boolean = false
writer | property |
writer:PdfWriter
public function get writer():PdfWriter
public function set writer(value:PdfWriter):void
PdfAnnotation | () | Constructor |
public function PdfAnnotation($writer:PdfWriter, rect:RectangleElement = null, action:PdfAction = null)
$writer:PdfWriter | |
rect:RectangleElement (default = null )
| |
action:PdfAction (default = null )
|
_createLink | () | method |
protected static function _createLink(writer:PdfWriter, rect:RectangleElement, highlight:PdfName):PdfAnnotation
Creates a link.
Parameters
writer:PdfWriter | |
rect:RectangleElement | |
highlight:PdfName |
PdfAnnotation — A PdfAnnotation
|
createAction | () | method |
public static function createAction(writer:PdfWriter, rect:RectangleElement, action:PdfAction):PdfAnnotation
Parameters
writer:PdfWriter | |
rect:RectangleElement | |
action:PdfAction |
PdfAnnotation — |
createFileAttachment | () | method |
public static function createFileAttachment(writer:PdfWriter, rect:RectangleElement, contents:String, fileStore:ByteArray, fileDisplay:String):PdfAnnotation
Creates a file attachment annotation.
Parameters
writer:PdfWriter | |
rect:RectangleElement — the dimensions in the page of the annotation
| |
contents:String — the file description
| |
fileStore:ByteArray — ByteArray of the file contents
| |
fileDisplay:String — the actual file name stored in the pdf
|
PdfAnnotation — the annotation
|
createFreeText | () | method |
public static function createFreeText(writer:PdfWriter, rect:RectangleElement, contents:String, defaultAppearance:PdfContentByte):PdfAnnotation
Add some free text to the document.
Parameters
writer:PdfWriter | |
rect:RectangleElement | |
contents:String | |
defaultAppearance:PdfContentByte |
PdfAnnotation — A PdfAnnotation
|
createLine | () | method |
public static function createLine(writer:PdfWriter, rect:RectangleElement, contents:String, x1:Number, y1:Number, x2:Number, y2:Number):PdfAnnotation
Adds a line to the document. Move over the line and a tooltip is shown.
Parameters
writer:PdfWriter | |
rect:RectangleElement | |
contents:String | |
x1:Number | |
y1:Number | |
x2:Number | |
y2:Number |
PdfAnnotation — A PdfAnnotation
|
createLink | () | method |
public static function createLink(writer:PdfWriter, rect:RectangleElement, highlight:PdfName, action:PdfAction):PdfAnnotation
Creates an Annotation with an Action.
Parameters
writer:PdfWriter | |
rect:RectangleElement | |
highlight:PdfName | |
action:PdfAction |
PdfAnnotation — A PdfAnnotation
|
createLink2 | () | method |
public static function createLink2(writer:PdfWriter, rect:RectangleElement, highlight:PdfName, namedDestination:String):PdfAnnotation
Creates an Annotation with an local destination.
Parameters
writer:PdfWriter | |
rect:RectangleElement | |
highlight:PdfName | |
namedDestination:String |
PdfAnnotation — A PdfAnnotation
|
createLink3 | () | method |
public static function createLink3(writer:PdfWriter, rect:RectangleElement, highlight:PdfName, page:int, dest:PdfDestination):PdfAnnotation
Creates an Annotation with a PdfDestination.
Parameters
writer:PdfWriter | |
rect:RectangleElement | |
highlight:PdfName | |
page:int | |
dest:PdfDestination |
PdfAnnotation — A PdfAnnotation
|
createPopup | () | method |
public static function createPopup(writer:PdfWriter, rect:RectangleElement, contents:String, open:Boolean):PdfAnnotation
Adds a popup to your document.
Parameters
writer:PdfWriter | |
rect:RectangleElement | |
contents:String | |
open:Boolean |
PdfAnnotation — A PdfAnnotation
|
createScreen | () | method |
public static function createScreen(writer:PdfWriter, rect:RectangleElement, clipTitle:String, fs:PdfFileSpecification, mimeType:String, playOnDisplay:Boolean):PdfAnnotation
Creates a screen PdfAnnotation
Parameters
writer:PdfWriter | |
rect:RectangleElement | |
clipTitle:String | |
fs:PdfFileSpecification | |
mimeType:String | |
playOnDisplay:Boolean |
PdfAnnotation — a screen PdfAnnotation
|
IOError
|
createSquareCircle | () | method |
public static function createSquareCircle(writer:PdfWriter, rect:RectangleElement, contents:String, square:Boolean):PdfAnnotation
Adds a circle or a square that shows a tooltip when you pass over it.
Parameters
writer:PdfWriter | |
rect:RectangleElement | |
contents:String — The tooltip
| |
square:Boolean — true if you want a square, false if you want a circle
|
PdfAnnotation — A PdfAnnotation
|
createText | () | method |
public static function createText(writer:PdfWriter, rect:RectangleElement, title:String, contents:String, opened:Boolean, icon:String):PdfAnnotation
Parameters
writer:PdfWriter | |
rect:RectangleElement | |
title:String | |
contents:String | |
opened:Boolean | |
icon:String |
PdfAnnotation |
getMKColor | () | method |
getUsed | () | method |
public function getUsed():Boolean
ReturnsBoolean |
setAdditionalActions | () | method |
public function setAdditionalActions(key:PdfName, action:PdfAction):void
Parameters
key:PdfName | |
action:PdfAction |
setAppearance | () | method |
public function setAppearance(ap:PdfName, template:PdfTemplate):void
Parameters
ap:PdfName | |
template:PdfTemplate |
setAppearanceState | () | method |
public function setAppearanceState(ap:PdfName, state:String, template:PdfTemplate):void
Parameters
ap:PdfName | |
state:String | |
template:PdfTemplate |
setPage | () | method |
public function setPage():void
setUsed | () | method |
public function setUsed():void
AA_BLUR | Constant |
public static const AA_BLUR:PdfName
AA_DOWN | Constant |
public static const AA_DOWN:PdfName
AA_ENTER | Constant |
public static const AA_ENTER:PdfName
AA_EXIT | Constant |
public static const AA_EXIT:PdfName
AA_FOCUS | Constant |
public static const AA_FOCUS:PdfName
AA_JS_CHANGE | Constant |
public static const AA_JS_CHANGE:PdfName
AA_JS_FORMAT | Constant |
public static const AA_JS_FORMAT:PdfName
AA_JS_KEY | Constant |
public static const AA_JS_KEY:PdfName
AA_JS_OTHER_CHANGE | Constant |
public static const AA_JS_OTHER_CHANGE:PdfName
AA_UP | Constant |
public static const AA_UP:PdfName
APPEARANCE_DOWN | Constant |
public static const APPEARANCE_DOWN:PdfName
APPEARANCE_NORMAL | Constant |
public static const APPEARANCE_NORMAL:PdfName
APPEARANCE_ROLLOVER | Constant |
public static const APPEARANCE_ROLLOVER:PdfName
FLAGS_HIDDEN | Constant |
public static const FLAGS_HIDDEN:int = 2
FLAGS_INVISIBLE | Constant |
public static const FLAGS_INVISIBLE:int = 1
FLAGS_LOCKED | Constant |
public static const FLAGS_LOCKED:int = 128
FLAGS_NOROTATE | Constant |
public static const FLAGS_NOROTATE:int = 16
FLAGS_NOVIEW | Constant |
public static const FLAGS_NOVIEW:int = 32
FLAGS_NOZOOM | Constant |
public static const FLAGS_NOZOOM:int = 8
FLAGS_PRINT | Constant |
public static const FLAGS_PRINT:int = 4
FLAGS_READONLY | Constant |
public static const FLAGS_READONLY:int = 64
FLAGS_TOGGLENOVIEW | Constant |
public static const FLAGS_TOGGLENOVIEW:int = 256
HIGHLIGHT_INVERT | Constant |
public static const HIGHLIGHT_INVERT:PdfName
HIGHLIGHT_NONE | Constant |
public static const HIGHLIGHT_NONE:PdfName
HIGHLIGHT_OUTLINE | Constant |
public static const HIGHLIGHT_OUTLINE:PdfName
HIGHLIGHT_PUSH | Constant |
public static const HIGHLIGHT_PUSH:PdfName
HIGHLIGHT_TOGGLE | Constant |
public static const HIGHLIGHT_TOGGLE:PdfName
MARKUP_HIGHLIGHT | Constant |
public static const MARKUP_HIGHLIGHT:int = 0
MARKUP_SQUIGGLY | Constant |
public static const MARKUP_SQUIGGLY:int = 3
MARKUP_STRIKEOUT | Constant |
public static const MARKUP_STRIKEOUT:int = 2
MARKUP_UNDERLINE | Constant |
public static const MARKUP_UNDERLINE:int = 1