API Documentation

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

\Zend_Pdf_Action

Package: Zend\Pdf\Actions

Abstract PDF action representation class

Implements
Parent(s)
\Zend_Pdf_Target
Children
\Zend_Pdf_Action_GoToE
\Zend_Pdf_Action_SetOCGState
\Zend_Pdf_Action_GoTo3DView
\Zend_Pdf_Action_GoToR
\Zend_Pdf_Action_Unknown
\Zend_Pdf_Action_ImportData
\Zend_Pdf_Action_Rendition
\Zend_Pdf_Action_Named
\Zend_Pdf_Action_JavaScript
\Zend_Pdf_Action_Hide
\Zend_Pdf_Action_GoTo
\Zend_Pdf_Action_URI
\Zend_Pdf_Action_ResetForm
\Zend_Pdf_Action_Sound
\Zend_Pdf_Action_Movie
\Zend_Pdf_Action_SubmitForm
\Zend_Pdf_Action_Thread
\Zend_Pdf_Action_Launch
\Zend_Pdf_Action_Trans
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotected\Zend_Pdf_Element_Dictionary|\Zend_Pdf_Element_Object|\Zend_Pdf_Element_Reference  $_actionDictionary= ''

Action dictionary

Propertyprotectedarray  $_originalNextList= ''

An original list of chained actions

Array of Zend_Pdf_Action objects
Details
Type
array
Propertypublicarray  $next= 'array()'

A list of next actions in actions tree (used for actions chaining)

Array of Zend_Pdf_Action objects
Default valuearray()Details
Type
array

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
methodpubliccount( ) : int

count()

Returns
Type Description
int
methodpubliccurrent( ) : \Zend_Pdf_Action

Returns current child action.

Returns
Type Description
\Zend_Pdf_Action
methodpublicgetChildren( ) : \Zend_Pdf_Action|null

Returns the child action.

Returns
Type Description
\Zend_Pdf_Action|null
methodpublichasChildren( ) : bool

Implements RecursiveIterator interface.

Returns
Type Description
bool whether container has any pages
methodpublickey( ) : integer

Returns current iterator key

Returns
Type Description
integer
methodpublicnext( ) : void

Go to next child

methodpublicrewind( ) : void

Rewind children

methodpublicvalid( ) : boolean

Check if current position is valid

Returns
Type Description
boolean
Documentation was generated by DocBlox 0.15.1.