\FML\Script\FeaturesMenu

Script Feature realising a Menu showing specific Controls for the different items

Summary

Methods
Properties
Constants
collect()
prepare()
__construct()
getElements()
addItem()
addElement()
getStartElement()
setStartElement()
No public properties found
FUNCTION_UPDATE_MENU
getElementsArrayText()
$elements
$startElement
N/A
No private methods found
No private properties found
N/A

Constants

FUNCTION_UPDATE_MENU

FUNCTION_UPDATE_MENU

Properties

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  $item = null, \FML\Controls\Control  $control = null, boolean  $isStartElement = true) 

Construct a new Menu

Parameters

\FML\Controls\Control $item

(optional) Item Control in the Menu bar

\FML\Controls\Control $control

(optional) Toggled Menu Control

boolean $isStartElement

(optional) Whether the Menu should start with the given Element

addItem()

addItem(\FML\Controls\Control  $item, \FML\Controls\Control  $control, boolean  $isStartElement = false) : static

Add a Menu item

Parameters

\FML\Controls\Control $item

Item Control in the Menu bar

\FML\Controls\Control $control

Toggled Menu Control

boolean $isStartElement

(optional) Whether the Menu should start with this Element

Returns

static

addElement()

addElement(\FML\Script\Features\MenuElement  $menuElement, boolean  $isStartElement = false) : static

Add a Menu Element

Parameters

\FML\Script\Features\MenuElement $menuElement

Menu Element

boolean $isStartElement

(optional) Whether the Menu should start with this Element

Returns

static

setStartElement()

setStartElement(\FML\Script\Features\MenuElement  $startElement = null) : static

Set the Element to start with

Parameters

\FML\Script\Features\MenuElement $startElement

Start Element

Returns

static

getElementsArrayText()

getElementsArrayText() : string

Build the array text for the Elements

Returns

string