This describes the MainBar. More...

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

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

Public Member Functions
	withAdditionalEntry (string $id, $entry)
	Append an entry. More...

	getEntries ()

	withAdditionalToolEntry (string $id, Slate\Slate $entry, bool $initially_hidden=false, ?Button\Close $close_button=null)
	Append a tool-entry. More...

	getToolEntries ()

	withActive (string $active)

	getActive ()

	withToolsButton (Button\Bulky $button)
	Set button for the tools-trigger. More...

	getToolsButton ()
	Returns the button of the tools-trigger. More...

	getEntryClickSignal ()
	Get the signal that is triggered when any entry in the bar is clicked. More...

	getToolsClickSignal ()
	Get the signal that is triggered when any entry in the tools-button is clicked. More...

	getToolsRemovalSignal ()
	Get the signal that is used for removing a tool. More...

	getDisengageAllSignal ()
	This signal disengages all slates when triggered. More...

	getInitiallyHiddenToolIds ()
	There are tools that are rendered invisible before first activation. More...

	getEngageToolSignal (string $tool_id)
	Signal to engage a tool from outside the MainBar. More...

	getCloseButtons ()
	Buttons to close tools; maybe configure with callback. More...

	withClearedEntries ()
	Get a copy of this MainBar without any entries. More...

	getToggleToolsSignal ()
	Signal to toggle the tools-section. 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 MainBar.

Definition at line 33 of file MainBar.php.

Member Function Documentation

◆ getActive()

ILIAS\UI\Component\MainControls\MainBar::getActive ( )

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

Here is the caller graph for this function:

◆ getCloseButtons()

ILIAS\UI\Component\MainControls\MainBar::getCloseButtons ( )

Buttons to close tools; maybe configure with callback.

Returns: array <string, Button\Close>

◆ getDisengageAllSignal()

ILIAS\UI\Component\MainControls\MainBar::getDisengageAllSignal ( )

This signal disengages all slates when triggered.

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

Here is the caller graph for this function:

◆ getEngageToolSignal()

ILIAS\UI\Component\MainControls\MainBar::getEngageToolSignal ( string $tool_id )

Signal to engage a tool from outside the MainBar.

Referenced by ILIAS\UI\examples\Layout\Page\Standard\pagedemoContent().

Here is the caller graph for this function:

◆ getEntries()

ILIAS\UI\Component\MainControls\MainBar::getEntries ( )

Returns: array <string, Button\Bulky|Link\Bulky|Slate>

◆ getEntryClickSignal()

ILIAS\UI\Component\MainControls\MainBar::getEntryClickSignal ( )

Get the signal that is triggered when any entry in the bar is clicked.

◆ getInitiallyHiddenToolIds()

ILIAS\UI\Component\MainControls\MainBar::getInitiallyHiddenToolIds ( )

There are tools that are rendered invisible before first activation.

Returns: string[]

◆ getToggleToolsSignal()

ILIAS\UI\Component\MainControls\MainBar::getToggleToolsSignal ( )

Signal to toggle the tools-section.

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

Here is the caller graph for this function:

◆ getToolEntries()

ILIAS\UI\Component\MainControls\MainBar::getToolEntries ( )

Returns: array <string, Slate>

Referenced by ILIAS\UI\Implementation\Component\MainControls\Renderer\bindMainbarJS(), ilLSViewLayoutProvider\getMainBarModification(), ILIAS\LTI\Screen\LtiViewLayoutProvider\getMainBarModification(), and ILIAS\UI\examples\Layout\Page\Standard\pagedemoContent().

Here is the caller graph for this function:

◆ getToolsButton()

ILIAS\UI\Component\MainControls\MainBar::getToolsButton ( )

Returns the button of the tools-trigger.

◆ getToolsClickSignal()

ILIAS\UI\Component\MainControls\MainBar::getToolsClickSignal ( )

Get the signal that is triggered when any entry in the tools-button is clicked.

◆ getToolsRemovalSignal()

ILIAS\UI\Component\MainControls\MainBar::getToolsRemovalSignal ( )

Get the signal that is used for removing a tool.

◆ withActive()

ILIAS\UI\Component\MainControls\MainBar::withActive ( string $active )

Exceptions

InvalidArgumentException if $active is not an element-identifier in entries

Referenced by DashboardLayoutProvider\getMainBarModification().

Here is the caller graph for this function:

◆ withAdditionalEntry()

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

Append an entry.

Parameters

Button\Bulky | Link\Bulky | Slate\Slate $entry

Exceptions

InvalidArgumentException if $id is already taken

Referenced by ilLSViewLayoutProvider\getMainBarModification().

Here is the caller graph for this function:

◆ withAdditionalToolEntry()

ILIAS\UI\Component\MainControls\MainBar::withAdditionalToolEntry	(	string	$id,
		Slate\Slate	$entry,
		bool	$initially_hidden = `false`,
		?Button\Close	$close_button = `null`
	)

Append a tool-entry.

Define a tools-trigger via "withToolsButton" first.

Exceptions

InvalidArgumentException if $id is already taken

Exceptions

LogicException if no tool-button was set

Referenced by ilLSViewLayoutProvider\getMainBarModification(), and ILIAS\LTI\Screen\LtiViewLayoutProvider\getMainBarModification().

Here is the caller graph for this function:

◆ withClearedEntries()

ILIAS\UI\Component\MainControls\MainBar::withClearedEntries ( )

Get a copy of this MainBar without any entries.

Referenced by ilTestPlayerLayoutProvider\getMainBarModification(), ilLSViewLayoutProvider\getMainBarModification(), and ILIAS\LTI\Screen\LtiViewLayoutProvider\getMainBarModification().

Here is the caller graph for this function:

◆ withToolsButton()

ILIAS\UI\Component\MainControls\MainBar::withToolsButton ( Button\Bulky $button )

Set button for the tools-trigger.

Referenced by ilTestPlayerLayoutProvider\getMainBarModification().

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/MainBar.php

Public Member Functions

Detailed Description

Member Function Documentation

◆ getActive()

◆ getCloseButtons()

◆ getDisengageAllSignal()

◆ getEngageToolSignal()

◆ getEntries()

◆ getEntryClickSignal()

◆ getInitiallyHiddenToolIds()

◆ getToggleToolsSignal()

◆ getToolEntries()

◆ getToolsButton()

◆ getToolsClickSignal()

◆ getToolsRemovalSignal()

◆ withActive()

◆ withAdditionalEntry()

◆ withAdditionalToolEntry()

◆ withClearedEntries()

◆ withToolsButton()