Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Document
      2. Document
        1. Action
        2. Action
          1. Form
          2. GoTo
          3. GoToR
          4. ImportData
          5. JavaScript
          6. Launch
          7. Named
          8. ResetForm
          9. SubmitForm
          10. Uri

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

Static Methods

Methods

Properties

Constants

Constants

FIRST_PAGE

public const string SetaPDF_Core_Document_Action_Named::FIRST_PAGE = 'FirstPage'

Name defined in PDF 32000-1:2008

GO_BACK

public const string SetaPDF_Core_Document_Action_Named::GO_BACK = 'GoBack'

Additional names used by Adobe Acrobat: Previous View

GO_TO_PAGE

public const string SetaPDF_Core_Document_Action_Named::GO_TO_PAGE = 'GoToPage'

Additional names used by Adobe Acrobat

LAST_PAGE

public const string SetaPDF_Core_Document_Action_Named::LAST_PAGE = 'LastPage'

Name defined in PDF 32000-1:2008

NEXT_PAGE

public const string SetaPDF_Core_Document_Action_Named::NEXT_PAGE = 'NextPage'

Name defined in PDF 32000-1:2008

PREV_PAGE

public const string SetaPDF_Core_Document_Action_Named::PREV_PAGE = 'PrevPage'

Name defined in PDF 32000-1:2008

PRINT_DOCUMENT

public 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::$_actionDictionary

The action dictionary

$_indirectReference

protected SetaPDF_Core_Type_IndirectObjectInterface SetaPDF_Core_Document_Action::$_indirectReference

Static Methods

byObjectOrDictionary()

public static SetaPDF_Core_Document_Action::byObjectOrDictionary (): SetaPDF_Core_Document_Action

Creates an action object by an action dictionary.

Parameters
$objectOrDictionary : SetaPDF_Core_Type_IndirectObject|SetaPDF_Core_Type_IndirectReference|SetaPDF_Core_Type_Dictionary
 
Exceptions

Throws SetaPDF_Core_Type_Exception

Throws InvalidArgumentException

createActionDictionary()

public static SetaPDF_Core_Document_Action_Named::createActionDictionary (
string $name
): SetaPDF_Core_Type_Dictionary

Create a named action dictionary.

Parameters
$name : string
 
Exceptions

Throws InvalidArgumentException


Methods

__construct()

public SetaPDF_Core_Document_Action_Named::__construct ()

The constructor.

Parameters
$objectOrDictionary : string|SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_IndirectObjectInterface
 
Exceptions

Throws InvalidArgumentException

Throws SetaPDF_Core_Type_Exception

addNext()

public SetaPDF_Core_Document_Action::addNext (): void

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

Parameters
$next : SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Document_Action
 
Exceptions

Throws SetaPDF_Core_Type_Exception

getActionDictionary()

public SetaPDF_Core_Document_Action::getActionDictionary (
void
): SetaPDF_Core_Type_Dictionary

Get the action dictionary.

getIndirectObject()

public SetaPDF_Core_Document_Action::getIndirectObject (
[ SetaPDF_Core_Document $document = null ]
): SetaPDF_Core_Type_IndirectObjectInterface

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

Parameters
$document : SetaPDF_Core_Document

The document instance

getName()

public SetaPDF_Core_Document_Action_Named::getName (
void
): string

Get the name.

Exceptions

Throws SetaPDF_Core_Type_Exception

getNext()

public SetaPDF_Core_Document_Action::getNext (
void
): false|SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_Array|SetaPDF_Core_Type_IndirectReference

Gets the PDF value of the next entry.

getPdfValue()

public SetaPDF_Core_Document_Action::getPdfValue (
void
): SetaPDF_Core_Type_Dictionary

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()

public SetaPDF_Core_Document_Action::setIndirectObject (): void

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
 
Exceptions

Throws SetaPDF_Core_Type_Exception

setNext()

public SetaPDF_Core_Document_Action::setNext (): void

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

Parameters
$next : SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Document_Action|SetaPDF_Core_Type_IndirectObjectInterface
 

© 2024 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)