This describes a Tree Control. More...
Inheritance diagram for ILIAS\UI\Component\Tree\Tree:
Collaboration diagram for ILIAS\UI\Component\Tree\Tree:
Public Member Functions | |
| withEnvironment ($environment) | |
| Configure the Tree with additional information that will be relayed to TreeRecursion. More... | |
| getLabel () | |
| Get the (aria-)label. More... | |
| withData ($data) | |
| Apply data to the Tree. More... | |
| getEnvironment () | |
| Get the environment. More... | |
| getData () | |
| Get the data. More... | |
| getRecursion () | |
| Get the mapping-class. More... | |
| withHighlightOnNodeClick (bool $highlight) | |
| Should a clicked node be highlighted? More... | |
| getHighlightOnNodeClick () | |
| Is the tree configured to highlight a clicked node? More... | |
| isSubTree () | |
| Is this only a part of a tree? Needed if parts are loaded async. More... | |
| withIsSubTree (bool $is_sub) | |
| Set this tree to be a part of a tree. More... | |
| Public Member Functions inherited from ILIAS\UI\Component\Component | |
| getCanonicalName () | |
| Get the canonical name of the component. More... | |
| reduceWith (\Closure $fn) | |
| The scheme starts at the leaves of the structure and applies the function to each leave and moves up the tree recursively. More... | |
Detailed Description
Member Function Documentation
◆ getData()
| ILIAS\UI\Component\Tree\Tree::getData | ( | ) |
Get the data.
Implemented in ILIAS\UI\Implementation\Component\Tree\Tree.
◆ getEnvironment()
| ILIAS\UI\Component\Tree\Tree::getEnvironment | ( | ) |
Get the environment.
Implemented in ILIAS\UI\Implementation\Component\Tree\Tree.
◆ getHighlightOnNodeClick()
| ILIAS\UI\Component\Tree\Tree::getHighlightOnNodeClick | ( | ) |
Is the tree configured to highlight a clicked node?
Implemented in ILIAS\UI\Implementation\Component\Tree\Tree.
◆ getLabel()
| ILIAS\UI\Component\Tree\Tree::getLabel | ( | ) |
Get the (aria-)label.
Implemented in ILIAS\UI\Implementation\Component\Tree\Tree.
◆ getRecursion()
| ILIAS\UI\Component\Tree\Tree::getRecursion | ( | ) |
Get the mapping-class.
Implemented in ILIAS\UI\Implementation\Component\Tree\Tree.
◆ isSubTree()
| ILIAS\UI\Component\Tree\Tree::isSubTree | ( | ) |
Is this only a part of a tree? Needed if parts are loaded async.
Implemented in ILIAS\UI\Implementation\Component\Tree\Tree.
◆ withData()
| ILIAS\UI\Component\Tree\Tree::withData | ( | $data | ) |
Apply data to the Tree.
Implemented in ILIAS\UI\Implementation\Component\Tree\Tree.
◆ withEnvironment()
| ILIAS\UI\Component\Tree\Tree::withEnvironment | ( | $environment | ) |
Configure the Tree with additional information that will be relayed to TreeRecursion.
Implemented in ILIAS\UI\Implementation\Component\Tree\Tree.
◆ withHighlightOnNodeClick()
| ILIAS\UI\Component\Tree\Tree::withHighlightOnNodeClick | ( | bool | $highlight | ) |
Should a clicked node be highlighted?
Implemented in ILIAS\UI\Implementation\Component\Tree\Tree.
◆ withIsSubTree()
| ILIAS\UI\Component\Tree\Tree::withIsSubTree | ( | bool | $is_sub | ) |
Set this tree to be a part of a tree.
Needed if parts are loaded async.
Implemented in ILIAS\UI\Implementation\Component\Tree\Tree.
The documentation for this interface was generated from the following file:
- components/ILIAS/UI/src/Component/Tree/Tree.php
