info.magnolia.ui.api.app

Interface App

public interface App

Main interface for apps. Apps are started and managed by the AppController.

See Also:

AppDescriptor, AppController

Method Summary

Modifier and Type	Method and Description
AppView	getView()
void	locationChanged(Location location) Called when the location changes and the app is already running.
void	openChooseDialog(UiContext overlayLayer, String selectedId, ChooseDialogCallback callback) Open a dialog which enables a user to choose an item from the app.
void	openChooseDialog(UiContext uiContext, String targetTreeRootPath, String selectedId, ChooseDialogCallback callback)
void	start(Location location) Called when the app is started.
void	stop() Called when the user stops the app.

Method Detail

start

void start(Location location)

Called when the app is started. The location passed in is the location that triggered the app to be started.

Parameters:

location - the location that triggered the app to be started

locationChanged

void locationChanged(Location location)

Called when the location changes and the app is already running.

Parameters:

location - the new location

stop

void stop()

Called when the user stops the app.

getView

AppView getView()

openChooseDialog

void openChooseDialog(UiContext overlayLayer,
                      String selectedId,
                      ChooseDialogCallback callback)

Open a dialog which enables a user to choose an item from the app.

Parameters:

overlayLayer - The layer over which the opened dialog should be presented and be modal. See Shell, SubAppContext, AppContext.

callback -

openChooseDialog

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