Pdf/Annotation/Link.php
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
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
Methods


__construct( $annotationDictionary) : void
Annotation object constructor
Name | Type | Description |
---|---|---|
$annotationDictionary |
Exception | Description |
---|---|
\Zend_Pdf_Exception |


create(float $x1, float $y1, float $x2, float $y2, \Zend_Pdf_Target | string $target) : \Zend_Pdf_Annotation_Link
Create link annotation object
Name | Type | Description |
---|---|---|
$x1 | float | |
$y1 | float | |
$x2 | float | |
$y2 | float | |
$target | \Zend_Pdf_Target | string |
Type | Description |
---|---|
\Zend_Pdf_Annotation_Link |


getBottom() : float
Get bottom edge of the annotation rectangle.
Inherited from: \Zend_Pdf_Annotation::getBottom()Type | Description |
---|---|
float |


getDestination() : \Zend_Pdf_Target | null
Get link annotation destination
Type | Description |
---|---|
\Zend_Pdf_Target | null |


getRight() : float
Get right edge of the annotation rectangle.
Inherited from: \Zend_Pdf_Annotation::getRight()Type | Description |
---|---|
float |


getText() : 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()Type | Description |
---|---|
string |


setBottom(float $bottom) : \Zend_Pdf_Annotation
Set bottom edge of the annotation rectangle.
Inherited from: \Zend_Pdf_Annotation::setBottom()Name | Type | Description |
---|---|---|
$bottom | float |
Type | Description |
---|---|
\Zend_Pdf_Annotation |


setDestination(\Zend_Pdf_Target | string $target) : \Zend_Pdf_Annotation_Link
Set link annotation destination
Name | Type | Description |
---|---|---|
$target | \Zend_Pdf_Target | string |
Type | Description |
---|---|
\Zend_Pdf_Annotation_Link |


setLeft(float $left) : \Zend_Pdf_Annotation
Name | Type | Description |
---|---|---|
$left | float |
Type | Description |
---|---|
\Zend_Pdf_Annotation |


setRight(float $right) : \Zend_Pdf_Annotation
Set right edge of the annotation rectangle.
Inherited from: \Zend_Pdf_Annotation::setRight()Name | Type | Description |
---|---|---|
$right | float |
Type | Description |
---|---|
\Zend_Pdf_Annotation |


setText(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()Name | Type | Description |
---|---|---|
$text | string |
Type | Description |
---|---|
\Zend_Pdf_Annotation |


setTop(float $top) : \Zend_Pdf_Annotation
Name | Type | Description |
---|---|---|
$top | float |
Type | Description |
---|---|
\Zend_Pdf_Annotation |