ILIAS  release_8 Revision v8.19-1-g4e8f2f9140c
All Data Structures Namespaces Files Functions Variables Modules Pages
TestGenericSlate Class Reference

A generic Slate. More...

+ Inheritance diagram for TestGenericSlate:
+ Collaboration diagram for TestGenericSlate:

Public Member Functions

 getContents ()
 
 withMappedSubNodes (callable $f)
 
- Public Member Functions inherited from ILIAS\UI\Implementation\Component\MainControls\Slate\Slate
 __construct (SignalGeneratorInterface $signal_generator, string $name, Symbol $symbol)
 
 getName ()
 Get the name of this slate. More...
 
 getSymbol ()
 Get the Symbol of the slate. More...
 
 getToggleSignal ()
 Signal that toggles the slate when triggered. More...
 
 getEngageSignal ()
 Signal that engages the slate when triggered. More...
 
 withEngaged (bool $state)
 Configures the slate to be rendered as engaged (or not). More...
 
 getEngaged ()
 Should the slate be rendered as engaged? More...
 
 getContents ()
 
Returns
Component[]
More...
 
 getReplaceSignal ()
 Signal to replace the contents of the slate. More...
 
 appendOnInView (Signal $signal)
 A Signal that is triggered when the slate "comes into view", i.e.is being engaged. More...
 
 withMappedSubNodes (callable $f)
 
 withMainBarTreePosition (string $tree_pos)
 Slates in the main bar need to be addressable via JS, a.o.for storing current activation states or triggering them from the outside. More...
 
 getMainBarTreePosition ()
 
 getMainBarTreeDepth ()
 
 withAriaRole (string $aria_role)
 Get a slate like this, but with an additional ARIA role. More...
 
 getAriaRole ()
 Get the ARIA role on the slate. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\Component
 getCanonicalName ()
 Get the canonical name of the component. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\JavaScriptBindable
 withOnLoadCode (Closure $binder)
 
 withAdditionalOnLoadCode (Closure $binder)
 Add some onload-code to the component instead of replacing the existing one. More...
 
 getOnLoadCode ()
 Get the currently bound on load code. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\Triggerer
 withResetTriggeredSignals ()
 Get a component like this but reset any triggered signals of other components. More...
 
 getTriggeredSignals ()
 Get all triggered signals of this component. More...
 

Additional Inherited Members

- Data Fields inherited from ILIAS\UI\Implementation\Component\MainControls\Slate\Slate
const MENU = 'menu'
 
- Protected Member Functions inherited from ILIAS\UI\Implementation\Component\MainControls\Slate\Slate
 initSignals ()
 Set the signals for this component. More...
 
- Protected Attributes inherited from ILIAS\UI\Implementation\Component\MainControls\Slate\Slate
string $name
 
Symbol $symbol
 
Signal $toggle_signal
 
Signal $engage_signal
 
Signal $replace_signal = null
 
bool $engaged = false
 
string $mainbar_tree_position = null
 
string $aria_role = null
 
SignalGeneratorInterface $signal_generator
 
- Static Protected Attributes inherited from ILIAS\UI\Implementation\Component\MainControls\Slate\Slate
static array $allowed_aria_roles
 

Detailed Description

A generic Slate.

Definition at line 32 of file SlateTest.php.

Member Function Documentation

◆ getContents()

TestGenericSlate::getContents ( )
Returns
Component[]

Implements ILIAS\UI\Component\MainControls\Slate\Slate.

Definition at line 34 of file SlateTest.php.

34  : array
35  {
36  return [];
37  }

◆ withMappedSubNodes()

TestGenericSlate::withMappedSubNodes ( callable  $f)

Definition at line 38 of file SlateTest.php.

38  : C\MainControls\Slate\Slate
39  {
40  return $this;
41  }

The documentation for this class was generated from the following file: