ILIAS  release_7 Revision v7.30-3-g800a261c036
All Data Structures Namespaces Files Functions Variables Modules Pages
MainBar.php
Go to the documentation of this file.
1 <?php
2 
3 /* Copyright (c) 2017 Nils Haagen <nils.haagen@concepts-and-training.de> Extended GPL, see docs/LICENSE */
4 
6 
12 
17 {
25  public function withAdditionalEntry(string $id, $entry) : MainBar;
26 
30  public function getEntries() : array;
31 
39  public function withAdditionalToolEntry(
40  string $id,
41  Slate\Slate $entry,
42  bool $initially_hidden = false,
43  Button\Close $close_button = null
44  ) : MainBar;
45 
49  public function getToolEntries();
50 
54  public function withActive(string $active) : MainBar;
55 
59  public function getActive();
60 
64  public function withToolsButton(Button\Bulky $button) : MainBar;
65 
69  public function getToolsButton() : Button\Bulky;
70 
74  public function getEntryClickSignal() : Signal;
75 
79  public function getToolsClickSignal() : Signal;
80 
84  public function getToolsRemovalSignal() : Signal;
85 
89  public function getDisengageAllSignal() : Signal;
90 
95  public function getInitiallyHiddenToolIds() : array;
96 
100  public function getEngageToolSignal(string $tool_id) : Signal;
101 
106  public function getCloseButtons() : array;
107 
111  public function withClearedEntries() : MainBar;
112 
116  public function getToggleToolsSignal() : Signal;
117 }
withAdditionalToolEntry(string $id, Slate\Slate $entry, bool $initially_hidden=false, Button\Close $close_button=null)
Append a tool-entry.
This describes the MainBar.
Definition: MainBar.php:16
getDisengageAllSignal()
This signal disengages all slates when triggered.
getInitiallyHiddenToolIds()
There are tools that are rendered invisible before first activation.
trait JavaScriptBindable
Trait for components implementing JavaScriptBindable providing standard implementation.
A component is the most general form of an entity in the UI.
Definition: Component.php:13
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:9
getEntryClickSignal()
Get the signal that is triggered when any entry in the bar is clicked.
getToolsButton()
Returns the button of the tools-trigger.
This describes a close button.
Definition: Close.php:17
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.