ILIAS
trunk Revision v11.0_alpha-1811-gd2d5443e411
|
This describes commonalities between standard and primary buttons. More...
Public Member Functions | |
getLabel () | |
Get the label on the button. More... | |
withLabel (string $label) | |
Get a button like this, but with an additional/replaced label. More... | |
withSymbol (?Symbol $symbol) | |
Get a button like this with a symbol in its label. More... | |
getAction () | |
Get the action of the button, i.e. More... | |
isActive () | |
Get to know if the button is activated. More... | |
withUnavailableAction (bool $flag=true) | |
Get a button like this, but action should be unavailable atm. More... | |
withAriaLabel (string $aria_label) | |
Get a button like this, but with an additional/replaced aria-label. More... | |
getAriaLabel () | |
Get the aria-label on the button. More... | |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
withOnClick (Signal $signal) | |
Get a component like this, triggering a signal of another component on click. More... | |
appendOnClick (Signal $signal) | |
Get a component like this, triggering a signal of another component on click. More... | |
![]() | |
withResetTriggeredSignals () | |
Get a component like this but reset any triggered signals of other components. More... | |
getTriggeredSignals () | |
Get all triggered signals of this component. More... | |
![]() | |
withOnHover (Signal $signal) | |
Get a component like this, triggering a signal of another component on hover. More... | |
appendOnHover (Signal $signal) | |
Get a component like this, triggering a signal of another component on hover. More... | |
![]() | |
isEngageable () | |
Returns whether the button is stateful or not. More... | |
withEngagedState (bool $state) | |
Get a copy of the Engageable Button with engaged state for $state=true and with disengaged state for $state=false. More... | |
isEngaged () | |
Returns whether the button is currently engaged or not. More... | |
![]() | |
withHelpTopics (Topic ... $topics) | |
Let this component have the given topics. More... | |
withAdditionalHelpTopics (Topic ... $topics) | |
Let this component also have the given topics. More... | |
getHelpTopics () | |
This describes commonalities between standard and primary buttons.
Definition at line 33 of file Button.php.
ILIAS\UI\Component\Button\Button::getAction | ( | ) |
Get the action of the button, i.e.
an URL that the button links to or some signals the button triggers on click.
ILIAS\UI\Component\Button\Button::getAriaLabel | ( | ) |
Get the aria-label on the button.
ILIAS\UI\Component\Button\Button::getLabel | ( | ) |
Get the label on the button.
ILIAS\UI\Component\Button\Button::isActive | ( | ) |
Get to know if the button is activated.
ILIAS\UI\Component\Button\Button::withAriaLabel | ( | string | $aria_label | ) |
Get a button like this, but with an additional/replaced aria-label.
ILIAS\UI\Component\Button\Button::withLabel | ( | string | $label | ) |
Get a button like this, but with an additional/replaced label.
ILIAS\UI\Component\Button\Button::withSymbol | ( | ?Symbol | $symbol | ) |
Get a button like this with a symbol in its label.
ILIAS\UI\Component\Button\Button::withUnavailableAction | ( | bool | $flag = true | ) |
Get a button like this, but action should be unavailable atm.
The button will still have an action afterwards, this might be usefull at some point where we want to reactivate the button client side.
Referenced by ToggleButtonTest\testAppendUnavailAction().