Slate.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Component\MainControls\Slate;

use ILIAS\UI\Component\Component;
use ILIAS\UI\Component\JavaScriptBindable;
use ILIAS\UI\Component\Signal;
use ILIAS\UI\Component\Symbol\Symbol;
use ILIAS\UI\Component\Triggerer;
use ILIAS\UI\Component\HasHelpTopics;

interface Slate extends Component, JavaScriptBindable, Triggerer, HasHelpTopics
{
    public function getName(): string;

    public function getSymbol(): Symbol;

    public function getToggleSignal(): Signal;

    public function getEngageSignal(): Signal;

    public function withEngaged(bool $state): Slate;

    public function getEngaged(): bool;

    public function getContents(): array;

    public function getReplaceSignal(): ?Signal;

    public function appendOnInView(Signal $signal): Slate;

    public function withMainBarTreePosition(string $tree_pos): Slate;

    public function getMainBarTreePosition(): ?string;
}