SetaPDF_Core_Document_Action_Named Class representing a Named action

File: /SetaPDF v2/Core/Document/Action/Named.php

Execute an action predefined by the conforming reader. See PDF 32000-1:2008 - 12.6.4.11

Class hierarchy

Summary

Constants

FIRST_PAGE

const string SetaPDF_Core_Document_Action_Named::FIRST_PAGE = 'FirstPage'

Name defined in PDF 32000-1:2008

GO_BACK

const string SetaPDF_Core_Document_Action_Named::GO_BACK = 'GoBack'

Additional names used by Adobe Acrobat: Previous View

GO_TO_PAGE

const string SetaPDF_Core_Document_Action_Named::GO_TO_PAGE = 'GoToPage'

Additional names used by Adobe Acrobat

LAST_PAGE

const string SetaPDF_Core_Document_Action_Named::LAST_PAGE = 'LastPage'

Name defined in PDF 32000-1:2008

NEXT_PAGE

const string SetaPDF_Core_Document_Action_Named::NEXT_PAGE = 'NextPage'

Name defined in PDF 32000-1:2008

PREV_PAGE

const string SetaPDF_Core_Document_Action_Named::PREV_PAGE = 'PrevPage'

Name defined in PDF 32000-1:2008

PRINT_DOCUMENT

const string SetaPDF_Core_Document_Action_Named::PRINT_DOCUMENT = 'Print'

Additional names used by Adobe Acrobat: Print


Properties

$_actionDictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Core_Document_Action_Named::$_actionDictionary

The action dictionary

$_indirectReference

protected SetaPDF_Core_Type_IndirectObjectInterface SetaPDF_Core_Document_Action_Named::$_indirectReference


Static Methods

byObjectOrDictionary()

Creates an action object by an action dictionary.

Parameters
$objectOrDictionary : SetaPDF_Core_Type_AbstractType
 
Exceptions

Throws InvalidArgumentException

createActionDictionary()

Create a named action dictionary.

Parameters
$name : string
 
Exceptions

Throws InvalidArgumentException


Methods

addNext()

Add an additional action to the next value of this action.

Parameters
$next : SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Document_Action
 

getActionDictionary()

getIndirectObject()

Get the indirect object of this annotation or creates it in the specific document context.

Parameters
$document : SetaPDF_Core_Document

The document instance

getName()

Get the name.

getNext()

Gets the PDF value of the next entry.

getPdfValue()

Get the PDF value of this action.

getType()

public SetaPDF_Core_Document_Action::getType (
void
): string

Get the action type specified in the S key.

setIndirectObject()

Set the indirect object of this annotation.

Parameters
$indirectReference : SetaPDF_Core_Type_IndirectObjectInterface
 

setName()

public SetaPDF_Core_Document_Action_Named::setName (
string $name
): void

Set the name.

Parameters
$name : string
 

setNext()

Set the next action which should be executed after this one.

Parameters
$next : SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Document_Action