com.gwtplatform.mvp.client.proxy

Class NavigationEvent

java.lang.Object

com.google.web.bindery.event.shared.Event<H>

com.google.gwt.event.shared.GwtEvent<NavigationHandler>

com.gwtplatform.mvp.client.proxy.NavigationEvent

public final class NavigationEvent
extends GwtEvent<NavigationHandler>

Event fired after navigation has occurred. It will not be fired if navigation is refused through PlaceManager.setOnLeaveConfirmation(java.lang.String), instead NavigationRefusedEvent will.

Instead of registering your presenter towards this event, consider overriding PresenterWidget.onReset(). From there you can call PlaceManager.getCurrentPlaceRequest() to get the PlaceRequest.

See Also:

NavigationRefusedEvent

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.event.shared.GwtEvent

GwtEvent.Type<H>

Constructor Summary

Constructors

Constructor and Description
NavigationEvent(PlaceRequest request) Create a navigation event and attach it to a place request.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	dispatch(NavigationHandler handler)
static void	fire(HasHandlers source, PlaceRequest request) Fires a NavigationEvent into a source that has access to an EventBus.
GwtEvent.Type<NavigationHandler>	getAssociatedType()
PlaceRequest	getRequest() Access the PlaceRequest that triggered that navigation event.
static GwtEvent.Type<NavigationHandler>	getType()

Methods inherited from class com.google.gwt.event.shared.GwtEvent

assertLive, getSource, isLive, kill, revive

Methods inherited from class com.google.web.bindery.event.shared.Event

setSource, toDebugString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NavigationEvent

public NavigationEvent(PlaceRequest request)

Create a navigation event and attach it to a place request. You can pass null as a request if it's unknown, for example when revealing a default place or an error place.

Parameters:

request - The PlaceRequest.

Method Detail

fire

public static void fire(HasHandlers source,
        PlaceRequest request)

Fires a NavigationEvent into a source that has access to an EventBus.

Parameters:

source - The source that fires this event (HasHandlers).

request - The PlaceRequest that was navigated to.

getType

public static GwtEvent.Type<NavigationHandler> getType()

getAssociatedType

public GwtEvent.Type<NavigationHandler> getAssociatedType()

Overrides:

getAssociatedType in class GwtEvent<NavigationHandler>

getRequest

public PlaceRequest getRequest()

Access the PlaceRequest that triggered that navigation event.

Returns:

The PlaceRequest or null if no place request is known.

dispatch

protected void dispatch(NavigationHandler handler)

Specified by:

dispatch in class GwtEvent<NavigationHandler>