info.magnolia.ui.framework.app

Class BaseSubApp<V extends View>

java.lang.Object

info.magnolia.ui.framework.app.BaseSubApp<V>

Type Parameters:

V - View implementation used by subApp.

All Implemented Interfaces:

SubApp, View, Destructible, UIComponent, Serializable

Direct Known Subclasses:

AboutMainSubApp, AbstractDetailSubApp, BrowserSubApp, ConfigInfoSubApp, ContentBrowserSubApp, DetailSubApp, EmbeddedPageSubApp, FailedSubAppStub, LicensesInfoSubApp, MessagesMainSubApp, SampleEditorSubApp, SampleMainSubApp, ToolsSubApp

public class BaseSubApp<V extends View>
extends Object
implements SubApp, UIComponent

Basic implementation of a subApp with default behavior suitable for most sub apps.

See Also:

SubApp, Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseSubApp(SubAppContext subAppContext, V view)

Method Summary

Modifier and Type	Method and Description
void	destroy() Cleans up the related bean store, detaches the from the parent Vaadin component, recursively destroys the child views.
AppContext	getAppContext()
String	getCaption() This method will try to determine the current sub app caption, the one usually displayed in the tab where the subapp opens.
protected Location	getCurrentLocation()
UiContextReference	getCurrentViewReference()
String	getIcon(Location location)
SubAppContext	getSubAppContext()
String	getSubAppId()
V	getView()
boolean	isCloseable()
void	locationChanged(Location location)
protected void	onSubAppStart() This hook-up method is called on start(info.magnolia.ui.api.location.Location) and enables subclasses to perform additional work before the view is displayed.
protected void	onSubAppStop() This hook-up method is called on stop() and enables subclasses to perform additional work when stopping the subApp.
V	start(Location location)
void	stop()
boolean	supportsLocation(Location location) This method is being called by the AppController when iterating over opened subApps.

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.magnolia.ui.UIComponent

accessViewBeanStore, asVaadinComponent, bindContext, bindInstance, create, create, create, create, getComponentProvider

Constructor Detail

BaseSubApp

protected BaseSubApp(SubAppContext subAppContext,
                     V view)

Method Detail

start

public V start(Location location)

Specified by:

start in interface SubApp

stop

public void stop()

Specified by:

stop in interface SubApp

locationChanged

public void locationChanged(Location location)

Specified by:

locationChanged in interface SubApp

supportsLocation

public boolean supportsLocation(Location location)

This method is being called by the AppController when iterating over opened subApps. The subApp itself decides whether it supports the current location based on parameters or whether the appController should launch a new instance of the subApp.

Specified by:

supportsLocation in interface SubApp

getCurrentViewReference

public UiContextReference getCurrentViewReference()

Specified by:

getCurrentViewReference in interface UIComponent

onSubAppStart

protected void onSubAppStart()

This hook-up method is called on start(info.magnolia.ui.api.location.Location) and enables subclasses to perform additional work before the view is displayed. The default implementation does nothing.

onSubAppStop

protected void onSubAppStop()

This hook-up method is called on stop() and enables subclasses to perform additional work when stopping the subApp. The default implementation does nothing.

getSubAppContext

public SubAppContext getSubAppContext()

getSubAppId

public String getSubAppId()

Specified by:

getSubAppId in interface SubApp

getView

public V getView()

Specified by:

getView in interface SubApp

getAppContext

public AppContext getAppContext()

getCaption

public String getCaption()

This method will try to determine the current sub app caption, the one usually displayed in the tab where the subapp opens.

Specified by:

getCaption in interface SubApp

Returns:

the configured label for this subapp. If no label is found in the subapp configuration, it will try to use the label from the parent app. If the latter is missing too, it will return an empty string.

getCurrentLocation

protected Location getCurrentLocation()

isCloseable

public boolean isCloseable()

Specified by:

isCloseable in interface SubApp

getIcon

public String getIcon(Location location)

Specified by:

getIcon in interface SubApp

destroy

public void destroy()

Description copied from interface: UIComponent

Cleans up the related bean store, detaches the from the parent Vaadin component, recursively destroys the child views.

Specified by:

destroy in interface Destructible

Specified by:

destroy in interface UIComponent