API Documentation

Pdf/Annotation/Text.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Pdf  
subpackage
Annotation  
version
$Id: Text.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Pdf_Annotation_Text

A text annotation represents a "sticky note" attached to a point in the PDF document.

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.

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

Methods

methodpublic__construct(  $annotationDictionary ) : void

Annotation object constructor

Parameters
Name Type Description
$annotationDictionary
Throws
Exception Description
\Zend_Pdf_Exception
methodpubliccreate( float $x1, float $y1, float $x2, float $y2, string $text ) : \Zend_Pdf_Annotation_Text
static

Create link annotation object

Parameters
Name Type Description
$x1 float
$y1 float
$x2 float
$y2 float
$text string
Returns
Type Description
\Zend_Pdf_Annotation_Text
methodpublicgetBottom( ) : float

Get bottom edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::getBottom()
Returns
Type Description
float
methodpublicgetLeft( ) : float

Get left edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::getLeft()
Returns
Type Description
float
methodpublicgetRight( ) : float

Get right edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::getRight()
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.

Inherited from: \Zend_Pdf_Annotation::getText()
Returns
Type Description
string
methodpublicgetTop( ) : float

Get top edge of the annotation rectangle.

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

Set bottom edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::setBottom()
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.

Inherited from: \Zend_Pdf_Annotation::setLeft()
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.

Inherited from: \Zend_Pdf_Annotation::setRight()
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.

Inherited from: \Zend_Pdf_Annotation::setText()
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.

Inherited from: \Zend_Pdf_Annotation::setTop()
Parameters
Name Type Description
$top float
Returns
Type Description
\Zend_Pdf_Annotation
Documentation was generated by DocBlox 0.13.3.