Pdf/Annotation.php
inherited
Classes
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 [email protected] 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 24593 2012-01-05 20:35:02Z matthew $
\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
\Zend_Pdf_Element_Dictionary|\Zend_Pdf_Element_Object|\Zend_Pdf_Element_Reference $_annotationDictionary = Annotation dictionary
Methods
__construct( $annotationDictionary) : voidAnnotation object constructor
| Name | Type | Description |
|---|---|---|
| $annotationDictionary |
| Exception | Description |
|---|---|
| \Zend_Pdf_Exception |
getBottom() : floatGet bottom edge of the annotation rectangle.
| Type | Description |
|---|---|
| float |
getLeft() : floatGet left edge of the annotation rectangle.
| Type | Description |
|---|---|
| float |
getRight() : floatGet right edge of the annotation rectangle.
| Type | Description |
|---|---|
| float |
getText() : stringReturn 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.
| Type | Description |
|---|---|
| string |
getTop() : floatGet top edge of the annotation rectangle.
| Type | Description |
|---|---|
| float |
setBottom(float $bottom) : \Zend_Pdf_AnnotationSet bottom edge of the annotation rectangle.
| Name | Type | Description |
|---|---|---|
| $bottom | float |
| Type | Description |
|---|---|
| \Zend_Pdf_Annotation |
setLeft(float $left) : \Zend_Pdf_AnnotationSet left edge of the annotation rectangle.
| Name | Type | Description |
|---|---|---|
| $left | float |
| Type | Description |
|---|---|
| \Zend_Pdf_Annotation |
setRight(float $right) : \Zend_Pdf_AnnotationSet right edge of the annotation rectangle.
| Name | Type | Description |
|---|---|---|
| $right | float |
| Type | Description |
|---|---|
| \Zend_Pdf_Annotation |
setText(string $text) : \Zend_Pdf_AnnotationSet 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.
| Name | Type | Description |
|---|---|---|
| $text | string |
| Type | Description |
|---|---|
| \Zend_Pdf_Annotation |
setTop(float $top) : \Zend_Pdf_AnnotationSet top edge of the annotation rectangle.
| Name | Type | Description |
|---|---|---|
| $top | float |
| Type | Description |
|---|---|
| \Zend_Pdf_Annotation |