Documentation

Choice extends AbstractField
in package

Pdf page button field class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

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

license

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

version
4.2.0

Table of Contents

$defaultValue  : string
Field default value
$flagBits  : array<string|int, mixed>
Field flag bits
$font  : string
Text field font
$fontColor  : ColorInterface
Field font color
$height  : int
Text field height
$name  : string
Field name
$options  : array<string|int, mixed>
Field options
$size  : int
Text field font size
$value  : string
Field value
$width  : int
Text field width
__construct()  : mixed
Constructor
addOption()  : Choice
Add an option
getDefaultValue()  : string
Get the field default value
getFont()  : string
Get the font
getFontColor()  : ColorInterface
Get the field font color
getHeight()  : int
Get the field height
getName()  : string
Get the field name
getSize()  : int
Get the font size
getStream()  : string
Get the field stream
getValue()  : string
Get the field value
getWidth()  : int
Get the field width
hasOptions()  : bool
Has options
isCombo()  : bool
Is combo
isMultiSelect()  : bool
Is multi-select
setCombo()  : Choice
Set combo
setCommitOnSelChange()  : Choice
Set commit on select change
setDefaultValue()  : AbstractField
Set the field default value
setDoNotSpellCheck()  : Choice
Set do not spell check
setEdit()  : Choice
Set edit
setFont()  : AbstractField
Set the font
setFontColor()  : AbstractField
Set the font color
setHeight()  : AbstractField
Set the field height
setMultiSelect()  : Choice
Set multi-select
setName()  : AbstractField
Set the field name
setNoExport()  : AbstractField
Set no export
setReadOnly()  : AbstractField
Set read-only
setRequired()  : AbstractField
Set required
setSize()  : AbstractField
Set the font size
setSort()  : Choice
Set sort
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 $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 $font = null ][, int $size = 12 ]) : mixed

Instantiate a PDF text field object.

Parameters
$name : string
$font : string = null
$size : int = 12
Return values
mixed

addOption()

Add an option

public addOption(string $option) : Choice
Parameters
$option : string
Return values
Choice

getDefaultValue()

Get the field default value

public getDefaultValue() : string
Return values
string

getFont()

Get the font

public getFont() : string
Return values
string

getHeight()

Get the field height

public getHeight() : int
Return values
int

getName()

Get the field name

public getName() : string
Return values
string

getSize()

Get the font size

public getSize() : int
Return values
int

getStream()

Get the field stream

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

getValue()

Get the field value

public getValue() : string
Return values
string

getWidth()

Get the field width

public getWidth() : int
Return values
int

hasOptions()

Has options

public hasOptions() : bool
Return values
bool

isCombo()

Is combo

public isCombo() : bool
Return values
bool

isMultiSelect()

Is multi-select

public isMultiSelect() : bool
Return values
bool

setCommitOnSelChange()

Set commit on select change

public setCommitOnSelChange() : Choice
Return values
Choice

setDoNotSpellCheck()

Set do not spell check

public setDoNotSpellCheck() : Choice
Return values
Choice

setMultiSelect()

Set multi-select

public setMultiSelect() : Choice
Return values
Choice

getFlags()

Get the flags value

protected getFlags() : int
Return values
int

Search results