com.gwtplatform.mvp.client.proxy

Interface Place

All Known Subinterfaces:

ProxyPlace<P>, TabContentProxyPlace<P>

All Known Implementing Classes:

PlaceImpl, PlaceWithGatekeeper, PlaceWithGatekeeperWithParams, ProxyPlaceAbstract, ProxyPlaceImpl, TabContentProxyPlaceImpl

public interface Place

Important: For simplicity, places do not participate in dependency injection and can be created with new.

A place represents a particular 'bookmark' or location inside the application. A place is stateful - it may represent a location with it's current settings, such as a particular ID value, or other unique indicators that will allow a user to track back to that location later, either via a browser bookmark, or by clicking the 'back' button.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canReveal() Checks if the associated presenter can be revealed.
boolean	equals(Object o) Places are equal if their name token matches.
String	getNameToken() The name token is the first part of the history token, before the parameters.
int	hashCode()
boolean	matchesRequest(PlaceRequest request) Makes sure the method matches the passed request.
String	toString()

Method Detail

canReveal

boolean canReveal()

Checks if the associated presenter can be revealed.

The default implementation of this method always return true, but subclasses should override this and check to make sure the current user has the privileges to see the place. Make sure the places you request in PlaceManager.revealDefaultPlace() and PlaceManager.revealErrorPlace(String) can reveal themselves, otherwise your application could get into an infinite loop.

Returns:

true if the presenter can be revealed, false otherwise.

equals

boolean equals(Object o)

Places are equal if their name token matches.

Overrides:

equals in class Object

Returns:

true if the places name token matches, false otherwise.

getNameToken

String getNameToken()

The name token is the first part of the history token, before the parameters. It is meant to be a unique identifier of a place. An exception will be thrown if two places are registered with the same name token.

Returns:

The name token for this place.

hashCode

int hashCode()

Overrides:

hashCode in class Object

matchesRequest

boolean matchesRequest(PlaceRequest request)

Makes sure the method matches the passed request.

Parameters:

request - The request to check.

Returns:

true if the ID matches this place's name.

toString

String toString()

Overrides:

toString in class Object