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
boolean	canCloseAllPlaces()
boolean	canClosePlace(PlaceRequest place)
void	closeAllPlaces()
boolean	closeAllPlacesOrNothing()
void	closePlace(PlaceRequest placeToClose)
void	closePlace(PlaceRequest placeToClose, Command doAfterClose)
void	closePlace(String id)
void	forceCloseAllPlaces()
void	forceClosePlace(PlaceRequest placeToClose)
void	forceClosePlace(String id)
Collection<SplashScreenActivity>	getActiveSplashScreens()
Collection<PathPlaceRequest>	getActivitiesForResourceType(ResourceTypeDefinition type) Finds the currently open PlaceRequests for Activities that handle the given ResourceTypeDefinition.
Activity	getActivity(PlaceRequest place) Finds the currently open activity that handles the given PlaceRequest by ID.
List<Command>	getOnCloseCallbacks(PlaceRequest place)
List<Command>	getOnOpenCallbacks(PlaceRequest place)
PlaceStatus	getStatus(PlaceRequest place)
PlaceStatus	getStatus(String id)
List<PlaceRequest>	getUncloseablePlaces()
void	goTo(PartDefinition part, PanelDefinition panel)
void	goTo(Path path)
void	goTo(Path path, PanelDefinition panel)
void	goTo(Path path, PlaceRequest placeRequest)
void	goTo(Path path, PlaceRequest placeRequest, PanelDefinition panel)
void	goTo(PlaceRequest place)
void	goTo(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(PlaceRequest place, org.jboss.errai.common.client.dom.HTMLElement addTo)
void	goTo(PlaceRequest place, elemental2.dom.HTMLElement addTo)
void	goTo(PlaceRequest place, PanelDefinition panel)
void	goTo(String identifier)
void	goTo(String id, org.jboss.errai.common.client.dom.HTMLElement addTo)
void	goTo(String identifier, PanelDefinition panel)
void	registerOnCloseCallback(PlaceRequest place, Command callback)
void	registerOnOpenCallback(PlaceRequest place, Command callback)
void	registerPerspectiveCloseChain(String perspectiveIdentifier, BiParameterizedCommand<Command,PlaceRequest> closeChain) Registers a callback interceptor that uses a chain approach to execute code before a PlaceRequest is closed, if the perspective passed as a parameter is currently opened.
void	tryClosePlace(PlaceRequest placeToClose, Command onAfterClose)
void	unregisterOnCloseCallbacks(PlaceRequest place)
void	unregisterOnOpenCallbacks(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

executeOnCloseCallbacks, executeOnOpenCallbacks

Constructor Detail

PluginPlaceManagerImpl

public PluginPlaceManagerImpl()

Method Detail

goTo

public void goTo(String identifier,
                 PanelDefinition panel)

Specified by:

goTo in interface PlaceManager

goTo

public void goTo(String identifier)

Specified by:

goTo in interface PlaceManager

goTo

public void goTo(PlaceRequest place)

Specified by:

goTo in interface PlaceManager

goTo

public void goTo(Path path,
                 PanelDefinition panel)

Specified by:

goTo in interface PlaceManager

goTo

public void goTo(Path path)

Specified by:

goTo in interface PlaceManager

goTo

public void goTo(Path path,
                 PlaceRequest placeRequest,
                 PanelDefinition panel)

Specified by:

goTo in interface PlaceManager

goTo

public void goTo(Path path,
                 PlaceRequest placeRequest)

Specified by:

goTo in interface PlaceManager

goTo

public void goTo(PlaceRequest place,
                 PanelDefinition panel)

Specified by:

goTo in interface PlaceManager

goTo

public void goTo(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.
4. by opening another place on the same container.

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(String id,
                 org.jboss.errai.common.client.dom.HTMLElement addTo)

Specified by:

goTo in interface PlaceManager

goTo

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

Specified by:

goTo in interface PlaceManager

goTo

public void goTo(PlaceRequest place,
                 elemental2.dom.HTMLElement addTo)

Specified by:

goTo in interface PlaceManager

goTo

public void goTo(PartDefinition part,
                 PanelDefinition panel)

Specified by:

goTo in interface PlaceManager

getActivity

public Activity getActivity(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(PlaceRequest place)

Specified by:

getStatus in interface PlaceManager

closePlace

public void closePlace(String id)

Specified by:

closePlace in interface PlaceManager

closePlace

public void closePlace(PlaceRequest placeToClose)

Specified by:

closePlace in interface PlaceManager

closePlace

public void closePlace(PlaceRequest placeToClose,
                       Command doAfterClose)

Specified by:

closePlace in interface PlaceManager

tryClosePlace

public void tryClosePlace(PlaceRequest placeToClose,
                          Command onAfterClose)

Specified by:

tryClosePlace in interface PlaceManager

forceClosePlace

public void forceClosePlace(String id)

Specified by:

forceClosePlace in interface PlaceManager

forceClosePlace

public void forceClosePlace(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

canClosePlace

public boolean canClosePlace(PlaceRequest place)

Specified by:

canClosePlace in interface PlaceManager

canCloseAllPlaces

public boolean canCloseAllPlaces()

Specified by:

canCloseAllPlaces in interface PlaceManager

getUncloseablePlaces

public List<PlaceRequest> getUncloseablePlaces()

Specified by:

getUncloseablePlaces in interface PlaceManager

Returns:

All opened PlaceRequests that cannot be closed (@onMayClose method returns false).

registerOnOpenCallback

public void registerOnOpenCallback(PlaceRequest place,
                                   Command callback)

Specified by:

registerOnOpenCallback in interface PlaceManager

unregisterOnOpenCallbacks

public void unregisterOnOpenCallbacks(PlaceRequest place)

Specified by:

unregisterOnOpenCallbacks in interface PlaceManager

registerOnCloseCallback

public void registerOnCloseCallback(PlaceRequest place,
                                    Command callback)

Specified by:

registerOnCloseCallback in interface PlaceManager

unregisterOnCloseCallbacks

public void unregisterOnCloseCallbacks(PlaceRequest place)

Specified by:

unregisterOnCloseCallbacks in interface PlaceManager

registerPerspectiveCloseChain

public void registerPerspectiveCloseChain(String perspectiveIdentifier,
                                          BiParameterizedCommand<Command,PlaceRequest> closeChain)

Description copied from interface: PlaceManager

Registers a callback interceptor that uses a chain approach to execute code before a PlaceRequest is closed, if the perspective passed as a parameter is currently opened. It will not be executed in the case of a forced close.

Specified by:

registerPerspectiveCloseChain in interface PlaceManager

Parameters:

perspectiveIdentifier - Perspective identifier for which the close chain must be called when it is being closed.

closeChain - Callback to be called when a PlaceRequest is being closed. The callback command must invoke the chain to proceed with the closing operation.

getActiveSplashScreens

public Collection<SplashScreenActivity> getActiveSplashScreens()

Specified by:

getActiveSplashScreens in interface PlaceManager

getOnOpenCallbacks

public List<Command> getOnOpenCallbacks(PlaceRequest place)

Specified by:

getOnOpenCallbacks in interface PlaceManager

getOnCloseCallbacks

public List<Command> getOnCloseCallbacks(PlaceRequest place)

Specified by:

getOnCloseCallbacks in interface PlaceManager

getActivitiesForResourceType

public Collection<PathPlaceRequest> getActivitiesForResourceType(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.