org.uberfire.client.mvp

Class PluginPlaceManagerImpl

java.lang.Object

org.uberfire.client.mvp.PluginPlaceManagerImpl

All Implemented Interfaces:

PlaceManager

@ApplicationScoped
public class PluginPlaceManagerImpl
extends Object
implements PlaceManager

This PlaceManager implementation is active for plugins only, to satisfy compile-time dependencies (of other components on the plugin's classpath that require a place manager). It is not used at runtime as plugins use the SharedSingleton PlaceManager provided by the main application. Plugins get access to a fully functional PlaceManager using @Inject @Shared ShareablePlaceManager.

Constructor Summary

Constructors

Constructor and Description
PluginPlaceManagerImpl()

Method Summary

Modifier and Type	Method and Description
void	closeAllPlaces()
boolean	closeAllPlacesOrNothing()
void	closePlace(org.uberfire.mvp.PlaceRequest placeToClose)
void	closePlace(String id)
void	forceCloseAllPlaces()
void	forceClosePlace(org.uberfire.mvp.PlaceRequest placeToClose)
void	forceClosePlace(String id)
Collection<SplashScreenActivity>	getActiveSplashScreens()
Collection<org.uberfire.mvp.impl.PathPlaceRequest>	getActivitiesForResourceType(org.uberfire.workbench.type.ResourceTypeDefinition type) Finds the currently open PlaceRequests for Activities that handle the given ResourceTypeDefinition.
Activity	getActivity(org.uberfire.mvp.PlaceRequest place) Finds the currently open activity that handles the given PlaceRequest by ID.
org.uberfire.mvp.Command	getOpenCallback(org.uberfire.mvp.PlaceRequest place)
PlaceStatus	getStatus(org.uberfire.mvp.PlaceRequest place)
PlaceStatus	getStatus(String id)
void	goTo(org.uberfire.workbench.model.PartDefinition part, org.uberfire.workbench.model.PanelDefinition panel)
void	goTo(org.uberfire.backend.vfs.Path path)
void	goTo(org.uberfire.backend.vfs.Path path, org.uberfire.workbench.model.PanelDefinition panel)
void	goTo(org.uberfire.backend.vfs.Path path, org.uberfire.mvp.PlaceRequest placeRequest)
void	goTo(org.uberfire.backend.vfs.Path path, org.uberfire.mvp.PlaceRequest placeRequest, org.uberfire.workbench.model.PanelDefinition panel)
void	goTo(org.uberfire.mvp.PlaceRequest place)
void	goTo(org.uberfire.mvp.PlaceRequest place, com.google.gwt.user.client.ui.HasWidgets addTo) Locates the Activity associated with the given place, and if that activity is not already part of the workbench, starts it and adds its view to the given widget container.
void	goTo(org.uberfire.mvp.PlaceRequest place, org.jboss.errai.common.client.dom.HTMLElement addTo)
void	goTo(org.uberfire.mvp.PlaceRequest place, org.uberfire.workbench.model.PanelDefinition panel)
void	goTo(String identifier)
void	goTo(String identifier, org.uberfire.workbench.model.PanelDefinition panel)
void	registerOnOpenCallback(org.uberfire.mvp.PlaceRequest place, org.uberfire.mvp.Command command)
void	tryClosePlace(org.uberfire.mvp.PlaceRequest placeToClose, org.uberfire.mvp.Command onAfterClose)
void	unregisterOnOpenCallback(org.uberfire.mvp.PlaceRequest place)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.uberfire.client.mvp.PlaceManager

executeOnOpenCallback

Constructor Detail

PluginPlaceManagerImpl

public PluginPlaceManagerImpl()

Method Detail

goTo

public void goTo(String identifier,
                 org.uberfire.workbench.model.PanelDefinition panel)

Specified by:

goTo in interface PlaceManager

goTo

public void goTo(String identifier)

Specified by:

goTo in interface PlaceManager

goTo

public void goTo(org.uberfire.mvp.PlaceRequest place)

Specified by:

goTo in interface PlaceManager

goTo

public void goTo(org.uberfire.backend.vfs.Path path,
                 org.uberfire.workbench.model.PanelDefinition panel)

Specified by:

goTo in interface PlaceManager

goTo

public void goTo(org.uberfire.backend.vfs.Path path)

Specified by:

goTo in interface PlaceManager

goTo

public void goTo(org.uberfire.backend.vfs.Path path,
                 org.uberfire.mvp.PlaceRequest placeRequest,
                 org.uberfire.workbench.model.PanelDefinition panel)

Specified by:

goTo in interface PlaceManager

goTo

public void goTo(org.uberfire.backend.vfs.Path path,
                 org.uberfire.mvp.PlaceRequest placeRequest)

Specified by:

goTo in interface PlaceManager

goTo

public void goTo(org.uberfire.mvp.PlaceRequest place,
                 org.uberfire.workbench.model.PanelDefinition panel)

Specified by:

goTo in interface PlaceManager

goTo

public void goTo(org.uberfire.mvp.PlaceRequest place,
                 com.google.gwt.user.client.ui.HasWidgets addTo)

Description copied from interface: PlaceManager

Locates the Activity associated with the given place, and if that activity is not already part of the workbench, starts it and adds its view to the given widget container. If the activity is already part of the current workbench, it will be selected, and it will not be moved from its current location.

The activity will be properly shut down in any of the following scenarios:

1. by a call to one of the PlaceManager methods for closing a place: PlaceManager.closePlace(PlaceRequest), PlaceManager.closePlace(String), or PlaceManager.closeAllPlaces()
2. by switching to another perspective, which has the side effect of closing all places
3. by removing the activity's view from the DOM, either using the GWT Widget API, or by direct DOM manipulation.

Specified by:

goTo in interface PlaceManager

addTo - The container to add the widget's view to. Its corresponding DOM element must have a CSS position setting of relative or absolute and an explicit size set. This can be accomplished through direct use of CSS, or through the Layouts.setToFillParent(com.google.gwt.user.client.ui.Widget) call.

goTo

public void goTo(org.uberfire.mvp.PlaceRequest place,
                 org.jboss.errai.common.client.dom.HTMLElement addTo)

Specified by:

goTo in interface PlaceManager

goTo

public void goTo(org.uberfire.workbench.model.PartDefinition part,
                 org.uberfire.workbench.model.PanelDefinition panel)

Specified by:

goTo in interface PlaceManager

getActivity

public Activity getActivity(org.uberfire.mvp.PlaceRequest place)

Description copied from interface: PlaceManager

Finds the currently open activity that handles the given PlaceRequest by ID. No attempt is made to match by path, but see ActivityManagerImpl#resolveExistingParts(PlaceRequest) for a variant that does. (TODO: should this method care about paths? if not, should the other method be added to the interface?)

Specified by:

getActivity in interface PlaceManager

Parameters:

place - the PlaceRequest whose activity to search for

Returns:

the activity that currently exists in service of the given PlaceRequest's ID. Null if no current activity handles the given PlaceRequest.

getStatus

public PlaceStatus getStatus(String id)

Specified by:

getStatus in interface PlaceManager

getStatus

public PlaceStatus getStatus(org.uberfire.mvp.PlaceRequest place)

Specified by:

getStatus in interface PlaceManager

closePlace

public void closePlace(String id)

Specified by:

closePlace in interface PlaceManager

closePlace

public void closePlace(org.uberfire.mvp.PlaceRequest placeToClose)

Specified by:

closePlace in interface PlaceManager

tryClosePlace

public void tryClosePlace(org.uberfire.mvp.PlaceRequest placeToClose,
                          org.uberfire.mvp.Command onAfterClose)

Specified by:

tryClosePlace in interface PlaceManager

forceClosePlace

public void forceClosePlace(String id)

Specified by:

forceClosePlace in interface PlaceManager

forceClosePlace

public void forceClosePlace(org.uberfire.mvp.PlaceRequest placeToClose)

Specified by:

forceClosePlace in interface PlaceManager

closeAllPlaces

public void closeAllPlaces()

Specified by:

closeAllPlaces in interface PlaceManager

forceCloseAllPlaces

public void forceCloseAllPlaces()

Specified by:

forceCloseAllPlaces in interface PlaceManager

closeAllPlacesOrNothing

public boolean closeAllPlacesOrNothing()

Specified by:

closeAllPlacesOrNothing in interface PlaceManager

registerOnOpenCallback

public void registerOnOpenCallback(org.uberfire.mvp.PlaceRequest place,
                                   org.uberfire.mvp.Command command)

Specified by:

registerOnOpenCallback in interface PlaceManager

unregisterOnOpenCallback

public void unregisterOnOpenCallback(org.uberfire.mvp.PlaceRequest place)

Specified by:

unregisterOnOpenCallback in interface PlaceManager

getActiveSplashScreens

public Collection<SplashScreenActivity> getActiveSplashScreens()

Specified by:

getActiveSplashScreens in interface PlaceManager

getOpenCallback

public org.uberfire.mvp.Command getOpenCallback(org.uberfire.mvp.PlaceRequest place)

Specified by:

getOpenCallback in interface PlaceManager

getActivitiesForResourceType

public Collection<org.uberfire.mvp.impl.PathPlaceRequest> getActivitiesForResourceType(org.uberfire.workbench.type.ResourceTypeDefinition type)

Description copied from interface: PlaceManager

Finds the currently open PlaceRequests for Activities that handle the given ResourceTypeDefinition.

Specified by:

getActivitiesForResourceType in interface PlaceManager

Parameters:

type - the ResourceTypeDefinition whose activity to search for

Returns:

an unmodifiable collection of PlaceRequests for the currently open WorkbenchEditorActivities that can handle the ResourceTypeDefinition. Returns an empty collection if no match was found.