class Tooltip extends ConfigObject (View source)

Properties

bool $isHtml Tooltip is HTML.
bool $showColorCode Show color code for the tooltip.
TextStyle $textStyle Tooltip text style
string $trigger Trigger Action of the tooltip.

Methods

mixed
__construct( array $config = array())

Builds the tooltip object with specified options.

array
toArray( string $keyName = null)

Returns an array representation of the object.

array
getValues()

Same as toArray, but without the class name as a key to being multi-dimension.

isHtml( bool $isHtml)

Sets whether the tooltip is HTML.

showColorCode( bool $showColorCode)

Sets whether to show the color code.

textStyle( TextStyle $textStyle)

Sets the text style of the tooltip.

trigger( string $trigger)

Sets The user interaction that causes the tooltip to be displayed.

Details

at line 61
mixed __construct( array $config = array())

Builds the tooltip object with specified options.

Parameters

array $config Array of options.

Return Value

mixed

Exceptions

InvalidConfigValue
InvalidConfigProperty

in ConfigObject at line 93
array toArray( string $keyName = null)

Returns an array representation of the object.

If passed a label, then the array will be returned with the label as the key.

Called with no label returns an array with the classname as the key.

Parameters

string $keyName Key name to be applied to generated array.

Return Value

array Assoc. array of the options of the object.

in ConfigObject at line 115
array getValues()

Same as toArray, but without the class name as a key to being multi-dimension.

Return Value

array Array of the options of the object.

at line 73
Tooltip isHtml( bool $isHtml)

Sets whether the tooltip is HTML.

Parameters

bool $isHtml

Return Value

Tooltip

Exceptions

InvalidConfigValue

at line 93
Tooltip showColorCode( bool $showColorCode)

Sets whether to show the color code.

Parameters

bool $showColorCode State of showing the color code.

Return Value

Tooltip

Exceptions

InvalidConfigValue

at line 113
Tooltip textStyle( TextStyle $textStyle)

Sets the text style of the tooltip.

Parameters

TextStyle $textStyle A valid TextStyle object.

Return Value

Tooltip

at line 130
Tooltip trigger( string $trigger)

Sets The user interaction that causes the tooltip to be displayed.

'focus' - The tooltip will be displayed when the user hovers over an element. 'none' - The tooltip will not be displayed.

Parameters

string $trigger Type of trigger.

Return Value

Tooltip

Exceptions

InvalidConfigValue