This describes a Mode Control. More...

Inheritance diagram for ILIAS\UI\Component\ViewControl\Mode:

Collaboration diagram for ILIAS\UI\Component\ViewControl\Mode:

Public Member Functions
	withActive (string $label)
	set the currently active/engaged Button by label. More...

	getActive ()
	get the label of the currently active/engaged button of the mode control More...

	getLabelledActions ()
	Get the array containing the actions and labels of the mode control. More...

	getAriaLabel ()
	Get the aria-label on the ViewControl. More...

Public Member Functions inherited from ILIAS\UI\Component\Component
	getCanonicalName ()
	Get the canonical name of the component. More...

	reduceWith (\Closure $fn)
	The scheme starts at the leaves of the structure and applies the function to each leave and moves up the tree recursively. More...

Detailed Description

This describes a Mode Control.

Definition at line 28 of file Mode.php.

Member Function Documentation

ILIAS\UI\Component\ViewControl\Mode::getActive ( )

get the label of the currently active/engaged button of the mode control

Returns: string the label of the currently active button of the mode control

ILIAS\UI\Component\ViewControl\Mode::getAriaLabel ( )

Get the aria-label on the ViewControl.

ILIAS\UI\Component\ViewControl\Mode::getLabelledActions ( )

Get the array containing the actions and labels of the mode control.

Returns: array (string|string)[]. Array containing keys as label and values as actions.

ILIAS\UI\Component\ViewControl\Mode::withActive ( string $label )

set the currently active/engaged Button by label.

Parameters

string $label,. The label of the button to activate

Here is the caller graph for this function:

The documentation for this interface was generated from the following file: