Page History

...

The key interfaces are: App AppController AppContext SubAppContext.

...

• According to Concept - Alternative ui-project organisation
  
  • move the package info.magnolia.ui.admincentral.app.simple into module magnolia-ui-framework e.g. info.magnolia.ui.framework.app.api (NOTE: this contradicts decision made for shell apps, see further down)
  • or jus out of the simple subpackage
• info.magnolia.ui.admincentral.app.simple.AppContextImpl
  • general problem: used heavily by the appController and also for the app itself to get contextual information: serving two needs. see http://jira.magnolia-cms.com/browse/MGNLUI-403
    

    • The idea of AppContext is to expose functionality to the App. That is, to an instance of an app.

      It should not expose methods that are only used by AppControllerImpl. These should be hidden from all other classes.

      If necessary AppControllerImpl#runningApps should be changed to <String, AppContextImpl>. Also if the intention of AppContextImpl is unclear it should be renamed to reflect the fact that is not just the default implementation of AppContext, it does much more and in fact fullfils much of the contract defined by AppController.

    • rename the AppController to AppLauncher or similar, introduce a new AppController class which takes care of the contract to the AppLauncher and keep the AppContext as thin as possible, only serving contextual information to the actual App
      
    • Move some of the functionality of AppContext into the info.magnolia.ui.framework.app.launcherlayout.AppLauncherGroupEntry
      • info.magnolia.ui.admincentral.app.simple.AppContextImpl#getDefaultSubAppDescriptor
      • info.magnolia.ui.admincentral.app.simple.AppContextImpl#getSubAppDescriptorById

AppController

...

interface seems fine

...

UML Diagram

App Framework

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 {@link App}s.
Registers handlers to the following location change events triggered by the {@link LocationController}:

• LocationChangedEvent
• LocationChangeRequestedEvent

Usages:

• The AppController takes care of LocationChangedEvents coming from info.magnolia.ui.admincentral.app.simple.AppControllerImpl#onLocationChanged which can for example be fired by the info.magnolia.ui.framework.location.LocationController#goTo when clicking on icon in the AppLauncher. It takes the Location passed and extracts AppName and subAppId and gets the corresponding AppDescriptor from the info.magnolia.ui.framework.app.launcherlayout.AppLauncherLayoutManager.
• It creates a new AppContext for the App
• keeps history of running app and currently focused app
• used by the MagnoliaShell to query the current Status of the appController
• Used by FieldBuilders to get the AppContext and ComponentProviders for opening ChooseDialogs.

Actions

The AppController is in general in a good shape. Interface is well defined and usages are legit.

Some technical ideas and questions

general question:
usage of FocusEvent: seems to not be used consistently. Could also be extended to get rid of the setViewPort and associated calls

...

info.magnolia.ui.admincentral.app.simple.AppControllerImpl#onLocationChanged
too heavy, should delegate to methods rather, see focusEvent

AppContext

Shell Apps

Q: Do we plan any improvements here?

...

UML Diagrams

AppContextImpl.pngAppControllerImpl.png