ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
Tree.php
Go to the documentation of this file.
1<?php
2
19declare(strict_types=1);
20
22
24
28interface Tree extends Component
29{
34 public function withEnvironment($environment): Tree;
35
39 public function getLabel(): string;
40
44 public function withData($data): Tree;
45
49 public function getEnvironment();
50
54 public function getData();
55
59 public function getRecursion(): TreeRecursion;
60
64 public function withHighlightOnNodeClick(bool $highlight): Tree;
65
69 public function getHighlightOnNodeClick(): bool;
70
74 public function isSubTree(): bool;
75
79 public function withIsSubTree(bool $is_sub): Tree;
80}
A component is the most general form of an entity in the UI.
Definition: Component.php:28
Interface for mapping data-structures to the Tree.
This describes a Tree Control.
Definition: Tree.php:29
getRecursion()
Get the mapping-class.
withEnvironment($environment)
Configure the Tree with additional information that will be relayed to TreeRecursion.
withHighlightOnNodeClick(bool $highlight)
Should a clicked node be highlighted?
withData($data)
Apply data to the Tree.
getEnvironment()
Get the environment.
getLabel()
Get the (aria-)label.
withIsSubTree(bool $is_sub)
Set this tree to be a part of a tree.
getHighlightOnNodeClick()
Is the tree configured to highlight a clicked node?
isSubTree()
Is this only a part of a tree? Needed if parts are loaded async.