ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
MainBar.php
Go to the documentation of this file.
1<?php
2
19declare(strict_types=1);
20
22
29
34{
41 public function withAdditionalEntry(string $id, $entry): MainBar;
42
46 public function getEntries(): array;
47
55 public function withAdditionalToolEntry(
56 string $id,
57 Slate\Slate $entry,
58 bool $initially_hidden = false,
59 ?Button\Close $close_button = null
60 ): MainBar;
61
65 public function getToolEntries(): array;
66
70 public function withActive(string $active): MainBar;
71
72 public function getActive(): ?string;
73
77 public function withToolsButton(Button\Bulky $button): MainBar;
78
82 public function getToolsButton(): Button\Bulky;
83
87 public function getEntryClickSignal(): Signal;
88
92 public function getToolsClickSignal(): Signal;
93
97 public function getToolsRemovalSignal(): Signal;
98
102 public function getDisengageAllSignal(): Signal;
103
108 public function getInitiallyHiddenToolIds(): array;
109
113 public function getEngageToolSignal(string $tool_id): Signal;
114
119 public function getCloseButtons(): array;
120
124 public function withClearedEntries(): MainBar;
125
129 public function getToggleToolsSignal(): Signal;
130}
$id
plugin.php for ilComponentBuildPluginInfoObjectiveTest::testAddPlugins
Definition: plugin.php:23
This describes a bulky button.
Definition: Bulky.php:29
This describes a close button.
Definition: Close.php:34
A component is the most general form of an entity in the UI.
Definition: Component.php:28
Interface to be extended by components that have the possibility to bind to Javascript.
This describes the MainBar.
Definition: MainBar.php:34
withClearedEntries()
Get a copy of this MainBar without any entries.
getEngageToolSignal(string $tool_id)
Signal to engage a tool from outside the MainBar.
withAdditionalToolEntry(string $id, Slate\Slate $entry, bool $initially_hidden=false, ?Button\Close $close_button=null)
Append a tool-entry.
getCloseButtons()
Buttons to close tools; maybe configure with callback.
getToolsButton()
Returns the button of the tools-trigger.
getToolsRemovalSignal()
Get the signal that is used for removing a tool.
getToolsClickSignal()
Get the signal that is triggered when any entry in the tools-button is clicked.
withAdditionalEntry(string $id, $entry)
Append an entry.
getEntryClickSignal()
Get the signal that is triggered when any entry in the bar is clicked.
getToggleToolsSignal()
Signal to toggle the tools-section.
getDisengageAllSignal()
This signal disengages all slates when triggered.
withToolsButton(Button\Bulky $button)
Set button for the tools-trigger.
getInitiallyHiddenToolIds()
There are tools that are rendered invisible before first activation.
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
Definition: Bulky.php:21
trait JavaScriptBindable
Trait for components implementing JavaScriptBindable providing standard implementation.