API Documentation

Zend/Pdf/Action/URI.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
Actions  
Version
$Id: URI.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Pdf_Action_URI

Package: Zend\Pdf\Actions

PDF 'Resolve a uniform resource identifier' action

A URI action causes a URI to be resolved.

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

Methods

methodpublic__construct( \Zend_Pdf_Element_Dictionary $dictionary, \SplObjectStorage $processedActions ) : void

Object constructor

Parameters
Name Type Description
$dictionary \Zend_Pdf_Element_Dictionary
$processedActions \SplObjectStorage

list of already processed action dictionaries, used to avoid cyclic references

Throws
Exception Description
\Zend_Pdf_Exception
methodprotected_validateUri( string $uri ) : true
static

Validate URI

Parameters
Name Type Description
$uri string
Returns
Type Description
true
Throws
Exception Description
\Zend_Pdf_Exception
methodpubliccreate( string $uri, boolean $isMap = false ) : \Zend_Pdf_Action_URI
static

Create new Zend_Pdf_Action_URI object using specified uri

Parameters
Name Type Description
$uri string

The URI to resolve, encoded in 7-bit ASCII

$isMap boolean

A flag specifying whether to track the mouse position when the URI is resolved

Returns
Type Description
\Zend_Pdf_Action_URI
methodpublicgetIsMap( ) : boolean

Get IsMap property

If the IsMap flag is true and the user has triggered the URI action by clicking an annotation, the coordinates of the mouse position at the time the action is performed should be transformed from device space to user space and then offset relative to the upper-left corner of the annotation rectangle.

Returns
Type Description
boolean
methodpublicgetUri( ) : string

Get URI to resolve

Returns
Type Description
string
methodpublicsetIsMap( boolean $isMap ) : \Zend_Pdf_Action_URI

Set IsMap property

If the IsMap flag is true and the user has triggered the URI action by clicking an annotation, the coordinates of the mouse position at the time the action is performed should be transformed from device space to user space and then offset relative to the upper-left corner of the annotation rectangle.

Parameters
Name Type Description
$isMap boolean

A flag specifying whether to track the mouse position when the URI is resolved

Returns
Type Description
\Zend_Pdf_Action_URI
methodpublicsetUri( string $uri ) : \Zend_Pdf_Action_URI

Set URI to resolve

Parameters
Name Type Description
$uri string

The uri to resolve, encoded in 7-bit ASCII.

Returns
Type Description
\Zend_Pdf_Action_URI
Documentation was generated by DocBlox 0.15.1.