info.magnolia.pages.app.editor

Class PagesEditorSubApp

java.lang.Object

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

info.magnolia.pages.app.editor.PagesEditorSubApp

All Implemented Interfaces:

PagesEditorSubAppView.Listener, info.magnolia.ui.actionbar.ActionbarPresenter.Listener, info.magnolia.ui.api.app.SubApp

public class PagesEditorSubApp
extends info.magnolia.ui.framework.app.BaseSubApp<PagesEditorSubAppView>
implements PagesEditorSubAppView.Listener, info.magnolia.ui.actionbar.ActionbarPresenter.Listener

SubApp putting together:

• PageEditorPresenter
• ActionbarPresenter
• StatusBarPresenter
• PageBarPresenter

Keeps track on changes coming from the client side of the PageEditorPresenter by registering a NodeSelectedEvent.Handler to the subApp eventbus. This is triggered every time the PageElement, AreaElement or ComponentElement is selected inside the iFrame. This will result in updating the ActionbarPresenter accordingly using action availability.
When a page change happens, e.g. the user browses inside the iFrame, this will also be detected and trigger a chain of actions taking care of updating all necessary parts of the UI as well as the underlying framework.

Constructor Summary

Constructors

Constructor and Description
PagesEditorSubApp(info.magnolia.ui.api.action.ActionExecutor actionExecutor, info.magnolia.ui.api.app.SubAppContext subAppContext, PagesEditorSubAppView view, info.magnolia.event.EventBus admincentralEventBus, info.magnolia.event.EventBus subAppEventBus, PageEditorPresenter pageEditorPresenter, info.magnolia.ui.actionbar.ActionbarPresenter actionbarPresenter, info.magnolia.ui.vaadin.editor.pagebar.PageBarView pageBarView, info.magnolia.ui.api.i18n.I18NAuthoringSupport i18NAuthoringSupport, info.magnolia.cms.i18n.I18nContentSupport i18nContentSupport, info.magnolia.cms.core.version.VersionManager versionManager, info.magnolia.i18nsystem.SimpleTranslator i18n, info.magnolia.ui.api.availability.AvailabilityChecker availabilityChecker, info.magnolia.ui.vaadin.integration.contentconnector.ContentConnector contentConnector, info.magnolia.ui.workbench.StatusBarView statusBarView) Deprecated. since 5.4 - use PagesEditorSubApp(ActionExecutor, SubAppContext, PagesEditorSubAppView, EventBus, EventBus, PageEditorPresenter, ActionbarPresenter, SimpleTranslator, AvailabilityChecker, PagesContentConnector, StatusBarPresenter, PageBarPresenter)
PagesEditorSubApp(info.magnolia.ui.api.action.ActionExecutor actionExecutor, info.magnolia.ui.api.app.SubAppContext subAppContext, PagesEditorSubAppView view, info.magnolia.event.EventBus admincentralEventBus, info.magnolia.event.EventBus subAppEventBus, PageEditorPresenter pageEditorPresenter, info.magnolia.ui.actionbar.ActionbarPresenter actionbarPresenter, info.magnolia.i18nsystem.SimpleTranslator i18n, info.magnolia.ui.api.availability.AvailabilityChecker availabilityChecker, PagesContentConnector contentConnector, StatusBarPresenter statusBar, PageBarPresenter pageBar)
PagesEditorSubApp(info.magnolia.ui.api.action.ActionExecutor actionExecutor, info.magnolia.ui.api.app.SubAppContext subAppContext, PagesEditorSubAppView view, info.magnolia.event.EventBus admincentralEventBus, info.magnolia.event.EventBus subAppEventBus, PageEditorPresenter pageEditorPresenter, info.magnolia.ui.actionbar.ActionbarPresenter actionbarPresenter, info.magnolia.cms.core.version.VersionManager versionManager, info.magnolia.i18nsystem.SimpleTranslator i18n, info.magnolia.ui.api.availability.AvailabilityChecker availabilityChecker, info.magnolia.ui.vaadin.integration.contentconnector.ContentConnector contentConnector, StatusBarPresenter statusBar, PageBarPresenter pageBar) Deprecated. since 5.5 - use PagesEditorSubApp(ActionExecutor, SubAppContext, PagesEditorSubAppView, EventBus, EventBus, PageEditorPresenter, ActionbarPresenter, SimpleTranslator, AvailabilityChecker, PagesContentConnector, StatusBarPresenter, PageBarPresenter)

Method Summary

Modifier and Type	Method and Description
void	deactivateComponents()
String	getCaption()
info.magnolia.ui.contentapp.detail.DetailLocation	getCurrentLocation() Wraps the current DefaultLocation in a DetailLocation.
protected String	getWorkspace() Deprecated. since 5.4.2 - Use contentConnector directly.
void	locationChanged(info.magnolia.ui.api.location.Location location)
void	onActionbarItemClicked(String actionName)
void	onEscape()
void	onMove()
protected void	prepareAndExecutePagesEditorAction(String actionName) Used for executing actions from the actionbar.
PagesEditorSubAppView	start(info.magnolia.ui.api.location.Location location)
void	stop()
boolean	supportsLocation(info.magnolia.ui.api.location.Location location)
void	updateActionbar()
void	updateCaption(info.magnolia.ui.contentapp.detail.DetailLocation location)
void	updateCaptionForExternalPage(String title)
protected void	updateNodePath(String path) Informs the app framework when navigating pages inside the page editor.

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

getAppContext, getSubAppContext, getSubAppId, getView, isCloseable, onSubAppStart, onSubAppStop

Methods inherited from class java.lang.Object

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

Constructor Detail

PagesEditorSubApp

@Inject
public PagesEditorSubApp(info.magnolia.ui.api.action.ActionExecutor actionExecutor,
                                 info.magnolia.ui.api.app.SubAppContext subAppContext,
                                 PagesEditorSubAppView view,
                                 @Named(value="admincentral")
                                 info.magnolia.event.EventBus admincentralEventBus,
                                 @Named(value="subapp")
                                 info.magnolia.event.EventBus subAppEventBus,
                                 PageEditorPresenter pageEditorPresenter,
                                 info.magnolia.ui.actionbar.ActionbarPresenter actionbarPresenter,
                                 info.magnolia.i18nsystem.SimpleTranslator i18n,
                                 info.magnolia.ui.api.availability.AvailabilityChecker availabilityChecker,
                                 PagesContentConnector contentConnector,
                                 StatusBarPresenter statusBar,
                                 PageBarPresenter pageBar)

PagesEditorSubApp

@Deprecated
public PagesEditorSubApp(info.magnolia.ui.api.action.ActionExecutor actionExecutor,
                                     info.magnolia.ui.api.app.SubAppContext subAppContext,
                                     PagesEditorSubAppView view,
                                     @Named(value="admincentral")
                                     info.magnolia.event.EventBus admincentralEventBus,
                                     @Named(value="subapp")
                                     info.magnolia.event.EventBus subAppEventBus,
                                     PageEditorPresenter pageEditorPresenter,
                                     info.magnolia.ui.actionbar.ActionbarPresenter actionbarPresenter,
                                     info.magnolia.cms.core.version.VersionManager versionManager,
                                     info.magnolia.i18nsystem.SimpleTranslator i18n,
                                     info.magnolia.ui.api.availability.AvailabilityChecker availabilityChecker,
                                     info.magnolia.ui.vaadin.integration.contentconnector.ContentConnector contentConnector,
                                     StatusBarPresenter statusBar,
                                     PageBarPresenter pageBar)

Deprecated. since 5.5 - use PagesEditorSubApp(ActionExecutor, SubAppContext, PagesEditorSubAppView, EventBus, EventBus, PageEditorPresenter, ActionbarPresenter, SimpleTranslator, AvailabilityChecker, PagesContentConnector, StatusBarPresenter, PageBarPresenter)

PagesEditorSubApp

@Deprecated
public PagesEditorSubApp(info.magnolia.ui.api.action.ActionExecutor actionExecutor,
                                     info.magnolia.ui.api.app.SubAppContext subAppContext,
                                     PagesEditorSubAppView view,
                                     @Named(value="admincentral")
                                     info.magnolia.event.EventBus admincentralEventBus,
                                     @Named(value="subapp")
                                     info.magnolia.event.EventBus subAppEventBus,
                                     PageEditorPresenter pageEditorPresenter,
                                     info.magnolia.ui.actionbar.ActionbarPresenter actionbarPresenter,
                                     info.magnolia.ui.vaadin.editor.pagebar.PageBarView pageBarView,
                                     info.magnolia.ui.api.i18n.I18NAuthoringSupport i18NAuthoringSupport,
                                     info.magnolia.cms.i18n.I18nContentSupport i18nContentSupport,
                                     info.magnolia.cms.core.version.VersionManager versionManager,
                                     info.magnolia.i18nsystem.SimpleTranslator i18n,
                                     info.magnolia.ui.api.availability.AvailabilityChecker availabilityChecker,
                                     info.magnolia.ui.vaadin.integration.contentconnector.ContentConnector contentConnector,
                                     info.magnolia.ui.workbench.StatusBarView statusBarView)

Deprecated. since 5.4 - use PagesEditorSubApp(ActionExecutor, SubAppContext, PagesEditorSubAppView, EventBus, EventBus, PageEditorPresenter, ActionbarPresenter, SimpleTranslator, AvailabilityChecker, PagesContentConnector, StatusBarPresenter, PageBarPresenter)

Method Detail

getCaption

public String getCaption()

Specified by:

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

Overrides:

getCaption in class info.magnolia.ui.framework.app.BaseSubApp<PagesEditorSubAppView>

updateCaption

public void updateCaption(info.magnolia.ui.contentapp.detail.DetailLocation location)

updateCaptionForExternalPage

public void updateCaptionForExternalPage(String title)

start

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

Specified by:

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

Overrides:

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

updateNodePath

protected void updateNodePath(String path)

Informs the app framework when navigating pages inside the page editor. Updates the shell fragment, caption and current location.

supportsLocation

public boolean supportsLocation(info.magnolia.ui.api.location.Location location)

Specified by:

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

Overrides:

supportsLocation in class info.magnolia.ui.framework.app.BaseSubApp<PagesEditorSubAppView>

getCurrentLocation

public info.magnolia.ui.contentapp.detail.DetailLocation getCurrentLocation()

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

Overrides:

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

deactivateComponents

public void deactivateComponents()

locationChanged

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

Specified by:

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

Overrides:

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

onActionbarItemClicked

public void onActionbarItemClicked(String actionName)

Specified by:

onActionbarItemClicked in interface info.magnolia.ui.actionbar.ActionbarPresenter.Listener

prepareAndExecutePagesEditorAction

protected void prepareAndExecutePagesEditorAction(String actionName)

Used for executing actions from the actionbar. So 'server-side' actions which are depending on a selected element in the page editor.

See Also:

for 'client-side' action execution as comparison.

updateActionbar

public void updateActionbar()

onEscape

public void onEscape()

Specified by:

onEscape in interface PagesEditorSubAppView.Listener

getWorkspace

@Deprecated
protected String getWorkspace()

Deprecated. since 5.4.2 - Use contentConnector directly.

onMove

public void onMove()

stop

public void stop()

Specified by:

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

Overrides:

stop in class info.magnolia.ui.framework.app.BaseSubApp<PagesEditorSubAppView>