Class JavaScriptAction 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

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

Action
- JavaScriptAction

Summary

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 JavaScriptAction::createActionDictionary (

string|\setasign\SetaPDF2\Core\Type\PdfString|\setasign\SetaPDF2\Core\Type\PdfHexString|\setasign\SetaPDF2\Core\Type\PdfStream $javaScript

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

Create a JavaScript Action dictionary.

Parameters

$javaScript: string|\setasign\SetaPDF2\Core\Type\PdfString|\setasign\SetaPDF2\Core\Type\PdfHexString|\setasign\SetaPDF2\Core\Type\PdfStream

Exceptions

Throws \InvalidArgumentException

Methods

__construct()

public JavaScriptAction::__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

getJavaScript()

public JavaScriptAction::getJavaScript (

string $encoding = 'UTF-8'

): string

Get the JavaScript code.

Parameters

$encoding: string: The expected encoding of the JavaScript code.

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

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 (

\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