info.magnolia.ui.api.app
Interface AppContext

All Superinterfaces:

AppView.Listener, OverlayLayer, UiContext

All Known Subinterfaces:

AppInstanceController

All Known Implementing Classes:

AppInstanceControllerImpl

public interface AppContext
extends AppView.Listener, UiContext

Provides functionality used by an app to interact with the Magnolia shell.

Nested Class Summary

Nested classes/interfaces inherited from interface info.magnolia.ui.api.overlay.OverlayLayer

OverlayLayer.ModalityDomain, OverlayLayer.ModalityLevel

Method Summary

void	broadcastMessage(Message message)
void	closeSubApp(String instanceId)
SubAppContext	getActiveSubAppContext()
AppDescriptor	getAppDescriptor()
SubAppDescriptor	getDefaultSubAppDescriptor()
String	getLabel()
String	getName()
AppView	getView()
void	openSubApp(Location location)
void	sendGroupMessage(String group, Message message)
void	sendLocalMessage(Message message)
void	sendUserMessage(String user, Message message)
void	showConfirmationMessage(String message)
void	updateSubAppLocation(SubAppContext subAppContext, Location location)

Methods inherited from interface info.magnolia.ui.api.app.AppView.Listener

onClose, onFocus

Methods inherited from interface info.magnolia.ui.api.overlay.OverlayLayer

openAlert, openAlert, openConfirmation, openConfirmation, openNotification, openNotification, openNotification, openOverlay, openOverlay

Method Detail

sendUserMessage

void sendUserMessage(String user,
                     Message message)

sendGroupMessage

void sendGroupMessage(String group,
                      Message message)

sendLocalMessage

void sendLocalMessage(Message message)

broadcastMessage

void broadcastMessage(Message message)

showConfirmationMessage

void showConfirmationMessage(String message)

getName

String getName()

getLabel

String getLabel()

getView

AppView getView()

openSubApp

void openSubApp(Location location)

closeSubApp

void closeSubApp(String instanceId)

updateSubAppLocation

void updateSubAppLocation(SubAppContext subAppContext,
                          Location location)

getDefaultSubAppDescriptor

SubAppDescriptor getDefaultSubAppDescriptor()

getActiveSubAppContext

SubAppContext getActiveSubAppContext()

getAppDescriptor

AppDescriptor getAppDescriptor()