API Reference

Index

\SetaPDF
1. Core
2. Core
  1. Document
  2. Document
    1. Action
    2. Action

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

SetaPDF_Core_Document_Action
- SetaPDF_Core_Document_Action_Launch

Summary

Properties

$_actionDictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Core_Document_Action::$_actionDictionary

The action dictionary

$_indirectReference

protected SetaPDF_Core_Type_IndirectObjectInterface SetaPDF_Core_Document_Action::$_indirectReference

Static Methods

byObjectOrDictionary()

public static SetaPDF_Core_Document_Action::byObjectOrDictionary (

SetaPDF_Core_Type_AbstractType $objectOrDictionary

): SetaPDF_Core_Document_Action

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

__construct()

public SetaPDF_Core_Document_Action_Launch::__construct (

string|SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_IndirectObjectInterface $objectOrDictionary

)

The constructor.

Parameters

$objectOrDictionary : string|SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_IndirectObjectInterface

Exceptions

Throws InvalidArgumentException

addNext()

public SetaPDF_Core_Document_Action::addNext (

SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Document_Action $next

): void

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

Parameters

$next : SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Document_Action

getActionDictionary()

public SetaPDF_Core_Document_Action::getActionDictionary (

void

): SetaPDF_Core_Type_Dictionary

Get the action dictionary.

getFileSpecification()

public SetaPDF_Core_Document_Action_Launch::getFileSpecification (

void

): string

Get the file specification.

getIndirectObject()

public SetaPDF_Core_Document_Action::getIndirectObject (

[ SetaPDF_Core_Document $document = null ]

): SetaPDF_Core_Type_IndirectObjectInterface

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

public SetaPDF_Core_Document_Action::getNext (

void

): false|SetaPDF_Core_Type_Dictionary

Gets the PDF value of the next entry.

getPdfValue()

public SetaPDF_Core_Document_Action::getPdfValue (

void

): SetaPDF_Core_Type_Dictionary

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

public SetaPDF_Core_Document_Action::setIndirectObject (

SetaPDF_Core_Type_IndirectObjectInterface $indirectReference

): void

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

public SetaPDF_Core_Document_Action::setNext (

SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Document_Action $next

): void

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

Parameters

$next : SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Document_Action