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

byObjectOrDictionary()

Creates an action object by an action dictionary.

Parameters
$objectOrDictionary : SetaPDF_Core_Type_AbstractType
 
Exceptions

Throws InvalidArgumentException

createActionDictionary()

public static SetaPDF_Core_Document_Action_Launch::createActionDictionary (
string $fileSpecification [, null|boolean $newWindow = null ]
): SetaPDF_Core_Type_Dictionary

Create a Launch Action dictionary.

Parameters
$fileSpecification : string
 
$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
 

getActionDictionary()

getFileSpecification()

Get the file specification.

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.

getNext()

Gets the PDF value of the next entry.

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

public SetaPDF_Core_Document_Action_Launch::setFileSpecification (
string $fileSpecification
): void

Set the file specification.

Parameters
$fileSpecification : string
 

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
 

setNext()

Set the next action which should be executed after this one.

Parameters
$next : SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Document_Action