Documentation

Button extends AbstractField
in package

Pdf page button field class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
5.2.0

Table of Contents

Properties

$defaultValue  : string|null
Field default value
$flagBits  : array<string|int, mixed>
Field flag bits
$font  : string|null
Text field font
$fontColor  : ColorInterface|null
Field font color
$height  : int|null
Text field height
$name  : string|null
Field name
$options  : array<string|int, mixed>
Field options
$size  : int
Text field font size
$value  : string|null
Field value
$width  : int|null
Text field width

Methods

__construct()  : mixed
Constructor
addOption()  : Button
Add an option
getDefaultValue()  : string|null
Get the field default value
getFont()  : string|null
Get the font
getFontColor()  : ColorInterface|null
Get the field font color
getHeight()  : int|null
Get the field height
getName()  : string|null
Get the field name
getSize()  : int
Get the font size
getStream()  : string
Get the field stream
getValue()  : string|null
Get the field value
getWidth()  : int|null
Get the field width
hasOptions()  : bool
Has options
isPushButton()  : bool
Is push button
isRadio()  : bool
Is radio
setDefaultValue()  : AbstractField
Set the field default value
setFont()  : AbstractField
Set the font
setFontColor()  : AbstractField
Set the font color
setHeight()  : AbstractField
Set the field height
setName()  : AbstractField
Set the field name
setNoExport()  : AbstractField
Set no export
setNoToggleToOff()  : Button
Set no toggle to off
setPushButton()  : Button
Set push button
setRadio()  : Button
Set radio
setRadiosInUnison()  : Button
Set radios in unison
setReadOnly()  : AbstractField
Set read-only
setRequired()  : AbstractField
Set required
setSize()  : AbstractField
Set the font size
setValue()  : AbstractField
Set the field value
setWidth()  : AbstractField
Set the field width
getFlags()  : int
Get the flags value

Properties

$defaultValue

Field default value

protected string|null $defaultValue = null

$flagBits

Field flag bits

protected array<string|int, mixed> $flagBits = []

$options

Field options

protected array<string|int, mixed> $options = []

Methods

__construct()

Constructor

public __construct(string $name[, string|null $font = null ][, int $size = 12 ]) : mixed

Instantiate a PDF text field object.

Parameters
$name : string
$font : string|null = null
$size : int = 12

addOption()

Add an option

public addOption(string $option[, int $xOffset = 0 ][, int $yOffset = 0 ]) : Button
Parameters
$option : string
$xOffset : int = 0
$yOffset : int = 0
Return values
Button

getDefaultValue()

Get the field default value

public getDefaultValue() : string|null
Return values
string|null

getFont()

Get the font

public getFont() : string|null
Return values
string|null

getHeight()

Get the field height

public getHeight() : int|null
Return values
int|null

getName()

Get the field name

public getName() : string|null
Return values
string|null

getSize()

Get the font size

public getSize() : int
Return values
int

getStream()

Get the field stream

public getStream(int $i, int $pageIndex, string|null $fontReference, int $x, int $y) : string
Parameters
$i : int
$pageIndex : int
$fontReference : string|null
$x : int
$y : int
Return values
string

getValue()

Get the field value

public getValue() : string|null
Return values
string|null

getWidth()

Get the field width

public getWidth() : int|null
Return values
int|null

hasOptions()

Has options

public hasOptions() : bool
Return values
bool

isPushButton()

Is push button

public isPushButton() : bool
Return values
bool

isRadio()

Is radio

public isRadio() : bool
Return values
bool

setNoToggleToOff()

Set no toggle to off

public setNoToggleToOff() : Button
Return values
Button

setRadiosInUnison()

Set radios in unison

public setRadiosInUnison() : Button
Return values
Button

getFlags()

Get the flags value

protected getFlags() : int
Return values
int

        
On this page

Search results