Properties

$togglingControl

$togglingControl : \FML\Controls\Control

Type

\FML\Controls\Control — Toggling Control

$labelName

$labelName : 

Type

— Script Label name

$onlyShow

$onlyShow : boolean

Type

boolean — Show only

$onlyHide

$onlyHide : boolean

Type

boolean — Hide only

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\Control  $togglingControl = null, \FML\Controls\Control  $toggledControl = null, string  $labelName = \FML\Script\ScriptLabel::MOUSECLICK, boolean  $onlyShow = false, boolean  $onlyHide = false) 

Construct a new Toggle

Parameters

\FML\Controls\Control $togglingControl

(optional) Toggling Control

\FML\Controls\Control $toggledControl

(optional) Toggled Control

string $labelName

(optional) Script Label name

boolean $onlyShow

(optional) If it should only show the Control but not toggle

boolean $onlyHide

(optional) If it should only hide the Control but not toggle

getTogglingControl()

getTogglingControl() : \FML\Controls\Control

Get the toggling Control

Returns

\FML\Controls\Control

setTogglingControl()

setTogglingControl(\FML\Controls\Control  $control) : static

Set the toggling Control

Parameters

\FML\Controls\Control $control

Toggling Control

Returns

static

getToggledControl()

getToggledControl() : \FML\Controls\Control

Get the toggled Control

Returns

\FML\Controls\Control

setToggledControl()

setToggledControl(\FML\Controls\Control  $control) : static

Set the toggled Control

Parameters

\FML\Controls\Control $control

Toggled Control

Returns

static

getLabelName()

getLabelName() : string

Get the Script Label name

Returns

string

setLabelName()

setLabelName(string  $labelName) : static

Set the Script Label name

Parameters

string $labelName

Script Label Name

Returns

static

getOnlyShow()

getOnlyShow() : boolean

Get Show Only

Returns

boolean

setOnlyShow()

setOnlyShow(boolean  $onlyShow) : static

Set Show Only

Parameters

boolean $onlyShow

If it should only show the Control but not toggle

Returns

static

getOnlyHide()

getOnlyHide() : boolean

Get Hide Only

Returns

boolean

setOnlyHide()

setOnlyHide(boolean  $onlyHide) : static

Set Hide Only

Parameters

boolean $onlyHide

If it should only hide the Control but not toggle

Returns

static

getScriptText()

getScriptText() : string

Get the script text

Returns

string