ILIAS  release_8 Revision v8.19
All Data Structures Namespaces Files Functions Variables Modules Pages
MainBar.php
Go to the documentation of this file.
1 <?php
2 
3 declare(strict_types=1);
4 
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 }
withAdditionalToolEntry(string $id, Slate\Slate $entry, bool $initially_hidden=false, Button\Close $close_button=null)
Append a tool-entry.
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
Definition: Factory.php:21
This describes the MainBar.
Definition: MainBar.php:33
getDisengageAllSignal()
This signal disengages all slates when triggered.
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...
trait JavaScriptBindable
Trait for components implementing JavaScriptBindable providing standard implementation.
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
Definition: Bulky.php:21
getToolsClickSignal()
Get the signal that is triggered when any entry in the tools-button is clicked.
withClearedEntries()
Get a copy of this MainBar without any entries.
getToolsRemovalSignal()
Get the signal that is used for removing a tool.
withAdditionalEntry(string $id, $entry)
Append an entry.
This describes a bulky button.
Definition: Bulky.php:28
getEntryClickSignal()
Get the signal that is triggered when any entry in the bar is clicked.
getToolsButton()
Returns the button of the tools-trigger.
$id
plugin.php for ilComponentBuildPluginInfoObjectiveTest::testAddPlugins
Definition: plugin.php:23
This describes a close button.
Definition: Close.php:33
withToolsButton(Button\Bulky $button)
Set button for the tools-trigger.
getToggleToolsSignal()
Signal to toggle the tools-section.
getEngageToolSignal(string $tool_id)
Signal to engage a tool from outside the MainBar.
getCloseButtons()
Buttons to close tools; maybe configure with callback.
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
Definition: Combined.php:20