\FML\ComponentsCheckBox

CheckBox Component

Summary

Methods
Properties
Constants
__construct()
getName()
setName()
getDefault()
setDefault()
getEnabledDesign()
setEnabledDesign()
getDisabledDesign()
setDisabledDesign()
getQuad()
setQuad()
getEntry()
setEntry()
getScriptFeatures()
render()
No public properties found
No constants found
createQuad()
createEntry()
$name
$feature
N/A
No private methods found
No private properties found
N/A

Properties

$name

$name : string

Type

string — CheckBox name

Methods

__construct()

__construct(string  $name = null, boolean  $default = null, \FML\Controls\Quad  $quad = null) 

Construct a new CheckBox

Parameters

string $name

(optional) CheckBox name

boolean $default

(optional) Default value

\FML\Controls\Quad $quad

(optional) CheckBox quad

getName()

getName() : string

Get the name

Returns

string

setName()

setName(string  $name) : static

Set the name

Parameters

string $name

CheckBox name

Returns

static

getDefault()

getDefault() : boolean

Get the default value

Returns

boolean

setDefault()

setDefault(boolean  $default) : static

Set the default value

Parameters

boolean $default

Default value

Returns

static

setEnabledDesign()

setEnabledDesign(string|\FML\Components\CheckBoxDesign  $style, string  $subStyle = null) : static

Set the enabled design

Parameters

string|\FML\Components\CheckBoxDesign $style

Style name, image url or checkbox design

string $subStyle

SubStyle name

Returns

static

setDisabledDesign()

setDisabledDesign(string|\FML\Components\CheckBoxDesign  $style, string  $subStyle = null) : static

Set the disabled design

Parameters

string|\FML\Components\CheckBoxDesign $style

Style name, image url or checkbox design

string $subStyle

SubStyle name

Returns

static

getQuad()

getQuad() : \FML\Controls\Quad

Get the CheckBox Quad

Returns

\FML\Controls\Quad

setQuad()

setQuad(\FML\Controls\Quad  $quad) : static

Set the CheckBox Quad

Parameters

\FML\Controls\Quad $quad

CheckBox Quad

Returns

static

setEntry()

setEntry(\FML\Controls\Entry  $entry) : static

Set the hidden Entry

Parameters

\FML\Controls\Entry $entry

Hidden Entry

Returns

static

getScriptFeatures()

getScriptFeatures() : array<mixed,\FML\Script\Features\ScriptFeature>

Get the Script Features

Returns

array<mixed,\FML\Script\Features\ScriptFeature>

render()

render(\DOMDocument  $domDocument) : \DOMElement

Render the XML element

Parameters

\DOMDocument $domDocument

DOMDocument for which the XML element should be rendered

Returns

\DOMElement

createQuad()

createQuad() : \FML\Controls\Quad

Create the CheckBox Quad

Returns

\FML\Controls\Quad

createEntry()

createEntry() : \FML\Controls\Entry

Create the hidden Entry

Returns

\FML\Controls\Entry