Package com.morpheusdata.core.providers

Interface GlobalUIComponentProvider

All Superinterfaces:

PluginProvider, UIExtensionProvider

All Known Subinterfaces:

GlobalUIComponentProvider

All Known Implementing Classes:

AbstractGlobalUIComponentProvider

public interface GlobalUIComponentProvider
extends UIExtensionProvider

This provider creates a means to render global components into the main layout of Morpheus. This could be a global chat component or other type of overlay code that one might want to run throughout the entire application render lifecycle. It extends the common UIExtensionProvider which allows for extending available content security policies as well as defining the type of renderer being used.

Since:

0.8.0

See Also:

• UIExtensionProvider

Method Summary

Modifier and Type	Method	Description
HTMLResponse	renderTemplate(User user, Account account)	The renderer for the global UI Component.
Boolean	show(User user, Account account)	Provides logic to check for when this global ui component should be displayed

Methods inherited from interface com.morpheusdata.core.providers.PluginProvider

getCode, getMorpheus, getName, getPlugin, isPlugin

Methods inherited from interface com.morpheusdata.core.providers.UIExtensionProvider

getContentSecurityPolicy, getRenderer

Method Details

show

Boolean show(User user,
 Account account)

Provides logic to check for when this global ui component should be displayed

Parameters:

user - current User details

account - Account details

Returns:

whether the component should be displayed

renderTemplate

HTMLResponse renderTemplate(User user,
 Account account)

The renderer for the global UI Component. This is typically rendered into the footer of the main layout. This is useful for rendering common components like a global support chat.

Parameters:

user - The current user the page is being rendered for.

account - The current account the page is being rendered for.

Returns:

result of rendering a template