Index

  1. \setasign\SetaPDF2
    1. Core
      1. Document
      2. Document
        1. Action
          1. Action
          2. FormAction
          3. GoToAction
          4. GoToRAction
          5. ImportDataAction
          6. JavaScriptAction
          7. LaunchAction
          8. NamedAction
          9. ResetAction
          10. SubmitFormAction
          11. UriAction

setasign\SetaPDF2\Core\Document\Action

JavaScriptAction Class representing a JavaScript action

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

Execute a JavaScript script. See PDF 32000-1:2008 - 12.6.4.16

Class hierarchy

Summary

Static Methods

Methods

Properties

Properties

$_actionDictionary

protected \SetaPDF_Core_Type_Dictionary Action::$_actionDictionary

The action dictionary

$_indirectReference

protected \SetaPDF_Core_Type_IndirectObjectInterface Action::$_indirectReference

Static Methods

byObjectOrDictionary()

public static 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 \setasign\SetaPDF2\Core\Type\Exception

Throws \InvalidArgumentException

createActionDictionary()

public static JavaScriptAction::createActionDictionary (): \SetaPDF_Core_Type_Dictionary

Create a JavaScript Action dictionary.

Parameters
$javaScript : string|\SetaPDF_Core_Type_String|\SetaPDF_Core_Type_HexString|\SetaPDF_Core_Type_Stream
 
Exceptions

Throws \InvalidArgumentException


Methods

__construct()

public JavaScriptAction::__construct ()

The constructor.

Parameters
$objectOrDictionary : string|\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Type_IndirectObjectInterface
 
Exceptions

Throws \InvalidArgumentException

Throws \setasign\SetaPDF2\Core\Type\Exception

addNext()

public 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 \setasign\SetaPDF2\Core\Type\Exception

getActionDictionary()

public Action::getActionDictionary (
void
): \SetaPDF_Core_Type_Dictionary

Get the action dictionary.

getIndirectObject()

public 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

getJavaScript()

public JavaScriptAction::getJavaScript (
string $encodig = 'UTF-8'
): string

Get the JavaScript code.

Parameters
$encodig : string

The expected encoding of the JavaScript code.

getNext()

public 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 Action::getPdfValue (
void
): \SetaPDF_Core_Type_Dictionary

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

Set the indirect object of this annotation.

Parameters
$indirectReference : \SetaPDF_Core_Type_IndirectObjectInterface
 

setJavaScript()

public JavaScriptAction::setJavaScript (
string $javaScript
): void

Set the JavaScript code.

Parameters
$javaScript : string

JavaScript in either PDFDocEncoding or UTF-16BE including BOM.

setNext()

public 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
 

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