ILIAS\UI\Component\Item\Standard Interface Reference
Inheritance diagram for ILIAS\UI\Component\Item\Standard:
Collaboration diagram for ILIAS\UI\Component\Item\Standard:
Public Member Functions | |
| withColor (Color $color) | |
| Set a color. More... | |
| getColor () | |
| Return the given color. More... | |
| withLeadImage (Image $image) | |
| Set image as lead. More... | |
| withAudioPlayer (Audio $audio) | |
| Set audio player. More... | |
| withLeadIcon (Icon $icon) | |
| Set icon as lead. More... | |
| withLeadAvatar (Avatar $avatar) | |
| Set avatar as lead. More... | |
| withLeadText (string $text) | |
| Set image as lead. More... | |
| withNoLead () | |
| Reset lead to null. More... | |
| getLead () | |
| getAudioPlayer () | |
| withProgress (ProgressMeter $chart) | |
| Set progress meter chart. More... | |
| getProgress () | |
| withActions (DropdownStandard $actions) | |
| Create a new appointment item with a set of actions to perform on it. More... | |
| getActions () | |
| Get the actions of the item. More... | |
| withMainAction (ButtonStandard|LinkStandard $button) | |
| getMainAction () | |
| Public Member Functions inherited from ILIAS\UI\Component\Item\Item | |
| getTitle () | |
| Gets the title of the item. More... | |
| withDescription (string $description) | |
| Create a new item with an attached description. More... | |
| getDescription () | |
| Get the description of the item. More... | |
| withProperties (array $properties) | |
| Get a new item with the given properties as key-value pairs. More... | |
| getProperties () | |
| Get the properties of the appointment. 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
Definition at line 37 of file Standard.php.
Member Function Documentation
◆ getActions()
| ILIAS\UI\Component\Item\Standard::getActions | ( | ) |
Get the actions of the item.
◆ getAudioPlayer()
| ILIAS\UI\Component\Item\Standard::getAudioPlayer | ( | ) |
◆ getColor()
| ILIAS\UI\Component\Item\Standard::getColor | ( | ) |
Return the given color.
◆ getLead()
| ILIAS\UI\Component\Item\Standard::getLead | ( | ) |
- Returns
- null|string|Image|Icon|Avatar
◆ getMainAction()
| ILIAS\UI\Component\Item\Standard::getMainAction | ( | ) |
◆ getProgress()
| ILIAS\UI\Component\Item\Standard::getProgress | ( | ) |
◆ withActions()
| ILIAS\UI\Component\Item\Standard::withActions | ( | DropdownStandard | $actions | ) |
Create a new appointment item with a set of actions to perform on it.
◆ withAudioPlayer()
| ILIAS\UI\Component\Item\Standard::withAudioPlayer | ( | Audio | $audio | ) |
Set audio player.
◆ withColor()
| ILIAS\UI\Component\Item\Standard::withColor | ( | Color | $color | ) |
Set a color.
◆ withLeadAvatar()
| ILIAS\UI\Component\Item\Standard::withLeadAvatar | ( | Avatar | $avatar | ) |
Set avatar as lead.
◆ withLeadIcon()
| ILIAS\UI\Component\Item\Standard::withLeadIcon | ( | Icon | $icon | ) |
Set icon as lead.
◆ withLeadImage()
| ILIAS\UI\Component\Item\Standard::withLeadImage | ( | Image | $image | ) |
Set image as lead.
◆ withLeadText()
| ILIAS\UI\Component\Item\Standard::withLeadText | ( | string | $text | ) |
Set image as lead.
◆ withMainAction()
| ILIAS\UI\Component\Item\Standard::withMainAction | ( | ButtonStandard|LinkStandard | $button | ) |
◆ withNoLead()
| ILIAS\UI\Component\Item\Standard::withNoLead | ( | ) |
Reset lead to null.
◆ withProgress()
| ILIAS\UI\Component\Item\Standard::withProgress | ( | ProgressMeter | $chart | ) |
Set progress meter chart.
The documentation for this interface was generated from the following file:
- components/ILIAS/UI/src/Component/Item/Standard.php
