SetaPDF_Core_Document_Action_ResetForm Class representing a reset-form action

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

Set fields to their default values. See PDF 32000-1:2008 - 12.7.5.3 Reset-Form Action

Class hierarchy

Summary

Constants

FLAG_EXCLUDE


Properties

$_actionDictionary


Static Methods

createActionDictionary()

Create a Named Action dictionary.

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

getFields()

public SetaPDF_Core_Document_Action_Form::getFields (
[ string $encoding = 'UTF-8' ]
): array|null

Get the fields to include or exclude in the submission.

Parameters
$encoding : string

The output encoding

Return Values

An array of field names in the specific encoding

Exceptions

Throws SetaPDF_Core_Type_Exception

getFlags()

Returns the current flags.

Exceptions

Throws SetaPDF_Core_Type_Exception

getIndirectObject()

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

Parameters
$document : SetaPDF_Core_Document

The document instance

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.

isFlagSet()

public SetaPDF_Core_Document_Action_Form::isFlagSet (
integer $flag
): boolean

Checks if a specific flag is set.

Parameters
$flag : integer
 
Exceptions

Throws SetaPDF_Core_Type_Exception

setFields()

public SetaPDF_Core_Document_Action_Form::setFields (
[ array $fields = null [, string $encoding = 'UTF-8' ]]
): void

Set which fields to reset or which to exclude from resetting, depending on the setting of the Include/Exclude flag.

Parameters
$fields : array

An array of fully qualified names or an indirect object to a field dictionary

$encoding : string

The input encoding

See

setFlags()

public SetaPDF_Core_Document_Action_Form::setFlags (
integer $flags [, boolean|null $add = true ]
): void

Sets a flag or flags.

Parameters
$flags : integer
 
$add : boolean|null

Add = true, remove = false, set = null

Exceptions

Throws SetaPDF_Core_Type_Exception

setIndirectObject()

Set the indirect object of this annotation.

Parameters
$indirectReference : SetaPDF_Core_Type_IndirectObjectInterface
 

unsetFlags()

public SetaPDF_Core_Document_Action_Form::unsetFlags (
integer $flags
): void

Removes a flag or flags.

Parameters
$flags : integer
 
Exceptions

Throws SetaPDF_Core_Type_Exception