Pdf/Annotation/Link.php

Show: PublicProtectedPrivateinherited
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: Link.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Pdf_Annotation_Link

Package: Zend\Pdf\Annotation
A link annotation represents either a hypertext link to a destination elsewhere in the document or an action to be performed.

Only destinations are used now since only GoTo action can be created by user in current implementation.

Parent(s)
\Zend_Pdf_Annotation
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected\Zend_Pdf_Element_Dictionary|\Zend_Pdf_Element_Object|\Zend_Pdf_Element_Reference $_annotationDictionary
inherited
Annotation dictionary
Inherited from: \Zend_Pdf_Annotation::$$_annotationDictionary

Methods

methodpublic__construct( $annotationDictionary) : void

Annotation object constructor

Parameters
NameTypeDescription
$annotationDictionary
Throws
ExceptionDescription
\Zend_Pdf_Exception
methodpubliccreate(float $x1, float $y1, float $x2, float $y2, \Zend_Pdf_Target | string $target) : \Zend_Pdf_Annotation_Link
static

Create link annotation object

Parameters
NameTypeDescription
$x1float
$y1float
$x2float
$y2float
$target\Zend_Pdf_Target | string
Returns
TypeDescription
\Zend_Pdf_Annotation_Link
methodpublicgetBottom() : float
inherited

Get bottom edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::getBottom()
Returns
TypeDescription
float
methodpublicgetDestination() : \Zend_Pdf_Target | null

Get link annotation destination

Returns
TypeDescription
\Zend_Pdf_Target | null
methodpublicgetLeft() : float
inherited

Get left edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::getLeft()
Returns
TypeDescription
float
methodpublicgetRight() : float
inherited

Get right edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::getRight()
Returns
TypeDescription
float
methodpublicgetText() : string
inherited

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
TypeDescription
string
methodpublicgetTop() : float
inherited

Get top edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::getTop()
Returns
TypeDescription
float
methodpublicsetBottom(float $bottom) : \Zend_Pdf_Annotation
inherited

Set bottom edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::setBottom()
Parameters
NameTypeDescription
$bottomfloat
Returns
TypeDescription
\Zend_Pdf_Annotation
methodpublicsetDestination(\Zend_Pdf_Target | string $target) : \Zend_Pdf_Annotation_Link

Set link annotation destination

Parameters
NameTypeDescription
$target\Zend_Pdf_Target | string
Returns
TypeDescription
\Zend_Pdf_Annotation_Link
methodpublicsetLeft(float $left) : \Zend_Pdf_Annotation
inherited

Set left edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::setLeft()
Parameters
NameTypeDescription
$leftfloat
Returns
TypeDescription
\Zend_Pdf_Annotation
methodpublicsetRight(float $right) : \Zend_Pdf_Annotation
inherited

Set right edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::setRight()
Parameters
NameTypeDescription
$rightfloat
Returns
TypeDescription
\Zend_Pdf_Annotation
methodpublicsetText(string $text) : \Zend_Pdf_Annotation
inherited

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
NameTypeDescription
$textstring
Returns
TypeDescription
\Zend_Pdf_Annotation
methodpublicsetTop(float $top) : \Zend_Pdf_Annotation
inherited

Set top edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::setTop()
Parameters
NameTypeDescription
$topfloat
Returns
TypeDescription
\Zend_Pdf_Annotation
Documentation was generated by phpDocumentor 2.0.0a12.