Constants

FUNCTION_UPDATE_QUAD_DESIGN

FUNCTION_UPDATE_QUAD_DESIGN

VAR_CHECKBOX_ENABLED

VAR_CHECKBOX_ENABLED

VAR_CHECKBOX_DESIGNS

VAR_CHECKBOX_DESIGNS

VAR_CHECKBOX_ENTRY_ID

VAR_CHECKBOX_ENTRY_ID

Properties

$entry

$entry : \FML\Controls\Entry

Type

\FML\Controls\Entry — Hidden Entry for submitting the value

$default

$default : boolean

Type

boolean — Default value

Methods

collect()

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

Collect the Script Features of the given objects

Returns

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

prepare()

prepare(\FML\Script\Script  $script) : static

Prepare the given Script for rendering by adding the needed Labels, etc.

Parameters

\FML\Script\Script $script

Script to prepare

Returns

static

__construct()

__construct(\FML\Controls\Quad  $quad = null, \FML\Controls\Entry  $entry = null, boolean  $default = null) 

Construct a new CheckBox Feature

Parameters

\FML\Controls\Quad $quad

(optional) CheckBox Quad

\FML\Controls\Entry $entry

(optional) Hidden Entry

boolean $default

(optional) Default value

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

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(\FML\Components\CheckBoxDesign  $checkBoxDesign) : static

Set the enabled Design

Parameters

\FML\Components\CheckBoxDesign $checkBoxDesign

Enabled CheckBox Design

Returns

static

setDisabledDesign()

setDisabledDesign(\FML\Components\CheckBoxDesign  $checkBoxDesign) : static

Set the disabled Design

Parameters

\FML\Components\CheckBoxDesign $checkBoxDesign

Disabled CheckBox Design

Returns

static

buildUpdateQuadDesignFunction()

buildUpdateQuadDesignFunction() : string

Build the function text

Returns

string

buildInitScriptText()

buildInitScriptText() : string

Build the init script text

Returns

string

buildClickScriptText()

buildClickScriptText() : string

Build the script text for Quad clicks

Returns

string