Class NamedAction in namespace setasign\SetaPDF2\Core\Document\Action in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. Document
  2. Document
    1. Action

setasign\SetaPDF2\Core\Document\Action

NamedAction Class representing a Named action

File: /SetaPDF v2/Core/Document/Action/NamedAction.php
Old class name (alias): \SetaPDF_Core_Document_Action_Named

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

Class hierarchy

Action
- NamedAction

Summary

Constants

FIRST_PAGE

public const string NamedAction::FIRST_PAGE = 'FirstPage'

Name defined in PDF 32000-1:2008

GO_BACK

public const string NamedAction::GO_BACK = 'GoBack'

Additional names used by Adobe Acrobat: Previous View

GO_TO_PAGE

public const string NamedAction::GO_TO_PAGE = 'GoToPage'

Additional names used by Adobe Acrobat

LAST_PAGE

public const string NamedAction::LAST_PAGE = 'LastPage'

Name defined in PDF 32000-1:2008

NEXT_PAGE

public const string NamedAction::NEXT_PAGE = 'NextPage'

Name defined in PDF 32000-1:2008

PREV_PAGE

public const string NamedAction::PREV_PAGE = 'PrevPage'

Name defined in PDF 32000-1:2008

PRINT_DOCUMENT

public const string NamedAction::PRINT_DOCUMENT = 'Print'

Additional names used by Adobe Acrobat: Print

Properties

$_actionDictionary

protected \setasign\SetaPDF2\Core\Type\PdfDictionary Action::$_actionDictionary

The action dictionary

$_indirectReference

protected \setasign\SetaPDF2\Core\Type\AbstractType|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface Action::$_indirectReference

Static Methods

byObjectOrDictionary()

public static Action::byObjectOrDictionary (

(\setasign\SetaPDF2\Core\Type\AbstractType & \setasign\SetaPDF2\Core\Type\IndirectObjectInterface)|\setasign\SetaPDF2\Core\Type\PdfDictionary $objectOrDictionary

): Action

Creates an action object by an action dictionary.

Parameters

$objectOrDictionary: (\setasign\SetaPDF2\Core\Type\AbstractType & \setasign\SetaPDF2\Core\Type\IndirectObjectInterface)|\setasign\SetaPDF2\Core\Type\PdfDictionary

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \InvalidArgumentException

createActionDictionary()

public static NamedAction::createActionDictionary (

string $name

): \setasign\SetaPDF2\Core\Type\PdfDictionary

Create a named action dictionary.

Parameters

$name: string

Exceptions

Throws \InvalidArgumentException

Methods

__construct()

public NamedAction::__construct (

string|\setasign\SetaPDF2\Core\Type\PdfDictionary|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface $objectOrDictionary

)

The constructor.

Parameters

$objectOrDictionary: string|\setasign\SetaPDF2\Core\Type\PdfDictionary|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface

Exceptions

Throws \InvalidArgumentException

Throws \setasign\SetaPDF2\Core\Type\Exception

addNext()

public Action::addNext (

\setasign\SetaPDF2\Core\Type\PdfDictionary|Action $next

): void

Adds an action to the "Next"-value of this action.

Parameters

$next: \setasign\SetaPDF2\Core\Type\PdfDictionary|Action

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getActionDictionary()

public Action::getActionDictionary (

void

): \setasign\SetaPDF2\Core\Type\PdfDictionary

Get the action dictionary.

getIndirectObject()

public Action::getIndirectObject (

?\setasign\SetaPDF2\Core\Document $document = null

): \setasign\SetaPDF2\Core\Type\AbstractType|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface

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

Parameters

$document: ?\setasign\SetaPDF2\Core\Document: The document instance

getName()

public NamedAction::getName (

void

): string

Get the name.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getNext()

public Action::getNext (

void

): false|\setasign\SetaPDF2\Core\Type\PdfDictionary|\setasign\SetaPDF2\Core\Type\PdfArray|\setasign\SetaPDF2\Core\Type\PdfIndirectReference

Gets the PDF value of the next entry.

getPdfValue()

public Action::getPdfValue (

void

): \setasign\SetaPDF2\Core\Type\PdfDictionary

Get the PDF value of this action.

getType()

public Action::getType (

void

): string

Get the action type specified in the S key.

setIndirectObject()

public Action::setIndirectObject (

\setasign\SetaPDF2\Core\Type\AbstractType|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface $indirectReference

): void

Set the indirect object of this annotation.

Parameters

$indirectReference: \setasign\SetaPDF2\Core\Type\AbstractType|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface

setName()

public NamedAction::setName (

string $name

): void

Set the name.

Parameters

$name: string

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setNext()

public Action::setNext (

\setasign\SetaPDF2\Core\Type\PdfDictionary|Action|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface $next

): void

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

Parameters

$next: \setasign\SetaPDF2\Core\Type\PdfDictionary|Action|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface