Index

  1. \SetaPDF
    1. FormFiller
    2. FormFiller
      1. Field
        1. Choice
        2. AbstractField
        3. AdditionalActions
        4. AppearanceValueCallbackInterface
        5. Button
        6. ButtonGroup
        7. Combo
        8. DefaultAppearanceData
        9. Exception
        10. FieldInterface
        11. Flags
        12. Formatter
        13. List
        14. PushButton
        15. Signature
        16. Text

SetaPDF_FormFiller_Field_Button A checkbox button

File: /SetaPDF v2/FormFiller/Field/Button.php

Class hierarchy

Implements

Summary

Methods

Properties

Properties

$_annotation

protected SetaPDF_Core_Document_Page_Annotation_Widget SetaPDF_FormFiller_Field_AbstractField::$_annotation

The annotation object of this form field

$_appearanceCanvas

protected SetaPDF_Core_Canvas SetaPDF_FormFiller_Field_AbstractField::$_appearanceCanvas

The canvas object of the appearance

$_appearanceCreated

protected bool SetaPDF_FormFiller_Field_AbstractField::$_appearanceCreated = false

$_buttonGroup

protected SetaPDF_FormFiller_Field_ButtonGroup SetaPDF_FormFiller_Field_Button::$_buttonGroup

The button group object to which this button is attached to (if so)

$_defaultAppearanceData

protected SetaPDF_FormFiller_Field_DefaultAppearanceData SetaPDF_FormFiller_Field_AbstractField::$_defaultAppearanceData

$_fieldDictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_FormFiller_Field_AbstractField::$_fieldDictionary

The main field dictionary

$_fieldObject

protected SetaPDF_Core_Type_IndirectObject SetaPDF_FormFiller_Field_AbstractField::$_fieldObject

The fields indirect object

$_fields

protected SetaPDF_FormFiller_Fields SetaPDF_FormFiller_Field_AbstractField::$_fields

A reference to the fields instance

$_font

protected SetaPDF_Core_Font_FontInterface SetaPDF_FormFiller_Field_AbstractField::$_font

The font object, which should be used to create the appearance

$_fontSize

protected float|null SetaPDF_FormFiller_Field_AbstractField::$_fontSize

The font size, which should be used to create the appearance

$_lineHeightFactor

protected float SetaPDF_FormFiller_Field_AbstractField::$_lineHeightFactor

The factor to calculate the line height based on the font size

$_onStateName

protected string SetaPDF_FormFiller_Field_Button::$_onStateName

The key/name for the "On"-state of the button

$_originalQualifiedName

protected string SetaPDF_FormFiller_Field_AbstractField::$_originalQualifiedName

The name without the suffix

$_page

protected SetaPDF_Core_Document_Page SetaPDF_FormFiller_Field_AbstractField::$_page

The page instance on which the form field is placed

$_qualifiedName

protected string SetaPDF_FormFiller_Field_AbstractField::$_qualifiedName

The name including a suffix if needed ("Text#1")

$_textColor

protected SetaPDF_Core_DataStructure_Color|null SetaPDF_FormFiller_Field_AbstractField::$_textColor

An individual color object which should be used for drawing the text appearance

$_textColorSpace

protected SetaPDF_Core_ColorSpace|null SetaPDF_FormFiller_Field_AbstractField::$_textColorSpace

An individual color space object which should be used for setting the non-stroking color space


Methods

__construct()

public SetaPDF_FormFiller_Field_AbstractField::__construct (
SetaPDF_FormFiller_Fields $fields, string $qualifiedName, SetaPDF_Core_Type_IndirectReference|SetaPDF_Core_Type_IndirectObject $fieldObject [, string $originalQualifiedName = null ]
)

The constructor.

Parameters
$fields : SetaPDF_FormFiller_Fields

The fields instance

$qualifiedName : string

The qualified name of the field

$fieldObject : SetaPDF_Core_Type_IndirectReference|SetaPDF_Core_Type_IndirectObject
 
$originalQualifiedName : string

The original qualified name of the field

_checkPermission()

protected SetaPDF_FormFiller_Field_AbstractField::_checkPermission (
[ integer $permission = SetaPDF_Core_SecHandler::PERM_FILL_FORM ]
): void

Checks for form-filling permissions.

Parameters
$permission : integer
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

_getAppearanceReference()

protected SetaPDF_FormFiller_Field_Button::_getAppearanceReference (
void
): SetaPDF_Core_Type_IndirectObject|false

Get the appearance reference of the current state.

See

_getBorderWidthAndStyle()

protected SetaPDF_FormFiller_Field_AbstractField::_getBorderWidthAndStyle (
void
): array

Resolve the border width and style

_getFontRelation()

protected SetaPDF_FormFiller_Field_AbstractField::_getFontRelation (
SetaPDF_Core_Type_Dictionary $nDictionary, string &$fontName
): SetaPDF_Core_Type_Dictionary_Entry

Get the font relation and copy the resources to the Resources entry if needed.

Parameters
$nDictionary : SetaPDF_Core_Type_Dictionary
 
$fontName : string
 
Exceptions

Throws SetaPDF_FormFiller_Exception

_hasAppearance()

protected SetaPDF_FormFiller_Field_Button::_hasAppearance (
void
): bool

Checks whether an default appearance for the current state exists.

_postDelete()

protected SetaPDF_FormFiller_Field_Button::_postDelete (
void
): void

This method is automatically called after the field is deleted.

It makes sure, that a related button group will be notified if the button is deleted, so it is able to update its button collection.

See

_preDelete()

protected SetaPDF_FormFiller_Field_AbstractField::_preDelete (
void
): void

A method called before deleting a field.

This method forwards the deletion info to the fields instance.

_preFlatten()

protected SetaPDF_FormFiller_Field_AbstractField::_preFlatten (
void
): void

A method called before flattening a field.

This method forwards the flatten info to the fields instance.

_recreateAppearance()

protected SetaPDF_FormFiller_Field_AbstractField::_recreateAppearance (
[ null|SetaPDF_Core_Canvas $circle = false [, $canvas = null ]]
): SetaPDF_Core_Canvas

Recreate or creates the background appearance of the form field.

Parameters
$circle : null|SetaPDF_Core_Canvas
 
$canvas
 

check()

public SetaPDF_FormFiller_Field_Button::check (
void
): void

Checks the button.

cleanUp()

public SetaPDF_FormFiller_Field_AbstractField::cleanUp (
void
): void

Release cycled references and release memory.

delete()

public SetaPDF_FormFiller_Field_AbstractField::delete (
void
): void

Delete the field.

Exceptions

Throws SetaPDF_FormFiller_Field_Exception

flatten()

public SetaPDF_FormFiller_Field_AbstractField::flatten (
[ boolean $recreateAppearanceIfNeedAppearancesIsSet = false ]
): void

Flatten the field to the pages content stream.

Parameters
$recreateAppearanceIfNeedAppearancesIsSet : boolean

Defines whether the field appearance is re-created if the NeedAppearances flag is set.

Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

See

getAnnotation()

public SetaPDF_FormFiller_Field_AbstractField::getAnnotation (
void
): SetaPDF_Core_Document_Page_Annotation_Widget

Get the widget annotation object from this field.

getAppearanceCanvas()

public SetaPDF_FormFiller_Field_AbstractField::getAppearanceCanvas (
void
): SetaPDF_Core_Canvas

Get the appearance canvas of the "normal" appearance object.

getAppearanceFont()

public SetaPDF_FormFiller_Field_AbstractField::getAppearanceFont (
void
): null|SetaPDF_Core_Font_FontInterface

Get the appearance font object.

getAppearanceFontSize()

public SetaPDF_FormFiller_Field_AbstractField::getAppearanceFontSize (
void
): float|null

Get the appearance font size.

Exceptions

Throws SetaPDF_FormFiller_Field_Exception

getAppearanceTextColor()

public SetaPDF_FormFiller_Field_AbstractField::getAppearanceTextColor (
void
): null|SetaPDF_Core_DataStructure_Color

Get the individual appearance text color.

getAppearanceTextColorSpace()

public SetaPDF_FormFiller_Field_AbstractField::getAppearanceTextColorSpace (
void
): null|SetaPDF_Core_ColorSpace

Get the individual color space object which should be used for setting the non-stroking color space.

getDefaultAppearanceData()

public SetaPDF_FormFiller_Field_AbstractField::getDefaultAppearanceData (
void
): SetaPDF_FormFiller_Field_DefaultAppearanceData

Get the default appearance data of the DA value.

Exceptions

Throws SetaPDF_FormFiller_Field_Exception

getDefaultValue()

public SetaPDF_FormFiller_Field_Button::getDefaultValue (
[ string $encoding = 'UTF-8' ]
): mixed

Get the default value (DV entry or value in the Opt array) of the field.

Parameters
$encoding : string
 
See

getExportValue()

public SetaPDF_FormFiller_Field_Button::getExportValue (
[ string $encoding = 'UTF-8' ]
): string

Returns the export value of the button.

Parameters
$encoding : string
 

getFieldDictionary()

public SetaPDF_FormFiller_Field_AbstractField::getFieldDictionary (
void
): SetaPDF_Core_Type_Dictionary

Get the field dictionary.

getFieldFlags()

public SetaPDF_FormFiller_Field_AbstractField::getFieldFlags (
void
): integer

Returns the current field flags.

getFieldObject()

public SetaPDF_FormFiller_Field_AbstractField::getFieldObject (
void
): SetaPDF_Core_Type_IndirectObject

Get the indirect object of the form field.

getFields()

public SetaPDF_FormFiller_Field_AbstractField::getFields (
void
): SetaPDF_FormFiller_Fields

Get the fields instance.

getLineHeightFactor()

public SetaPDF_FormFiller_Field_AbstractField::getLineHeightFactor (
void
): float

Get the line height factor

The line height is calculated by this factor in relation to the font size:

$lineHeight = $fontSize * $lineHeightFactor

By default this value is calculated by the font bounding box values "ury - lly / 1000".

See

getName()

public SetaPDF_FormFiller_Field_AbstractField::getName (
void
): string

Alias for getQualifiedName().

See

getNoExport()

public SetaPDF_FormFiller_Field_AbstractField::getNoExport (
void
): boolean

Checks if the no-export flag is set.

getNormalAppearanceObject()

public SetaPDF_FormFiller_Field_Button::getNormalAppearanceObject (
[ boolean $createNew = false ]
): SetaPDF_Core_Type_IndirectObject

Get or create the normal appearance object (the object referenced in the N entry).

Parameters
$createNew : boolean

Pass true to force a recreation

getOnStateName()

public SetaPDF_FormFiller_Field_Button::getOnStateName (
void
): string

Resolves the key/name for the "On"-state of the button.

getOriginalQualifiedName()

public SetaPDF_FormFiller_Field_AbstractField::getOriginalQualifiedName (
void
): string

Get the original qualified name (without suffix).

getPage()

public SetaPDF_FormFiller_Field_AbstractField::getPage (
void
): SetaPDF_Core_Document_Page

Gets the page object on which the form field is placed.

Exceptions

Throws SetaPDF_FormFiller_Field_Exception

getPageNumber()

public SetaPDF_FormFiller_Field_AbstractField::getPageNumber (
void
): integer

Get the page number on which the field appears.

getQualifiedName()

public SetaPDF_FormFiller_Field_AbstractField::getQualifiedName (
void
): string

Returns the qualified name.

getTooltip()

public SetaPDF_FormFiller_Field_AbstractField::getTooltip (
[ string $encoding = 'UTF-8' ]
): bool|string

Get the tooltip value.

Parameters
$encoding : string
 

getValue()

public SetaPDF_FormFiller_Field_Button::getValue (
void
): boolean

Gets whether the button is checked or not.

See

isChecked()

public SetaPDF_FormFiller_Field_Button::isChecked (
void
): boolean

Gets whether the button is checked or not.

isFieldFlagSet()

public SetaPDF_FormFiller_Field_AbstractField::isFieldFlagSet (
integer $flag
): boolean

Checks if a specific field flag is set.

Parameters
$flag : integer
 

isReadOnly()

public SetaPDF_FormFiller_Field_AbstractField::isReadOnly (
void
): boolean

Checks if the field is set to read-only.

isRequired()

public SetaPDF_FormFiller_Field_AbstractField::isRequired (
void
): boolean

Checks if the field is set to be required.

pull()

public SetaPDF_FormFiller_Field_Button::pull (
void
): void

Alias for uncheck().

See

push()

public SetaPDF_FormFiller_Field_Button::push (
void
): void

Alias for check().

See

setAppearanceFont()

public SetaPDF_FormFiller_Field_AbstractField::setAppearanceFont (
SetaPDF_Core_Font_FontInterface $font [, float $size = null ]
): void

Set the appearance font object.

Parameters
$font : SetaPDF_Core_Font_FontInterface
 
$size : float
 

setAppearanceFontSize()

public SetaPDF_FormFiller_Field_AbstractField::setAppearanceFontSize (
float|null $fontSize
): void

Set an individual font size.

Parameters
$fontSize : float|null
 

setAppearanceTextColor()

public SetaPDF_FormFiller_Field_AbstractField::setAppearanceTextColor (
[ SetaPDF_Core_DataStructure_Color $textColor = null ]
): void

Set an individual appearance text color.

Parameters
$textColor : SetaPDF_Core_DataStructure_Color
 

setAppearanceTextColorSpace()

public SetaPDF_FormFiller_Field_AbstractField::setAppearanceTextColorSpace (
[ SetaPDF_Core_ColorSpace|null $colorSpace = null ]
): void

Set the individual color space object which should be used for setting the non-stroking color space.

Parameters
$colorSpace : SetaPDF_Core_ColorSpace|null
 

setButtonGroup()

public SetaPDF_FormFiller_Field_Button::setButtonGroup (): void

Set the button group to which this button is attached to.

Parameters
$buttonGroup : SetaPDF_FormFiller_Field_ButtonGroup
 
See

setDefaultValue()

public SetaPDF_FormFiller_Field_Button::setDefaultValue (
boolean|string $value [, string $encoding = 'UTF-8' ]
): void

Set the default value of the field.

Parameters
$value : boolean|string
 
$encoding : string
 

setFieldFlags()

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

Sets a field flag.

Parameters
$flags : integer
 
$add : boolean|null

Add = true, remove = false, set = null

setLineHeightFactor()

public SetaPDF_FormFiller_Field_AbstractField::setLineHeightFactor (
null|float $lineHeightFactor
): void

Set the line height factor

The line height is calculated by this factor in relation to the font size:

$lineHeight = $fontSize * $lineHeightFactor

By default this value is calculated by the font bounding box values "ury - lly / 1000".

Parameters
$lineHeightFactor : null|float
 
See

setNoExport()

public SetaPDF_FormFiller_Field_AbstractField::setNoExport (
[ boolean $noExport = true ]
): void

Set the no-export flag.

Parameters
$noExport : boolean
 

setReadOnly()

public SetaPDF_FormFiller_Field_AbstractField::setReadOnly (
[ boolean $readOnly = true ]
): void

Sets the read-only flag.

Parameters
$readOnly : boolean
 

setRequired()

public SetaPDF_FormFiller_Field_AbstractField::setRequired (
[ boolean $required = true ]
): void

Sets the required flag.

Parameters
$required : boolean
 

setTooltip()

public SetaPDF_FormFiller_Field_AbstractField::setTooltip (
string|false $value [, string $encoding = 'UTF-8' ]
): void

Set the tooltip value.

Parameters
$value : string|false
 
$encoding : string
 

setValue()

public SetaPDF_FormFiller_Field_Button::setValue (
boolean|string $value [, string $encoding = 'UTF-8' ]
): void

Check or un-check the button.

Parameters
$value : boolean|string

The value can be a boolean value or a value that will be compared to the export value to evaluate to a boolean whether to check or un-check the check box.

$encoding : string

The input encoding if $value is a string

uncheck()

public SetaPDF_FormFiller_Field_Button::uncheck (
void
): void

Uncheck the button.

unsetFieldFlags()

public SetaPDF_FormFiller_Field_AbstractField::unsetFieldFlags (
integer $flags
): void

Removes a field flag.

Parameters
$flags : integer
 

© 2023 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)