ILIAS  release_7 Revision v7.30-3-g800a261c036
Slate.php
Go to the documentation of this file.
1<?php
2
3/* Copyright (c) 2018 Nils Haagen <nils.haagen@concepts-and-training.de> Extended GPL, see docs/LICENSE */
4
6
13
18{
22 public function getName() : string;
23
27 public function getSymbol() : Symbol;
28
32 public function getToggleSignal() : Signal;
33
37 public function getEngageSignal() : Signal;
38
42 public function withEngaged(bool $state) : Slate;
43
47 public function getEngaged() : bool;
48
52 public function getContents();
53
57 public function getReplaceSignal() : ReplaceSignal;
58
62 public function appendOnInView(Signal $signal) : Slate;
63
68 public function withMainBarTreePosition(string $tree_pos);
69
70 public function getMainBarTreePosition();
71}
An exception for terminatinating execution or to throw for unit testing.
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.
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 mainbar need to be adressable 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 signal replaces a component by ajax.
This describes a symbol.
Definition: Symbol.php:12
trait JavaScriptBindable
Trait for components implementing JavaScriptBindable providing standard implementation.