API Documentation

Zend/Pdf/Annotation.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Pdf  
Subpackage
Annotation  
Version
$Id: Annotation.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Pdf_Annotation

Package: Zend\Pdf\Annotation

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.

Children
\Zend_Pdf_Annotation_Markup
\Zend_Pdf_Annotation_Text
\Zend_Pdf_Annotation_Link
\Zend_Pdf_Annotation_FileAttachment
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotected\Zend_Pdf_Element_Dictionary|\Zend_Pdf_Element_Object|\Zend_Pdf_Element_Reference  $_annotationDictionary= ''

Annotation dictionary

Methods

methodpublic__construct(  $annotationDictionary ) : void

Annotation object constructor

Parameters
Name Type Description
$annotationDictionary
Throws
Exception Description
\Zend_Pdf_Exception
methodpublicgetBottom( ) : float

Get bottom edge of the annotation rectangle.

Returns
Type Description
float
methodpublicgetLeft( ) : float

Get left edge of the annotation rectangle.

Returns
Type Description
float
methodpublicgetRight( ) : float

Get right edge of the annotation rectangle.

Returns
Type Description
float
methodpublicgetText( ) : string

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.

Returns
Type Description
string
methodpublicgetTop( ) : float

Get top edge of the annotation rectangle.

Returns
Type Description
float
methodpublicsetBottom( float $bottom ) : \Zend_Pdf_Annotation

Set bottom edge of the annotation rectangle.

Parameters
Name Type Description
$bottom float
Returns
Type Description
\Zend_Pdf_Annotation
methodpublicsetLeft( float $left ) : \Zend_Pdf_Annotation

Set left edge of the annotation rectangle.

Parameters
Name Type Description
$left float
Returns
Type Description
\Zend_Pdf_Annotation
methodpublicsetRight( float $right ) : \Zend_Pdf_Annotation

Set right edge of the annotation rectangle.

Parameters
Name Type Description
$right float
Returns
Type Description
\Zend_Pdf_Annotation
methodpublicsetText( string $text ) : \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.

Parameters
Name Type Description
$text string
Returns
Type Description
\Zend_Pdf_Annotation
methodpublicsetTop( float $top ) : \Zend_Pdf_Annotation

Set top edge of the annotation rectangle.

Parameters
Name Type Description
$top float
Returns
Type Description
\Zend_Pdf_Annotation
Documentation was generated by DocBlox 0.15.1.