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


Static Methods

byObjectOrDictionary()

Creates an action object by an action dictionary.

Parameters
$objectOrDictionary : SetaPDF_Core_Type_AbstractType
 
Exceptions

Throws InvalidArgumentException

createActionDictionary()

Create a Named Action dictionary.

Exceptions

Throws InvalidArgumentException


Methods

__construct()

addNext()

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

Parameters
$next : SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Document_Action
 

getActionDictionary()

getFields()

public SetaPDF_Core_Document_Action_ResetForm::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

getFlags()

Returns the current flags.

getIndirectObject()

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

Parameters
$document : SetaPDF_Core_Document

The document instance

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.

isFlagSet()

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

Checks if a specific flag is set.

Parameters
$flag : integer
 

setFields()

public SetaPDF_Core_Document_Action_ResetForm::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_ResetForm::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

setIndirectObject()

Set the indirect object of this annotation.

Parameters
$indirectReference : SetaPDF_Core_Type_IndirectObjectInterface
 

setNext()

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

Parameters
$next : SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Document_Action
 

unsetFlags()

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

Removes a flag or flags.

Parameters
$flags : integer