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

Properties

$_actionDictionary


Static Methods


Methods

addNext()

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

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

Throws \setasign\SetaPDF2\Core\Type\Exception

getActionDictionary()

Get the action dictionary.

getIndirectObject()

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

Parameters
$document : ?\setasign\SetaPDF2\Core\Document

The document instance

getJavaScript()

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

Get the JavaScript code.

Parameters
$encoding : string

The expected encoding of the JavaScript code.

getPdfValue()

Get the PDF value of this action.

getType()

public Action::getType (
void
): string

Get the action type specified in the S key.

setIndirectObject()

Set the indirect object of this annotation.

Parameters
$indirectReference : \setasign\SetaPDF2\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.