\FML\Script\FeaturesTooltip

Script Feature for showing Tooltips

Summary

Methods
Properties
Constants
collect()
prepare()
__construct()
getHoverControl()
setHoverControl()
getTooltipControl()
setTooltipControl()
getStayOnClick()
setStayOnClick()
getInvert()
setInvert()
getText()
setText()
No public properties found
No constants found
No protected methods found
$hoverControl
$tooltipControl
$stayOnClick
$invert
$text
N/A
No private methods found
No private properties found
N/A

Properties

$stayOnClick

$stayOnClick : boolean

Type

boolean — Stay on click

$invert

$invert : boolean

Type

boolean — Inverted visibility toggling

$text

$text : string

Type

string — Tooltip Text

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  $hoverControl = null, \FML\Controls\Control  $tooltipControl = null, boolean  $stayOnClick = null, boolean  $invert = null, string  $text = null) 

Construct a new Tooltip

Parameters

\FML\Controls\Control $hoverControl

(optional) Hover Control

\FML\Controls\Control $tooltipControl

(optional) Tooltip Control

boolean $stayOnClick

(optional) If the Tooltip should stay on click

boolean $invert

(optional) If the visibility toggling should be inverted

string $text

(optional) Text to display if the TooltipControl is a Label

getHoverControl()

getHoverControl() : \FML\Controls\Control

Get the Hover Control

Returns

\FML\Controls\Control

setHoverControl()

setHoverControl(\FML\Controls\Control  $hoverControl) : static

Set the Hover Control

Parameters

\FML\Controls\Control $hoverControl

Hover Control

Returns

static

getTooltipControl()

getTooltipControl() : \FML\Controls\Control

Get the Tooltip Control

Returns

\FML\Controls\Control

setTooltipControl()

setTooltipControl(\FML\Controls\Control  $tooltipControl) : static

Set the Tooltip Control

Parameters

\FML\Controls\Control $tooltipControl

Tooltip Control

Returns

static

getStayOnClick()

getStayOnClick() : boolean

Get the staying on click

Returns

boolean

setStayOnClick()

setStayOnClick(boolean  $stayOnClick) : static

Set the staying on click

Parameters

boolean $stayOnClick

If the Tooltip should stay on click

Returns

static

getInvert()

getInvert() : boolean

Get inverting of the visibility

Returns

boolean

setInvert()

setInvert(boolean  $invert) : static

Set inverting of the visibility

Parameters

boolean $invert

If the visibility toggling should be inverted

Returns

static

getText()

getText() : string

Get the text

Returns

string

setText()

setText(string  $text) : static

Set the text

Parameters

string $text

Text to display if the TooltipControl is a Label

Returns

static