SetaPDF_FormFiller_Field_Button A checkbox button

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

Class hierarchy

Implements

Summary

Properties

$_annotation

$_appearanceCanvas

The canvas object of the appearance

$_buttonGroup

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

$_fieldDictionary

$_fieldObject

$_fields

A reference to the fields instance

$_font

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

$_fontSize

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

$_lineHeightFactor

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

$_onStateName

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

$_originalQualifiedName

The name without the suffix

$_page

The page instance on which the form field is placed

$_qualifiedName

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

$_textColor

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


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

The indirect object or reference holding the field dictionary

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

_getFontRelation()

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

_postDelete()

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

A method called before deleting a field.

This method forwards the deletion info to the fields instance.

_preFlatten()

A method called before flattening a field.

This method forwards the flatten info to the fields instance.

_recreateAppearance()

Recreate or creates the background appearance of the form field.

check()

public SetaPDF_FormFiller_Field_Button::check (
void
): void

Checks the button.

cleanUp()

Release cycled references and release memory.

delete()

Delete the field.

Exceptions

Throws SetaPDF_FormFiller_Field_Exception

flatten()

Flatten the field to the pages content stream.

See

getAnnotation()

Get the widget annotation object from this field.

getAppearanceCanvas()

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

getAppearanceFont()

Get the appearance font object.

getAppearanceFontSize()

Get the appearance font size.

Exceptions

Throws SetaPDF_FormFiller_Field_Exception

getAppearanceTextColor()

Get the individual appearance text color.

getDefaultAppearanceData()

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
 

getFieldFlags()

Returns the current field flags.

getFieldObject()

Get the indirect object of the form field.

getFields()

getLineHeightFactor()

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

getNoExport()

Checks if the no-export flag is set.

getNormalAppearanceObject()

public SetaPDF_FormFiller_Field_Button::getNormalAppearanceObject (
[ boolean $createNew = false [, boolean $state = 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

$state : boolean

False for the "Off" state. True for the checked state.

getOnStateName()

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

getOriginalQualifiedName()

Get the original qualified name (without suffix).

getPage()

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

Exceptions

Throws SetaPDF_FormFiller_Field_Exception

getPageNumber()

Get the page number on which the field appears.

getQualifiedName()

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

Checks if the field is set to read-only.

isRequired()

Checks if the field is set to be required.

pull()

push()

setAppearanceFont()

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

Set the appearance font object.

Parameters
$font : SetaPDF_Core_Font
 
$size : float
 

setAppearanceFontSize()

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

Set an individual font size.

Parameters
$fontSize : float|null
 

setAppearanceTextColor()

Set an individual appearance text color.

Parameters
$textColor : SetaPDF_Core_DataStructure_Color
 

setButtonGroup()

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

Uncheck the button.

unsetFieldFlags()

Removes a field flag.

Parameters
$flags : integer