ILIAS  release_7 Revision v7.30-3-g800a261c036
All Data Structures Namespaces Files Functions Variables Modules Pages
Tree.php
Go to the documentation of this file.
1 <?php
2 declare(strict_types=1);
3 
4 /* Copyright (c) 2019 Nils Haagen <nils.haagen@concepts-and-training.de> Extended GPL, see docs/LICENSE */
5 
7 
8 use \ILIAS\UI\Component\Component;
9 
13 interface Tree extends Component
14 {
19  public function withEnvironment($environment) : Tree;
20 
26  public function getLabel() : string;
27 
31  public function withData($data) : Tree;
32 
36  public function getEnvironment();
37 
41  public function getData();
42 
46  public function getRecursion() : TreeRecursion;
47 
51  public function withHighlightOnNodeClick(bool $highlight) : Tree;
52 
56  public function getHighlightOnNodeClick() : bool;
57 
61  public function isSubTree() : bool;
62 
66  public function withIsSubTree(bool $is_sub) : Tree;
67 }
getEnvironment()
Get the environment.
$data
Definition: storeScorm.php:23
withData($data)
Apply data to the Tree.
getRecursion()
Get the mapping-class.
isSubTree()
Is this only a part of a tree? Needed if parts are loaded async.
withHighlightOnNodeClick(bool $highlight)
Should a clicked node be highlighted?
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?
This describes a Tree Control.
Definition: Tree.php:13
withEnvironment($environment)
Configure the Tree with additional information that will be relayed to TreeRecursion.
Interface for mapping data-structures to the Tree.