info.magnolia.ui.contentapp.browser

Class BrowserSubApp

java.lang.Object

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

info.magnolia.ui.contentapp.browser.BrowserSubApp

All Implemented Interfaces:

info.magnolia.ui.api.app.SubApp

public class BrowserSubApp
extends info.magnolia.ui.framework.app.BaseSubApp<ContentSubAppView>

Base implementation of a content subApp. A content subApp displays a collection of data represented inside a ContentView created by the WorkbenchPresenter.

  

      This class Provides sensible implementation for services shared by all content subApps.
      Out-of-the-box it will handle the following:
  

  

      
location updates when switching views, selecting items or performing searches: see locationChanged(Location)
      
restoring the browser app status when i.e. coming from a bookmark: see start(Location)
  
 In order to perform those tasks this class registers non-overridable handlers for the following events:
  

      
 SelectionChangedEvent
      
 ViewTypeChangedEvent
      
 SearchEvent
  
 Subclasses can augment the default behavior and perform additional tasks by overriding the following methods:
  

      
BaseSubApp.onSubAppStart()
      
locationChanged(Location)
      
updateActionbar(ActionbarPresenter)
  
 

See Also:

BrowserPresenter, ContentSubAppView, ContentApp, BrowserLocation

Field Summary

Fields

Modifier and Type	Field and Description
protected info.magnolia.ui.vaadin.integration.contentconnector.ContentConnector	contentConnector

Constructor Summary

Constructors

Constructor and Description

BrowserSubApp(info.magnolia.ui.api.action.ActionExecutor actionExecutor, info.magnolia.ui.api.app.SubAppContext subAppContext, ContentSubAppView view, BrowserPresenter browser, info.magnolia.event.EventBus subAppEventBus, info.magnolia.event.EventBus adminCentralEventBus, info.magnolia.ui.vaadin.integration.contentconnector.ContentConnector contentConnector, info.magnolia.ui.api.availability.AvailabilityChecker checker)

Method Summary

Modifier and Type	Method and Description
protected void	applySelectionToLocation(BrowserLocation location, Object selectedId)
protected BrowserPresenter	getBrowser()
BrowserLocation	getCurrentLocation() Wraps the current DefaultLocation in a BrowserLocation.
void	locationChanged(info.magnolia.ui.api.location.Location location) The default implementation selects the path in the current workspace and updates the available actions in the actionbar.
protected void	restoreBrowser(BrowserLocation location) Restores the browser status based on the information available in the location object.
void	showActionPopup(Object itemId, int x, int y) Show the actionPopup for the specified item at the specified coordinates.
ContentSubAppView	start(info.magnolia.ui.api.location.Location location) Performs some routine tasks needed by all content subapps before the view is displayed.
void	updateActionbar(info.magnolia.ui.actionbar.ActionbarPresenter actionbar) Update the items in the actionbar based on the selected item and the action availability configuration.

Methods inherited from class info.magnolia.ui.framework.app.BaseSubApp

getAppContext, getCaption, getSubAppContext, getSubAppId, getView, isCloseable, onSubAppStart, onSubAppStop, stop, supportsLocation

Methods inherited from class java.lang.Object

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

Field Detail

contentConnector

protected info.magnolia.ui.vaadin.integration.contentconnector.ContentConnector contentConnector

Constructor Detail

BrowserSubApp

@Inject
public BrowserSubApp(info.magnolia.ui.api.action.ActionExecutor actionExecutor,
                             info.magnolia.ui.api.app.SubAppContext subAppContext,
                             ContentSubAppView view,
                             BrowserPresenter browser,
                             @Named(value="subapp")
                             info.magnolia.event.EventBus subAppEventBus,
                             @Named(value="admincentral")
                             info.magnolia.event.EventBus adminCentralEventBus,
                             info.magnolia.ui.vaadin.integration.contentconnector.ContentConnector contentConnector,
                             info.magnolia.ui.api.availability.AvailabilityChecker checker)

Method Detail

start

public ContentSubAppView start(info.magnolia.ui.api.location.Location location)

Performs some routine tasks needed by all content subapps before the view is displayed. The tasks are:

• setting the current location
• setting the browser view
• restoring the browser status: see restoreBrowser(BrowserLocation)
• calling BaseSubApp.onSubAppStart() a hook-up method subclasses can override to perform additional work.

Specified by:

start in interface info.magnolia.ui.api.app.SubApp

Overrides:

start in class info.magnolia.ui.framework.app.BaseSubApp<ContentSubAppView>

restoreBrowser

protected void restoreBrowser(BrowserLocation location)

Restores the browser status based on the information available in the location object. This is used e.g. when starting a subapp based on a bookmark. I.e. given a bookmark containing the following URI fragment

#app:myapp:browser;/foo/bar:list

this method will select the path /foo/bar in the workspace used by the app, set the view type as list and finally update the available actions.

In case of a search view the URI fragment will look similar to the following one #app:myapp:browser;/:search:qux

then this method will select the root path, set the view type as search, perform a search for "qux" in the workspace used by the app and finally update the available actions.

See Also:

updateActionbar(info.magnolia.ui.actionbar.ActionbarPresenter), start(Location), Location

showActionPopup

public void showActionPopup(Object itemId,
                            int x,
                            int y)

Show the actionPopup for the specified item at the specified coordinates.

updateActionbar

public void updateActionbar(info.magnolia.ui.actionbar.ActionbarPresenter actionbar)

Update the items in the actionbar based on the selected item and the action availability configuration. This method can be overriden to implement custom conditions diverging from updateActionPopup(info.magnolia.ui.vaadin.actionbar.ActionPopup).

See Also:

restoreBrowser(BrowserLocation), locationChanged(Location), ActionbarPresenter

getBrowser

protected final BrowserPresenter getBrowser()

locationChanged

public void locationChanged(info.magnolia.ui.api.location.Location location)

The default implementation selects the path in the current workspace and updates the available actions in the actionbar.

Specified by:

locationChanged in interface info.magnolia.ui.api.app.SubApp

Overrides:

locationChanged in class info.magnolia.ui.framework.app.BaseSubApp<ContentSubAppView>

getCurrentLocation

public BrowserLocation getCurrentLocation()

Wraps the current DefaultLocation in a BrowserLocation. Providing getter and setters for used parameters.

Overrides:

getCurrentLocation in class info.magnolia.ui.framework.app.BaseSubApp<ContentSubAppView>

applySelectionToLocation

protected void applySelectionToLocation(BrowserLocation location,
                                        Object selectedId)