@JsType
public interface PlaceManager
WorkbenchPerspective
, a WorkbenchScreen
, a WorkbenchPopup
, a
WorkbenchEditor
, a WorkbenchPart
within a screen or editor, or the editor associated with a VFS file
located at a particular Path
.Modifier and Type | Method and Description |
---|---|
boolean |
canClosePlace(org.uberfire.mvp.PlaceRequest place) |
void |
closeAllPlaces() |
boolean |
closeAllPlacesOrNothing() |
void |
closePlace(org.uberfire.mvp.PlaceRequest placeToClose) |
void |
closePlace(org.uberfire.mvp.PlaceRequest placeToClose,
org.uberfire.mvp.Command doAfterClose) |
void |
closePlace(String id) |
default void |
executeOnCloseCallbacks(org.uberfire.mvp.PlaceRequest place) |
default void |
executeOnOpenCallbacks(org.uberfire.mvp.PlaceRequest place) |
void |
forceCloseAllPlaces() |
void |
forceClosePlace(org.uberfire.mvp.PlaceRequest place) |
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.
|
List<org.uberfire.mvp.Command> |
getOnCloseCallbacks(org.uberfire.mvp.PlaceRequest place) |
List<org.uberfire.mvp.Command> |
getOnOpenCallbacks(org.uberfire.mvp.PlaceRequest place) |
PlaceStatus |
getStatus(org.uberfire.mvp.PlaceRequest place) |
PlaceStatus |
getStatus(String id) |
List<org.uberfire.mvp.PlaceRequest> |
getUncloseablePlaces() |
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 place) |
void |
goTo(org.uberfire.backend.vfs.Path path,
org.uberfire.mvp.PlaceRequest place,
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 |
registerOnCloseCallback(org.uberfire.mvp.PlaceRequest place,
org.uberfire.mvp.Command callback) |
void |
registerOnOpenCallback(org.uberfire.mvp.PlaceRequest place,
org.uberfire.mvp.Command callback) |
void |
registerPerspectiveCloseChain(String perspectiveIdentifier,
org.uberfire.mvp.BiParameterizedCommand<org.uberfire.mvp.Command,org.uberfire.mvp.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(org.uberfire.mvp.PlaceRequest placeToClose,
org.uberfire.mvp.Command onAfterClose) |
void |
unregisterOnCloseCallbacks(org.uberfire.mvp.PlaceRequest place) |
void |
unregisterOnOpenCallbacks(org.uberfire.mvp.PlaceRequest place) |
@JsMethod(name="goToId") void goTo(String identifier)
@JsMethod(name="goToPlace") void goTo(org.uberfire.mvp.PlaceRequest place)
@JsMethod(name="goToPath") void goTo(org.uberfire.backend.vfs.Path path)
@JsMethod(name="goToPathAndPlace") void goTo(org.uberfire.backend.vfs.Path path, org.uberfire.mvp.PlaceRequest place)
@JsMethod(name="goToPartWithPanel") void goTo(org.uberfire.workbench.model.PartDefinition part, org.uberfire.workbench.model.PanelDefinition panel)
@JsMethod(name="goToIdWithPanel") void goTo(String identifier, org.uberfire.workbench.model.PanelDefinition panel)
@JsMethod(name="goToPlaceWithPanel") void goTo(org.uberfire.mvp.PlaceRequest place, org.uberfire.workbench.model.PanelDefinition panel)
@JsMethod(name="goToPathWithPanel") void goTo(org.uberfire.backend.vfs.Path path, org.uberfire.workbench.model.PanelDefinition panel)
@JsMethod(name="goToPathAndPlaceWithPanel") void goTo(org.uberfire.backend.vfs.Path path, org.uberfire.mvp.PlaceRequest place, org.uberfire.workbench.model.PanelDefinition panel)
@JsIgnore void goTo(org.uberfire.mvp.PlaceRequest place, com.google.gwt.user.client.ui.HasWidgets addTo)
The activity will be properly shut down in any of the following scenarios:
closePlace(PlaceRequest)
,
closePlace(String)
, or closeAllPlaces()
place
- 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.@JsIgnore void goTo(org.uberfire.mvp.PlaceRequest place, org.jboss.errai.common.client.dom.HTMLElement addTo)
Activity getActivity(org.uberfire.mvp.PlaceRequest place)
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?)place
- the PlaceRequest whose activity to search for@JsMethod(name="getStatusById") PlaceStatus getStatus(String id)
@JsMethod(name="getStatusByPlaceRequest") PlaceStatus getStatus(org.uberfire.mvp.PlaceRequest place)
default void executeOnOpenCallbacks(org.uberfire.mvp.PlaceRequest place)
default void executeOnCloseCallbacks(org.uberfire.mvp.PlaceRequest place)
List<org.uberfire.mvp.Command> getOnOpenCallbacks(org.uberfire.mvp.PlaceRequest place)
List<org.uberfire.mvp.Command> getOnCloseCallbacks(org.uberfire.mvp.PlaceRequest place)
@JsMethod(name="closePlaceById") void closePlace(String id)
void closePlace(org.uberfire.mvp.PlaceRequest placeToClose)
@JsMethod(name="closePlaceWithCallback") void closePlace(org.uberfire.mvp.PlaceRequest placeToClose, org.uberfire.mvp.Command doAfterClose)
void tryClosePlace(org.uberfire.mvp.PlaceRequest placeToClose, org.uberfire.mvp.Command onAfterClose)
@JsMethod(name="forceCloseById") void forceClosePlace(String id)
@JsMethod(name="forceCloseByPlaceRequest") void forceClosePlace(org.uberfire.mvp.PlaceRequest place)
void closeAllPlaces()
void forceCloseAllPlaces()
boolean closeAllPlacesOrNothing()
boolean canClosePlace(org.uberfire.mvp.PlaceRequest place)
List<org.uberfire.mvp.PlaceRequest> getUncloseablePlaces()
void registerOnOpenCallback(org.uberfire.mvp.PlaceRequest place, org.uberfire.mvp.Command callback)
void unregisterOnOpenCallbacks(org.uberfire.mvp.PlaceRequest place)
void registerOnCloseCallback(org.uberfire.mvp.PlaceRequest place, org.uberfire.mvp.Command callback)
void unregisterOnCloseCallbacks(org.uberfire.mvp.PlaceRequest place)
void registerPerspectiveCloseChain(String perspectiveIdentifier, org.uberfire.mvp.BiParameterizedCommand<org.uberfire.mvp.Command,org.uberfire.mvp.PlaceRequest> closeChain)
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.@JsIgnore Collection<SplashScreenActivity> getActiveSplashScreens()
@JsIgnore Collection<org.uberfire.mvp.impl.PathPlaceRequest> getActivitiesForResourceType(org.uberfire.workbench.type.ResourceTypeDefinition type)
type
- the ResourceTypeDefinition whose activity to search forCopyright © 2012–2019 JBoss by Red Hat. All rights reserved.