Documentation

AbstractField
in package
implements FieldInterface

Pdf abstract form field class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

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

license

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

version
4.2.0

Interfaces, Classes, Traits and Enums

FieldInterface
Pdf page form field interface

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
$size  : int
Text field font size
$value  : string
Field value
$width  : int
Text field width
__construct()  : mixed
Constructor
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
getValue()  : string
Get the field value
getWidth()  : int
Get the field width
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
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 $defaultValue = null

$flagBits

Field flag bits

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

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

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

getValue()

Get the field value

public getValue() : string
Return values
string

getWidth()

Get the field width

public getWidth() : int
Return values
int

getFlags()

Get the flags value

protected getFlags() : int
Return values
int

Search results