Pdf/Action/URI.php
inherited
Classes
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 24593 2012-01-05 20:35:02Z matthew $
\Zend_Pdf_Action_URI
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
Properties
\Zend_Pdf_Element_Dictionary|\Zend_Pdf_Element_Object|\Zend_Pdf_Element_Reference $_actionDictionaryarray $next = array()array()Details- Type
- array
- Inherited_from
- \Zend_Pdf_Action::$$next
Methods
__construct(\Zend_Pdf_Element_Dictionary $dictionary, \SplObjectStorage $processedActions) : voidObject constructor
| 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) : trueValidate URI
| Name | Type | Description |
|---|---|---|
| $uri | string |
| Type | Description |
|---|---|
| true |
| Exception | Description |
|---|---|
| \Zend_Pdf_Exception |
create(string $uri, boolean $isMap = false) : \Zend_Pdf_Action_URICreate new Zend_Pdf_Action_URI object using specified uri
| 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.
| Type | Description |
|---|---|
| boolean |
getUri() : stringGet URI to resolve
| Type | Description |
|---|---|
| string |
hasChildren() : bool| Type | Description |
|---|---|
| bool | whether container has any pages |
key() : integer| Type | Description |
|---|---|
| integer |
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.
| 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
| Name | Type | Description |
|---|---|---|
| $uri | string | The uri to resolve, encoded in 7-bit ASCII. |
| Type | Description |
|---|---|
| \Zend_Pdf_Action_URI |
valid() : boolean| Type | Description |
|---|---|
| boolean |