info.magnolia.ui.framework.app

Class AppControllerImpl

java.lang.Object

info.magnolia.ui.framework.app.AppControllerImpl

All Implemented Interfaces:

info.magnolia.event.EventHandler, AppController, LocationChangedEvent.Handler, LocationChangeRequestedEvent.Handler, CloseAppEvent.Handler

public class AppControllerImpl
extends Object
implements AppController, LocationChangedEvent.Handler, LocationChangeRequestedEvent.Handler, CloseAppEvent.Handler

Implementation of the AppController. The App controller that manages the lifecycle of running apps and raises callbacks to the app. It provides methods to start, stop and focus already running Apps. Registers handlers to the following location change events triggered by the LocationController:

• LocationChangedEvent
• LocationChangeRequestedEvent

See Also:

LocationController, AppContext, App

Constructor Summary

Constructors

Constructor and Description
AppControllerImpl(info.magnolia.objectfactory.ComponentProvider componentProvider, AppDescriptorRegistry appDescriptorRegistry, LocationController locationController, info.magnolia.event.EventBus admincentralEventBus, MessagesManager messagesManager, info.magnolia.i18nsystem.SimpleTranslator i18n) Deprecated. since 6.0 - use AppControllerImpl(ComponentProvider, AppDescriptorRegistry, LocationController, EventBus, MessagesManager, SimpleTranslator, Context) instead.
AppControllerImpl(info.magnolia.objectfactory.ComponentProvider componentProvider, AppDescriptorRegistry appDescriptorRegistry, LocationController locationController, info.magnolia.event.EventBus admincentralEventBus, MessagesManager messagesManager, info.magnolia.i18nsystem.SimpleTranslator i18n, info.magnolia.context.Context context) Deprecated. since 6.2.7. Use AppControllerImpl(info.magnolia.objectfactory.ComponentProvider, info.magnolia.ui.api.app.registry.AppDescriptorRegistry, info.magnolia.ui.api.location.LocationController, info.magnolia.event.EventBus, info.magnolia.ui.framework.message.MessagesManager, info.magnolia.i18nsystem.SimpleTranslator, info.magnolia.context.Context, com.vaadin.ui.UI, info.magnolia.init.MagnoliaConfigurationProperties) instead.

Method Summary

Modifier and Type	Method and Description
void	focusCurrentApp()
Location	getAppLocation(String appName) Returns the current location of a running app instance or null, if it is not running.
App	getCurrentApp()
Optional<AppContext>	getCurrentAppContext() Return instance controller of the app currently visible to the user.
Location	getCurrentAppLocation() Returns the current location of the focused app.
Map<String,AppContext>	getRunningApps() Return the list of all running apps.
boolean	isAppStarted(String appName)
void	onCloseApp(CloseAppEvent event)
void	onLocationChanged(LocationChangedEvent event) Takes care of LocationChangedEvents by: Obtaining the AppDescriptor associated with the Location. Creating a new AppContext if not running, otherwise obtain it from the running apps. Updating the and redirecting in case of missing subAppId. Starting the App. Adding the AppContext to the appHistory. Setting the viewport and updating the current running app.
void	onLocationChangeRequested(LocationChangeRequestedEvent event)
void	openChooseDialog(String appName, UiContext uiContext, String selectedId, ChooseDialogCallback callback)
void	openChooseDialog(String appName, UiContext uiContext, String targetTreeRootPath, String selectedId, ChooseDialogCallback callback)
void	setViewport(Viewport viewport)
App	startIfNotAlreadyRunningThenFocus(String appName, Location location) This method can be called to launch an App and then delegate it to the LocationController.
void	stopApp(String appName)
void	stopCurrentApp()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AppControllerImpl

@Deprecated
public AppControllerImpl(info.magnolia.objectfactory.ComponentProvider componentProvider,
                                     AppDescriptorRegistry appDescriptorRegistry,
                                     LocationController locationController,
                                     @Named(value="admincentral")
                                     info.magnolia.event.EventBus admincentralEventBus,
                                     MessagesManager messagesManager,
                                     info.magnolia.i18nsystem.SimpleTranslator i18n,
                                     info.magnolia.context.Context context)

Deprecated. since 6.2.7. Use AppControllerImpl(info.magnolia.objectfactory.ComponentProvider, info.magnolia.ui.api.app.registry.AppDescriptorRegistry, info.magnolia.ui.api.location.LocationController, info.magnolia.event.EventBus, info.magnolia.ui.framework.message.MessagesManager, info.magnolia.i18nsystem.SimpleTranslator, info.magnolia.context.Context, com.vaadin.ui.UI, info.magnolia.init.MagnoliaConfigurationProperties) instead.

AppControllerImpl

@Deprecated
public AppControllerImpl(info.magnolia.objectfactory.ComponentProvider componentProvider,
                                     AppDescriptorRegistry appDescriptorRegistry,
                                     LocationController locationController,
                                     @Named(value="admincentral")
                                     info.magnolia.event.EventBus admincentralEventBus,
                                     MessagesManager messagesManager,
                                     info.magnolia.i18nsystem.SimpleTranslator i18n)

Deprecated. since 6.0 - use AppControllerImpl(ComponentProvider, AppDescriptorRegistry, LocationController, EventBus, MessagesManager, SimpleTranslator, Context) instead.

Method Detail

setViewport

public void setViewport(Viewport viewport)

Specified by:

setViewport in interface AppController

onCloseApp

public void onCloseApp(CloseAppEvent event)

Specified by:

onCloseApp in interface CloseAppEvent.Handler

startIfNotAlreadyRunningThenFocus

public App startIfNotAlreadyRunningThenFocus(String appName,
                                             Location location)

This method can be called to launch an App and then delegate it to the LocationController. It should have the same effect as calling the LocationController directly.

Parameters:

appName - of the App to start.

location - holds information about the subApp to use and the parameters.

stopApp

public void stopApp(String appName)

Specified by:

stopApp in interface AppController

stopCurrentApp

public void stopCurrentApp()

Specified by:

stopCurrentApp in interface AppController

isAppStarted

public boolean isAppStarted(String appName)

Specified by:

isAppStarted in interface AppController

focusCurrentApp

public void focusCurrentApp()

Specified by:

focusCurrentApp in interface AppController

getCurrentApp

public App getCurrentApp()

Specified by:

getCurrentApp in interface AppController

getCurrentAppLocation

public Location getCurrentAppLocation()

Returns the current location of the focused app. This can differ from the actual location of the admin central, e.g. when a shell app is open.

Specified by:

getCurrentAppLocation in interface AppController

See Also:

LocationController.getWhere()

getAppLocation

public Location getAppLocation(String appName)

Returns the current location of a running app instance or null, if it is not running. The App does not have to be focused.

Specified by:

getAppLocation in interface AppController

onLocationChanged

public void onLocationChanged(LocationChangedEvent event)

Takes care of LocationChangedEvents by:

• Obtaining the AppDescriptor associated with the Location.
• Creating a new AppContext if not running, otherwise obtain it from the running apps.
• Updating the and redirecting in case of missing subAppId.
• Starting the App.
• Adding the AppContext to the appHistory.
• Setting the viewport and updating the current running app.

Specified by:

onLocationChanged in interface LocationChangedEvent.Handler

onLocationChangeRequested

public void onLocationChangeRequested(LocationChangeRequestedEvent event)

Specified by:

onLocationChangeRequested in interface LocationChangeRequestedEvent.Handler

openChooseDialog

public void openChooseDialog(String appName,
                             UiContext uiContext,
                             String selectedId,
                             ChooseDialogCallback callback)

Specified by:

openChooseDialog in interface AppController

See Also:

Upgrading to Magnolia 6.2.x

openChooseDialog

public void openChooseDialog(String appName,
                             UiContext uiContext,
                             String targetTreeRootPath,
                             String selectedId,
                             ChooseDialogCallback callback)

Specified by:

openChooseDialog in interface AppController

See Also:

Upgrading to Magnolia 6.2.x

getCurrentAppContext

public Optional<AppContext> getCurrentAppContext()

Description copied from interface: AppController

Return instance controller of the app currently visible to the user.

Specified by:

getCurrentAppContext in interface AppController

getRunningApps

public Map<String,AppContext> getRunningApps()

Description copied from interface: AppController

Return the list of all running apps.

Specified by:

getRunningApps in interface AppController