SetaPDF_Core_Document_Action_Launch Class representing a Launch action

File: /SetaPDF v2/Core/Document/Action/Launch.php

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|SetaPDF_Core_FileSpecification|SetaPDF_Core_Type_Dictionary
 
$newWindow : null|boolean
 
Exceptions

Throws InvalidArgumentException


Methods

addNext()

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

Parameters
$next : SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Document_Action
 
Exceptions

Throws SetaPDF_Core_Type_Exception

getActionDictionary()

getFileSpecification()

getIndirectObject()

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

Parameters
$document : SetaPDF_Core_Document

The document instance

getNewWindow()

public SetaPDF_Core_Document_Action_Launch::getNewWindow (
void
): null|boolean

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

Exceptions

Throws SetaPDF_Core_Type_Exception

getPdfValue()

Get the PDF value of this action.

getType()

public SetaPDF_Core_Document_Action::getType (
void
): string

Get the action type specified in the S key.

setFileSpecification()

Set the file specification.

Parameters
$fileSpecification : string|SetaPDF_Core_FileSpecification
 
Exceptions

Throws SetaPDF_Core_Type_Exception

setIndirectObject()

Set the indirect object of this annotation.

Parameters
$indirectReference : SetaPDF_Core_Type_IndirectObjectInterface
 

setNewWindow()

public SetaPDF_Core_Document_Action_Launch::setNewWindow (
boolean $newWindow
): void

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

Parameters
$newWindow : boolean