ILIAS\UI\Component\MainControls\MetaBar Interface Reference

This describes the MetaBar. More...

Inheritance diagram for ILIAS\UI\Component\MainControls\MetaBar:

Collaboration diagram for ILIAS\UI\Component\MainControls\MetaBar:

Public Member Functions
	withAdditionalEntry (string $id, $entry)
	Append an entry. More...
	getEntries ()
	getEntryClickSignal ()
	The Signal is triggered when any Entry is being clicked. More...
	getDisengageAllSignal ()
	This signal disengages all slates when triggered. More...
	withClearedEntries ()
	Get a copy of this MetaBar without any entries. 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...
Public Member Functions inherited from ILIAS\UI\Component\JavaScriptBindable
	withOnLoadCode (Closure $binder)
	withAdditionalOnLoadCode (Closure $binder)
	Add some onload-code to the component instead of replacing the existing one. More...
	getOnLoadCode ()
	Get the currently bound on load code. More...

Detailed Description

This describes the MetaBar.

Definition at line 32 of file MetaBar.php.

Member Function Documentation

getDisengageAllSignal()

ILIAS\UI\Component\MainControls\MetaBar::getDisengageAllSignal

(

)

This signal disengages all slates when triggered.

Referenced by ILIAS\UI\Implementation\Component\MainControls\Renderer\renderMainbarEntry().

Here is the caller graph for this function:

getEntries()

ILIAS\UI\Component\MainControls\MetaBar::getEntries

(

)

Returns

array <string, Bulky|Slate>

Referenced by ILIAS\UI\Implementation\Component\MainControls\Renderer\renderMainbarEntry().

Here is the caller graph for this function:

getEntryClickSignal()

ILIAS\UI\Component\MainControls\MetaBar::getEntryClickSignal

(

)

The Signal is triggered when any Entry is being clicked.

Referenced by ILIAS\UI\Implementation\Component\MainControls\Renderer\renderMainbarEntry().

Here is the caller graph for this function:

withAdditionalEntry()

ILIAS\UI\Component\MainControls\MetaBar::withAdditionalEntry	(	string	$id,
			$entry
	)

Append an entry.

Parameters

Button\Bulky | Slate

$entry

Exceptions

Referenced by ILIAS\LTI\Screen\LtiViewLayoutProvider\getMetaBarModification().

Here is the caller graph for this function:

withClearedEntries()

ILIAS\UI\Component\MainControls\MetaBar::withClearedEntries

(

)

Get a copy of this MetaBar without any entries.

Referenced by ilLSViewLayoutProvider\getMetaBarModification(), ILIAS\components\WOPI\Embed\EmbeddedApplicationGSProvider\getMetaBarModification(), and ILIAS\LTI\Screen\LtiViewLayoutProvider\getMetaBarModification().

Here is the caller graph for this function:

---

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

• components/ILIAS/UI/src/Component/MainControls/MetaBar.php