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_ButtonGroup A radio button group

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

Class hierarchy

Implements

Summary

Methods

Properties

Properties

$_buttons

protected SetaPDF_FormFiller_Field_Button[] SetaPDF_FormFiller_Field_ButtonGroup::$_buttons = array()

The buttons

$_fieldDictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_FormFiller_Field_ButtonGroup::$_fieldDictionary

The main field dictionary

$_fields

protected SetaPDF_FormFiller_Fields SetaPDF_FormFiller_Field_ButtonGroup::$_fields

A reference to the fields instance

$_qualifiedName

protected string SetaPDF_FormFiller_Field_ButtonGroup::$_qualifiedName

The qualified name of the button group

$_setValueActive

protected boolean SetaPDF_FormFiller_Field_ButtonGroup::$_setValueActive = false

A flag indicating that a setValue call is active


Methods

__construct()

public SetaPDF_FormFiller_Field_ButtonGroup::__construct (
SetaPDF_FormFiller_Fields $fields, string $qualifiedName, SetaPDF_Core_Type_IndirectObject $fieldObject
)

The constructor.

Parameters
$fields : SetaPDF_FormFiller_Fields
 
$qualifiedName : string
 
$fieldObject : SetaPDF_Core_Type_IndirectObject
 
Exceptions

Throws SetaPDF_Core_Type_Exception

addButton()

public SetaPDF_FormFiller_Field_ButtonGroup::addButton (): void

Add a button to the group.

Parameters
$button : SetaPDF_FormFiller_Field_Button
 

cleanUp()

public SetaPDF_FormFiller_Field_ButtonGroup::cleanUp (
void
): void

Release cycled references and release memory.

See

delete()

public SetaPDF_FormFiller_Field_ButtonGroup::delete (
void
): void

Delete the button group.

Exceptions

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_FormFiller_Field_Exception

flatten()

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

Flatten the button group 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_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Reader_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented

getButtons()

public SetaPDF_FormFiller_Field_ButtonGroup::getButtons (
void
): SetaPDF_FormFiller_Field_Button[]

Get all buttons of the button group.

getDefaultButton()

public SetaPDF_FormFiller_Field_ButtonGroup::getDefaultButton (
void
): SetaPDF_FormFiller_Field_Button

Get the default checked button.

Exceptions

Throws SetaPDF_Core_Type_Exception

getDefaultValue()

public SetaPDF_FormFiller_Field_ButtonGroup::getDefaultValue (
[ string $encoding = 'UTF-8' ]
): null|string

Returns the default value of the button group.

This value is used if the form is reset

Parameters
$encoding : string
 
See

getFields()

public SetaPDF_FormFiller_Field_ButtonGroup::getFields (
void
): SetaPDF_FormFiller_Fields

Get the fields instance.

getName()

public SetaPDF_FormFiller_Field_ButtonGroup::getName (
void
): string

Alias for getQualifiedName().

See

getNoExport()

public SetaPDF_FormFiller_Field_ButtonGroup::getNoExport (
void
): boolean|null

Get the info, if the button group is marked as "no export".

This flag is not get- or settable with Acrobat!

getOriginalQualifiedName()

public SetaPDF_FormFiller_Field_ButtonGroup::getOriginalQualifiedName (
void
): string

Returns the original qualified name.

(which is the same as the qualified name for button groups)

getPageNumber()

public SetaPDF_FormFiller_Field_ButtonGroup::getPageNumber (
void
): integer|array

Get the page number(s) on which the button group appears.

Exceptions

Throws SetaPDF_Core_Document_ObjectNotDefinedException

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_FormFiller_Field_Exception

getQualifiedName()

public SetaPDF_FormFiller_Field_ButtonGroup::getQualifiedName (
void
): string

Returns the qualified name.

getTooltip()

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

Get the tooltip value.

Parameters
$encoding : string
 

getValue()

public SetaPDF_FormFiller_Field_ButtonGroup::getValue (
void
): string|null

Get the export value of the current active button.

This method returns the export value of the first checked button.

Exceptions

Throws SetaPDF_Core_Type_Exception

isReadOnly()

public SetaPDF_FormFiller_Field_ButtonGroup::isReadOnly (
void
): boolean|null

Checks if the button group is marked as read-only.

isRequired()

public SetaPDF_FormFiller_Field_ButtonGroup::isRequired (
void
): boolean|null

Checks if the button group is marked as required.

isSetValueActive()

public SetaPDF_FormFiller_Field_ButtonGroup::isSetValueActive (
void
): boolean

Checks if a setValue operation is active.

onFieldDeleted()

public SetaPDF_FormFiller_Field_ButtonGroup::onFieldDeleted (): void

Is called when a button in this group is deleted.

Parameters
$button : SetaPDF_FormFiller_Field_Button
 

setDefaultValue()

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

Set the default value of this button group.

Parameters
$value : string|null|SetaPDF_FormFiller_Field_Button
 
$encoding : string
 
Exceptions

Throws DOMException

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented

Throws SetaPDF_FormFiller_Exception

setNoExport()

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

Sets the "no export" flag.

This flag is not get- or settable with Acrobat!

If you remove this flag, the element could be still not exported due to a definition in a FormSubmit actions Fields array.

Parameters
$noExport : boolean
 

setReadOnly()

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

Sets the button group to read-only or not.

Parameters
$readOnly : boolean
 

setRequired()

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

Sets the button group to be required or not.

Parameters
$required : boolean
 

setTooltip()

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

Set the tooltip value.

Parameters
$value : string|false
 
$encoding : string
 

setValue()

public SetaPDF_FormFiller_Field_ButtonGroup::setValue (): void

Set the value / active button of the button group.

This method requires the button object, which should be activated as the parameter or an export value which will be used to find the desired button.

Parameters
$value : SetaPDF_FormFiller_Field_Button|string

The button instance or an export value

Exceptions

Throws DOMException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Font_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented

Throws SetaPDF_FormFiller_Exception

Throws SetaPDF_FormFiller_Field_Exception


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