Pdf/Action/URI.php
Show:
inherited
inherited
Classes
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Pdf
- Subpackage
- Actions
- Version
- $Id$
\Zend_Pdf_Action_URI
Package: Zend_Pdf\Actions
Returns
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Methods
__construct(\Zend_Pdf_Element_Dictionary $dictionary, \SplObjectStorage $processedActions) : voidObject constructor
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $dictionary | \Zend_Pdf_Element_Dictionary | |
| $processedActions | \SplObjectStorage | list of already processed action dictionaries, used to avoid cyclic references |
| Exception | Description |
|---|---|
| \Zend_Pdf_Exception |
_validateUri(string $uri) : truestatic
Validate URI
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $uri | string |
| Type | Description |
|---|---|
| true |
| Exception | Description |
|---|---|
| \Zend_Pdf_Exception |
create(string $uri, boolean $isMap = false) : \Zend_Pdf_Action_URIstatic
Create new Zend_Pdf_Action_URI object using specified uri
Parameters
Returns
| 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 |
| Type | Description |
|---|---|
| \Zend_Pdf_Action_URI |
getIsMap() : booleanGet 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 |
getUri() : stringGet URI to resolve
Returns
| Type | Description |
|---|---|
| string |
setIsMap(boolean $isMap) : \Zend_Pdf_Action_URISet 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 |
| Type | Description |
|---|---|
| \Zend_Pdf_Action_URI |
setUri(string $uri) : \Zend_Pdf_Action_URISet URI to resolve
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $uri | string | The uri to resolve, encoded in 7-bit ASCII. |
| Type | Description |
|---|---|
| \Zend_Pdf_Action_URI |