setasign\SetaPDF2\Core\Document\Action

LaunchAction Class representing a Launch action

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

Launch an application, usually to open a file. See PDF 32000-1:2008 - 12.6.4.5

Class hierarchy

Summary

Properties

$_actionDictionary


Static Methods

createActionDictionary()

Create a Launch Action dictionary.

Parameters
$fileSpecification : string|\setasign\SetaPDF2\Core\FileSpecification|\setasign\SetaPDF2\Core\Type\PdfDictionary
 
$newWindow : ?bool
 
Exceptions

Throws \InvalidArgumentException


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.

getFileSpecification()

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

getNewWindow()

public LaunchAction::getNewWindow (
void
): ?bool

Get the NewWindow flag specifying whether to open the destination document in a new window.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getPdfValue()

Get the PDF value of this action.

getType()

public Action::getType (
void
): string

Get the action type specified in the S key.

setFileSpecification()

Set the file specification.

Parameters
$fileSpecification : string|\setasign\SetaPDF2\Core\FileSpecification
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setIndirectObject()

Set the indirect object of this annotation.

Parameters
$indirectReference : \setasign\SetaPDF2\Core\Type\IndirectObjectInterface
 

setNewWindow()

public LaunchAction::setNewWindow (
bool $newWindow
): void

Set the NewWindow flag specifying whether to open the destination document in a new window.

Parameters
$newWindow : bool