com.gwtplatform.mvp.client.proxy

Class ProxyPlaceAbstract<P extends Presenter<?,?>,Proxy_ extends Proxy<P>>

java.lang.Object

com.gwtplatform.mvp.client.proxy.ProxyPlaceAbstract<P,Proxy_>

Type Parameters:

P - The Presenter's type.

Proxy_ - Type of the associated Proxy.

All Implemented Interfaces:

HasHandlers, HasHandlerContainer, Place, Proxy<P>, ProxyPlace<P>, ProxyRaw

Direct Known Subclasses:

ProxyPlaceImpl, TabContentProxyPlaceImpl

public class ProxyPlaceAbstract<P extends Presenter<?,?>,Proxy_ extends Proxy<P>>
extends Object
implements ProxyPlace<P>, HasHandlerContainer

A useful mixing class to define a Proxy that is also a Place. You can usually inherit from the simpler form ProxyPlace.

Constructor Summary

Constructors

Constructor and Description
ProxyPlaceAbstract() Creates a ProxyPlaceAbstract.

Method Summary

Methods

Modifier and Type	Method and Description
protected <H> void	addRegisteredHandler(GwtEvent.Type<H> type, H handler) Register an event to be automatically removed when this proxy will be released.
protected void	bind(PlaceManager placeManager, EventBus eventBus) Injects the various resources and performs other bindings.
boolean	canReveal() Checks if the associated presenter can be revealed.
boolean	equals(Object o) Places are equal if their name token matches.
void	fireEvent(GwtEvent<?> event)
EventBus	getEventBus() Makes it possible to access the EventBus object associated with that proxy.
HandlerContainer	getHandlerContainer()
String	getNameToken() The name token is the first part of the history token, before the parameters.
protected Place	getPlace()
protected PlaceManager	getPlaceManager()
protected void	getPlaceTitle(GetPlaceTitleEvent event) Obtains the title for this place and invoke the passed handler when the title is available.
void	getPresenter(NotifyingAsyncCallback<P> callback) Get the associated Presenter.
protected Proxy_	getProxy()
void	getRawPresenter(NotifyingAsyncCallback<Presenter<?,?>> callback) Get the associated Presenter.
int	hashCode()
void	manualReveal(Presenter<?,?> presenter) Manually reveals a presenter.
void	manualRevealFailed() Cancels manually revealing a presenter.
boolean	matchesRequest(PlaceRequest request) Makes sure the method matches the passed request.
protected void	setPlace(Place place)
protected void	setPlaceManager(PlaceManager placeManager)
protected void	setProxy(Proxy_ proxy)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProxyPlaceAbstract

public ProxyPlaceAbstract()

Creates a ProxyPlaceAbstract. That is, the Proxy of a Presenter attached to a Place. This presenter can be invoked by setting a history token that matches its name token in the URL bar.

Method Detail

canReveal

public boolean canReveal()

Description copied from interface: Place

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.

Specified by:

canReveal in interface Place

Returns:

true if the presenter can be revealed, false otherwise.

equals

public final boolean equals(Object o)

Description copied from interface: Place

Places are equal if their name token matches.

Specified by:

equals in interface Place

Overrides:

equals in class Object

Returns:

true if the places name token matches, false otherwise.

fireEvent

public void fireEvent(GwtEvent<?> event)

Specified by:

fireEvent in interface HasHandlers

getEventBus

public final EventBus getEventBus()

Description copied from interface: Proxy

Makes it possible to access the EventBus object associated with that proxy.

Specified by:

getEventBus in interface Proxy<P extends Presenter<?,?>>

Returns:

The EventBus associated with that proxy.

getNameToken

public String getNameToken()

Description copied from interface: Place

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.

Specified by:

getNameToken in interface Place

Returns:

The name token for this place.

getPresenter

public void getPresenter(NotifyingAsyncCallback<P> callback)

Description copied from interface: Proxy

Get the associated Presenter. The presenter can only be obtained in an asynchronous manner to support code splitting when needed. To access the presenter, pass a callback.

Specified by:

getPresenter in interface Proxy<P extends Presenter<?,?>>

Parameters:

callback - The callback in which the Presenter will be passed as a parameter.

getRawPresenter

public void getRawPresenter(NotifyingAsyncCallback<Presenter<?,?>> callback)

Description copied from interface: ProxyRaw

Get the associated Presenter. The presenter can only be obtained in an asynchronous manner to support code splitting when needed. To access the presenter, pass a callback.

The difference between this method and Proxy.getPresenter(com.gwtplatform.mvp.client.proxy.NotifyingAsyncCallback<P>) is that the latter one gets the specific parameterised Presenter type.

Specified by:

getRawPresenter in interface ProxyRaw

Parameters:

callback - The callback in which the Presenter will be passed as a parameter.

hashCode

public final int hashCode()

Specified by:

hashCode in interface Place

Overrides:

hashCode in class Object

matchesRequest

public boolean matchesRequest(PlaceRequest request)

Description copied from interface: Place

Makes sure the method matches the passed request.

Specified by:

matchesRequest in interface Place

Parameters:

request - The request to check.

Returns:

true if the ID matches this place's name.

getHandlerContainer

public HandlerContainer getHandlerContainer()

Specified by:

getHandlerContainer in interface HasHandlerContainer

Returns:

the handler container of the implementer.

toString

public final String toString()

Specified by:

toString in interface Place

Overrides:

toString in class Object

getPlace

protected Place getPlace()

setPlace

protected void setPlace(Place place)

getPlaceManager

protected PlaceManager getPlaceManager()

setPlaceManager

protected void setPlaceManager(PlaceManager placeManager)

getProxy

protected Proxy_ getProxy()

setProxy

protected void setProxy(Proxy_ proxy)

bind

@Inject
protected void bind(PlaceManager placeManager,
               EventBus eventBus)

Injects the various resources and performs other bindings.

Never call directly, it should only be called by GIN. Method injection is used instead of constructor injection, because the latter doesn't work well with GWT generators.

Parameters:

placeManager - The PlaceManager.

eventBus - The EventBus.

getPlaceTitle

protected void getPlaceTitle(GetPlaceTitleEvent event)

Obtains the title for this place and invoke the passed handler when the title is available. By default, places don't have a title and will invoke the handler with null, but override this method to provide your own title.

Parameters:

event - The GetPlaceTitleEvent to invoke once the title is available.

addRegisteredHandler

protected <H> void addRegisteredHandler(GwtEvent.Type<H> type,
                            H handler)

Register an event to be automatically removed when this proxy will be released. You will have to register your event again if you rebind this proxy.

Type Parameters:

H - The handler type

Parameters:

type - The event type

handler - The handler to register.

manualReveal

public void manualReveal(Presenter<?,?> presenter)

Description copied from interface: ProxyPlace

Manually reveals a presenter. Only use this method if your presenter is configured to use manual reveal via Presenter.useManualReveal(). This method should be called following one or more asynchronous server calls in Presenter.prepareFromRequest(com.gwtplatform.mvp.shared.proxy.PlaceRequest). You should manually reveal your presenter exactly once, when all the data needed to use it is available.

If you failed to fetch the data or cannot reveal the presenter you must call ProxyPlace.manualRevealFailed() otherwise navigation will be blocked and your application will appear to be frozen.

Also consider using ManualRevealCallback, which will automatically call ProxyPlace.manualReveal(Presenter) upon success and ProxyPlace.manualRevealFailed() upon failure.

Specified by:

manualReveal in interface ProxyPlace<P extends Presenter<?,?>>

Parameters:

presenter - The presenter that will be delayed revealed.

See Also:

Presenter.useManualReveal(), ProxyPlace.manualRevealFailed()

manualRevealFailed

public void manualRevealFailed()

Description copied from interface: ProxyPlace

Cancels manually revealing a presenter. Only use this method if your presenter is configured to use manual reveal via Presenter.useManualReveal(). For more details see ProxyPlace.manualReveal(Presenter).

Specified by:

manualRevealFailed in interface ProxyPlace<P extends Presenter<?,?>>

See Also:

ProxyPlace.manualReveal(Presenter)