Package org.uberfire.mvp

Interface PlaceRequest

All Known Implementing Classes:

ConditionalPlaceRequest, DefaultPlaceRequest, ExternalPathPlaceRequest, ForcedPlaceRequest, PathPlaceRequest

@JsType
public interface PlaceRequest

A request to navigate to a particular UberFire Workbench Place (a WorkbenchPerspective, a WorkbenchScreen, or a WorkbenchEditor). Can include optional state parameters that are made available to the requested place.

Place requests can be serialized to and created from a valid URL fragment identifier (the string that goes after the # in the browser's location bar).

Field Summary

Fields

Modifier and Type	Field	Description
static PlaceRequest	NOWHERE

Method Summary

Modifier and Type	Method	Description
PlaceRequest	addParameter(String name, String value)
default String	asString()	Invokes #toString() but exported to JavaScript so it can be invoked from different scripts.
PlaceRequest	clone()
String	getFullIdentifier()
String	getIdentifier()
String	getParameter(String key, String defaultValue)
Set<String>	getParameterNames()
Map<String,String>	getParameters()
default Path	getPath()	Returns the path associated with this PlaceRequest.
boolean	isUpdateLocationBarAllowed()	Indicates whether or not the Workbench framework should add a browser history item when navigating to this place.
void	setIdentifier(String identifier)
void	setUpdateLocationBar(boolean updateLocationBar)

Field Detail

NOWHERE

static final PlaceRequest NOWHERE

Method Detail

getIdentifier

String getIdentifier()

setIdentifier

void setIdentifier(String identifier)

getFullIdentifier

String getFullIdentifier()

getParameter

String getParameter(String key,
                    String defaultValue)

getParameterNames

Set<String> getParameterNames()

getParameters

Map<String,String> getParameters()

addParameter

PlaceRequest addParameter(String name,
                          String value)

clone

PlaceRequest clone()

isUpdateLocationBarAllowed

boolean isUpdateLocationBarAllowed()

Indicates whether or not the Workbench framework should add a browser history item when navigating to this place.

setUpdateLocationBar

void setUpdateLocationBar(boolean updateLocationBar)

getPath

default Path getPath()

Returns the path associated with this PlaceRequest.

asString

default String asString()

Invokes #toString() but exported to JavaScript so it can be invoked from different scripts.