API Documentation

Pdf/Action/URI.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Pdf
subpackage
Actions
version
$Id: URI.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Pdf_Action_URI

Description

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.

Zend_Pdf_Action_URI
jump to top

Extends from
Zend_Pdf_Action
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Pdf
subpackage
Actions
Methods
__construct
_validateUri
create
setUri
getUri
setIsMap
getIsMap

Description

PDF 'Resolve a uniform resource identifier' action

A URI action causes a URI to be resolved.

Methods

__construct
jump to class

__construct( Zend_Pdf_Element_Dictionary $dictionary, SplObjectStorage $processedActions ) :

Object constructor

Arguments
$dictionary
Zend_Pdf_Element_Dictionary
$processedActions
SplObjectStorage
list of already processed action dictionaries, used to avoid cyclic references
Details
visibility
public
final
false
static
false
throws

_validateUri
jump to class

_validateUri( string $uri ) : true

Validate URI

Arguments
$uri
string
Output
true
Details
visibility
protected
final
false
static
true
throws

create
jump to class

create( string $uri, boolean $isMap = false ) : Zend_Pdf_Action_URI

Create new Zend_Pdf_Action_URI object using specified uri

Arguments
$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
Output
Zend_Pdf_Action_URI
Details
visibility
public
final
false
static
true

getIsMap
jump to class

getIsMap( ) : 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.

Output
boolean
Details
visibility
public
final
false
static
false

getUri
jump to class

getUri( ) : string

Get URI to resolve

Output
string
Details
visibility
public
final
false
static
false

setIsMap
jump to class

setIsMap( 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.

Arguments
$isMap
boolean
A flag specifying whether to track the mouse position when the URI is resolved
Output
Zend_Pdf_Action_URI
Details
visibility
public
final
false
static
false

setUri
jump to class

setUri( string $uri ) : Zend_Pdf_Action_URI

Set URI to resolve

Arguments
$uri
string
The uri to resolve, encoded in 7-bit ASCII.
Output
Zend_Pdf_Action_URI
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.