Pdf/Annotation/Link.php

Show:

inherited

Classes
- \Zend_Pdf_Annotation_Link

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
jump to top

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

\Zend_Pdf_Element_Dictionary|\Zend_Pdf_Element_Object|\Zend_Pdf_Element_Reference $_annotationDictionary

inherited

Annotation dictionary

Inherited from: \Zend_Pdf_Annotation::$$_annotationDictionary

Details

Type: \Zend_Pdf_Element_Dictionary | \Zend_Pdf_Element_Object | \Zend_Pdf_Element_Reference
Inherited_from: \Zend_Pdf_Annotation::$$_annotationDictionary

Methods

__construct( $annotationDictionary) : void

Annotation object constructor

Parameters

Name	Type	Description
$annotationDictionary

Throws

Exception	Description
\Zend_Pdf_Exception

create(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

getBottom() : float

inherited

Get bottom edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::getBottom()

Returns

Type	Description
float

getDestination() : \Zend_Pdf_Target | null

Get link annotation destination

Returns

Type	Description
\Zend_Pdf_Target \| null

getLeft() : float

inherited

Get left edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::getLeft()

Returns

Type	Description
float

getRight() : float

inherited

Get right edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::getRight()

Returns

Type	Description
float

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

Type	Description
string

getTop() : float

inherited

Get top edge of the annotation rectangle.

Inherited from: \Zend_Pdf_Annotation::getTop()

Returns

Type	Description
float

setBottom(float $bottom) : \Zend_Pdf_Annotation

inherited

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

setDestination(\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

setLeft(float $left) : \Zend_Pdf_Annotation

inherited

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

setRight(float $right) : \Zend_Pdf_Annotation

inherited

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

setText(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

Name	Type	Description
$text	string

Returns

Type	Description
\Zend_Pdf_Annotation

setTop(float $top) : \Zend_Pdf_Annotation

inherited

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

Pdf/Annotation/Link.php

\Zend_Pdf_Annotation_Linkjump to top

Properties

Methods

\Zend_Pdf_Annotation_Link
jump to top