Abstract PDF annotation representation class

An annotation associates an object such as a note, sound, or movie with a location on a page of a PDF document, or provides a way to interact with the user by means of the mouse and keyboard.

package Zend_Pdf
subpackage Annotation
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Annotation object constructor

__construct(\Zend_Pdf_Element $annotationDictionary) 

Parameters

$annotationDictionary

Exceptions

\Zend_Pdf_Exception

Get bottom edge of the annotation rectangle.

getBottom() : float

Returns

float

Get left edge of the annotation rectangle.

getLeft() : float

Returns

float

Get right edge of the annotation rectangle.

getRight() : float

Returns

float

Return text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form.

getText() : string

Returns

string

Get top edge of the annotation rectangle.

getTop() : float

Returns

float

Set bottom edge of the annotation rectangle.

setBottom(float $bottom) : \Zend_Pdf_Annotation

Parameters

$bottom

float

Returns

\Zend_Pdf_Annotation

Set left edge of the annotation rectangle.

setLeft(float $left) : \Zend_Pdf_Annotation

Parameters

$left

float

Returns

\Zend_Pdf_Annotation

Set right edge of the annotation rectangle.

setRight(float $right) : \Zend_Pdf_Annotation

Parameters

$right

float

Returns

\Zend_Pdf_Annotation

Set text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form.

setText(string $text) : \Zend_Pdf_Annotation

Parameters

$text

string

Returns

\Zend_Pdf_Annotation

Set top edge of the annotation rectangle.

setTop(float $top) : \Zend_Pdf_Annotation

Parameters

$top

float

Returns

\Zend_Pdf_Annotation

 Properties

 

Annotation dictionary

$_annotationDictionary : \Zend_Pdf_Element_Dictionary | \Zend_Pdf_Element_Object | \Zend_Pdf_Element_Reference

Default