ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
Slate.php
Go to the documentation of this file.
1<?php
2
19declare(strict_types=1);
20
22
29
34{
38 public function getName(): string;
39
43 public function getSymbol(): Symbol;
44
48 public function getToggleSignal(): Signal;
49
53 public function getEngageSignal(): Signal;
54
58 public function withEngaged(bool $state): Slate;
59
63 public function getEngaged(): bool;
64
68 public function getContents(): array;
69
73 public function getReplaceSignal(): ?Signal;
74
78 public function appendOnInView(Signal $signal): Slate;
79
84 public function withMainBarTreePosition(string $tree_pos): Slate;
85
86 public function getMainBarTreePosition(): ?string;
87}
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.
getSymbol()
Get the Symbol of the slate.
getToggleSignal()
Signal that toggles the slate when triggered.
appendOnInView(Signal $signal)
A Signal that is triggered when the slate "comes into view", i.e.
withEngaged(bool $state)
Configures the slate to be rendered as engaged (or not).
getEngageSignal()
Signal that engages the slate when triggered.
withMainBarTreePosition(string $tree_pos)
Slates in the main bar need to be addressable via JS, a.o.
getEngaged()
Should the slate be rendered as engaged?
getReplaceSignal()
Signal to replace the contents of the slate.
getName()
Get the name of this slate.
This describes a symbol.
Definition: Symbol.php:30
trait JavaScriptBindable
Trait for components implementing JavaScriptBindable providing standard implementation.