SetaPDF_FormFiller_Field_ButtonGroup A radio button group

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

Class hierarchy

Implements

Summary

Properties

$_fieldDictionary

$_fields

A reference to the fields instance

$_qualifiedName

The qualified name of the button group

$_setValueActive

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_IndirectReference|SetaPDF_Core_Type_IndirectObject $fieldObject )

The constructor.

Parameters
$fields : SetaPDF_FormFiller_Fields
 
$qualifiedName : string
 
$fieldObject : SetaPDF_Core_Type_IndirectReference|SetaPDF_Core_Type_IndirectObject
 

addButton()

public void SetaPDF_FormFiller_Field_ButtonGroup::addButton ( SetaPDF_FormFiller_Field_Button $button )

Add a button to the group.

Parameters
$button : SetaPDF_FormFiller_Field_Button
 

cleanUp()

public void SetaPDF_FormFiller_Field_ButtonGroup::cleanUp ( void )

Release cycled references and release memory.

See

delete()

public void SetaPDF_FormFiller_Field_ButtonGroup::delete ( void )

Delete the button group.

flatten()

public void SetaPDF_FormFiller_Field_ButtonGroup::flatten ( void )

Flatten the button group to the pages content stream.

getButtons()

public array SetaPDF_FormFiller_Field_ButtonGroup::getButtons ( void )

Get all buttons of the button group.

getDefaultButton()

public SetaPDF_FormFiller_Field_Button SetaPDF_FormFiller_Field_ButtonGroup::getDefaultButton ( void )

Get the default checked button.

getDefaultValue()

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

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_Fields SetaPDF_FormFiller_Field_ButtonGroup::getFields ( void )

Get the fields instance.

getName()

public string SetaPDF_FormFiller_Field_ButtonGroup::getName ( void )

Alias for getQualifiedName().

See

getNoExport()

public boolean|null SetaPDF_FormFiller_Field_ButtonGroup::getNoExport ( void )

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

This flag is not get- or settable with Acrobat!

getOriginalQualifiedName()

public string SetaPDF_FormFiller_Field_ButtonGroup::getOriginalQualifiedName ( void )

Returns the original qualified name.

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

getPageNumber()

public integer|array SetaPDF_FormFiller_Field_ButtonGroup::getPageNumber ( void )

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

getQualifiedName()

public string SetaPDF_FormFiller_Field_ButtonGroup::getQualifiedName ( void )

Returns the qualified name.

getTooltip()

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

Get the tooltip value.

Parameters
$encoding : string
 

getValue()

public string|mixed SetaPDF_FormFiller_Field_ButtonGroup::getValue ( void )

Get the export value of the current active button.

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

isReadOnly()

public boolean|null SetaPDF_FormFiller_Field_ButtonGroup::isReadOnly ( void )

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

isRequired()

public boolean|null SetaPDF_FormFiller_Field_ButtonGroup::isRequired ( void )

Checks if the button group is marked as required.

isSetValueActive()

public boolean SetaPDF_FormFiller_Field_ButtonGroup::isSetValueActive ( void )

Checks if a setValue operation is active.

onFieldDeleted()

public void SetaPDF_FormFiller_Field_ButtonGroup::onFieldDeleted ( SetaPDF_FormFiller_Field_Button $button )

Is called when a button in this group is deleted.

Parameters
$button : SetaPDF_FormFiller_Field_Button
 

setDefaultValue()

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

Set the default value of this button group.

Parameters
$value : string|null
 
$encoding : string
 

setNoExport()

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

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 void SetaPDF_FormFiller_Field_ButtonGroup::setReadOnly ( [ boolean $readOnly = true ] )

Sets the button group to read-only or not.

Parameters
$readOnly : boolean
 

setRequired()

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

Sets the button group to be required or not.

Parameters
$required : boolean
 

setTooltip()

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

Set the tooltip value.

Parameters
$value : string|false
 
$encoding : string
 

setValue()

public void SetaPDF_FormFiller_Field_ButtonGroup::setValue ( SetaPDF_FormFiller_Field_Button|string $value )

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 InvalidArgumentException