API Documentation

Zend/Pdf/Annotation/Link.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: Link.php 24594 2012-01-05 21:27:01Z 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  

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, \Zend_Pdf_Target|string $target ) : \Zend_Pdf_Annotation_Link
static

Create link annotation object

Parameters
Name Type Description
$x1 float
$y1 float
$x2 float
$y2 float
$target \Zend_Pdf_Target|string
Returns
Type Description
\Zend_Pdf_Annotation_Link
methodpublicgetDestination( ) : \Zend_Pdf_Target|null

Get link annotation destination

Returns
Type Description
\Zend_Pdf_Target|null
methodpublicsetDestination( \Zend_Pdf_Target|string $target ) : \Zend_Pdf_Annotation_Link

Set link annotation destination

Parameters
Name Type Description
$target \Zend_Pdf_Target|string
Returns
Type Description
\Zend_Pdf_Annotation_Link
Documentation was generated by DocBlox 0.15.1.