ILIAS  trunk Revision v11.0_alpha-2638-g80c1d007f79
ILIAS\UI\Component\Modal\RoundTrip Interface Reference
+ Inheritance diagram for ILIAS\UI\Component\Modal\RoundTrip:
+ Collaboration diagram for ILIAS\UI\Component\Modal\RoundTrip:

Public Member Functions

 getTitle ()
 Get the title of the modal. More...
 
 getContent ()
 Get the components representing the content of the modal. More...
 
 getActionButtons ()
 Get all action buttons in the footer of the modal. More...
 
 getCancelButtonLabel ()
 Get the custom label of the cancel button in the footer. More...
 
 withActionButtons (array $buttons)
 Get a modal like this with the provided action buttons in the footer. More...
 
 withCancelButtonLabel (string $label)
 Get the modal like this with the provided cancel button string. More...
 
 getReplaceSignal ()
 Get the signal to replace the content of this modal. More...
 
 initSignals ()
 Init the default signals plus extra signals like Replace. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\Modal\Modal
 getAsyncRenderUrl ()
 Get the url returning the rendered modal, if the modals content should be rendered via ajax. More...
 
 withAsyncRenderUrl (string $url)
 Get a modal like this who's content is rendered via ajax by the given $url before the modal is shown. More...
 
 withCloseWithKeyboard (bool $state)
 Get a modal like this which can or cannot be closed by keyboard (ESC), depending on the given $state. More...
 
 getCloseWithKeyboard ()
 Returns if this modal can be closed with the keyboard (ESC key) More...
 
 getShowSignal ()
 Get the signal to show this modal in the frontend. More...
 
 getCloseSignal ()
 Get the signal to close this modal in the frontend. 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...
 
- 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\Triggerable
 withResetSignals ()
 Get a component like this but reset (regenerate) its signals. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\Onloadable
 withOnLoad (Signal $signal)
 Trigger a signal of another component on load. More...
 
 appendOnLoad (Signal $signal)
 Get a component like this, triggering a signal of another component on load. 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...
 
- Public Member Functions inherited from ILIAS\UI\Component\Closable
 withOnClose (Signal $signal)
 Get a component like this, triggering a signal of another component on close. More...
 
 appendOnClose (Signal $signal)
 Get a component like this, triggering a signal of another component on close. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\Button\Button
 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...
 
- Public Member Functions inherited from ILIAS\UI\Component\Clickable
 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...
 
- Public Member Functions inherited from ILIAS\UI\Component\Hoverable
 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...
 
- Public Member Functions inherited from ILIAS\UI\Component\Button\Engageable
 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...
 
- Public Member Functions inherited from ILIAS\UI\Component\HasHelpTopics
 withHelpTopics (Topic ... $topics)
 Let this component have the given topics. More...
 
 withAdditionalHelpTopics (Topic ... $topics)
 Let this component also have the given topics. More...
 
 getHelpTopics ()
 
- Public Member Functions inherited from ILIAS\UI\Component\Button\LoadingAnimationOnClick
 withLoadingAnimationOnClick (bool $loading_animation_on_click)
 If clicked the button will display a spinner wheel to show that a request is being processed in the background. More...
 
 hasLoadingAnimationOnClick ()
 Return whether loading animation has been activated. More...
 

Detailed Description

Definition at line 29 of file RoundTrip.php.

Member Function Documentation

◆ getActionButtons()

ILIAS\UI\Component\Modal\RoundTrip::getActionButtons ( )

Get all action buttons in the footer of the modal.

Returns
Button[]

Implemented in ILIAS\UI\Implementation\Component\Dropzone\File\File, and ILIAS\UI\Implementation\Component\Modal\RoundTrip.

◆ getCancelButtonLabel()

ILIAS\UI\Component\Modal\RoundTrip::getCancelButtonLabel ( )

Get the custom label of the cancel button in the footer.

Implemented in ILIAS\UI\Implementation\Component\Dropzone\File\File, and ILIAS\UI\Implementation\Component\Modal\RoundTrip.

◆ getContent()

ILIAS\UI\Component\Modal\RoundTrip::getContent ( )

◆ getReplaceSignal()

ILIAS\UI\Component\Modal\RoundTrip::getReplaceSignal ( )

Get the signal to replace the content of this modal.

Implemented in ILIAS\UI\Implementation\Component\Dropzone\File\File, and ILIAS\UI\Implementation\Component\Modal\RoundTrip.

◆ getTitle()

ILIAS\UI\Component\Modal\RoundTrip::getTitle ( )

◆ initSignals()

ILIAS\UI\Component\Modal\RoundTrip::initSignals ( )

Init the default signals plus extra signals like Replace.

Implemented in ILIAS\UI\Implementation\Component\Dropzone\File\File, and ILIAS\UI\Implementation\Component\Modal\RoundTrip.

◆ withActionButtons()

ILIAS\UI\Component\Modal\RoundTrip::withActionButtons ( array  $buttons)

Get a modal like this with the provided action buttons in the footer.

Note that the footer always contains a cancel button closing the modal as last button in the footer (on the right).

Parameters
Button

Implemented in ILIAS\UI\Implementation\Component\Dropzone\File\File, and ILIAS\UI\Implementation\Component\Modal\RoundTrip.

◆ withCancelButtonLabel()

ILIAS\UI\Component\Modal\RoundTrip::withCancelButtonLabel ( string  $label)

Get the modal like this with the provided cancel button string.

The closing button has "Cancel" by default

Implemented in ILIAS\UI\Implementation\Component\Dropzone\File\File, and ILIAS\UI\Implementation\Component\Modal\RoundTrip.


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