ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
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
11
16{
24 public function withAdditionalEntry(string $id, $entry) : MainBar;
25
29 public function getEntries() : array;
30
38 public function withAdditionalToolEntry(
39 string $id,
40 Slate\Slate $entry,
41 bool $initially_hidden = false,
42 Button\Close $close_button = null
43 ) : MainBar;
44
48 public function getToolEntries();
49
53 public function withActive(string $active) : MainBar;
54
58 public function getActive();
59
63 public function withToolsButton(Button\Bulky $button) : MainBar;
64
68 public function getToolsButton() : Button\Bulky;
69
73 public function withMoreButton(Button\Bulky $button) : MainBar;
74
78 public function getMoreButton() : Button\Bulky;
79
83 public function getEntryClickSignal() : Signal;
84
88 public function getToolsClickSignal() : Signal;
89
93 public function getToolsRemovalSignal() : Signal;
94
98 public function getDisengageAllSignal() : Signal;
99
104 public function getInitiallyHiddenToolIds() : array;
105
109 public function getEngageToolSignal(string $tool_id) : Signal;
110
115 public function getCloseButtons() : array;
116
120 public function withClearedEntries() : MainBar;
121
125 public function getToggleToolsSignal() : Signal;
126}
An exception for terminatinating execution or to throw for unit testing.
This describes a bulky button.
Definition: Bulky.php:10
This describes a close button.
Definition: Close.php:18
A component is the most general form of an entity in the UI.
Definition: Component.php:14
Interface to be extended by components that have the possibility to bind to Javascript.
This describes the MainBar.
Definition: MainBar.php:16
withClearedEntries()
Get a copy of this Mainbar without any entries.
getEngageToolSignal(string $tool_id)
Signal to engage a tool from outside the mainbar.
getCloseButtons()
Buttons to close tools; maybe configure with callback.
withMoreButton(Button\Bulky $button)
Set button for further entries that do not fit on the screen.
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.
withAdditionalToolEntry(string $id, Slate\Slate $entry, bool $initially_hidden=false, Button\Close $close_button=null)
Append a tool-entry.
getMoreButton()
Returns the button for further entries.
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.
trait JavaScriptBindable
Trait for components implementing JavaScriptBindable providing standard implementation.