com.google.gwt.app.place
Class PlaceChangeRequestedEvent<P extends Place>

java.lang.Object
  extended by com.google.gwt.event.shared.GwtEvent<PlaceChangeRequestedEvent.Handler<P>>
      extended by com.google.gwt.app.place.PlaceChangeRequestedEvent<P>
Type Parameters:
P - the type of the requested place

public class PlaceChangeRequestedEvent<P extends Place>
extends GwtEvent<PlaceChangeRequestedEvent.Handler<P>>

Experimental API: This class is still under rapid development, and is very likely to be deleted. Use it at your own risk.

Event thrown when the user may go to a new place in the app. May be rejected.


Nested Class Summary
static interface PlaceChangeRequestedEvent.Handler<P extends Place>
          Implemented by handlers of PlaceChangeRequestedEvent.
 
Nested classes/interfaces inherited from class com.google.gwt.event.shared.GwtEvent
GwtEvent.Type<H>
 
Field Summary
static GwtEvent.Type<PlaceChangeRequestedEvent.Handler<?>> TYPE
           
 
Constructor Summary
PlaceChangeRequestedEvent(P newPlace)
           
 
Method Summary
 GwtEvent.Type<PlaceChangeRequestedEvent.Handler<P>> getAssociatedType()
          Returns the type used to register this event.
 P getNewPlace()
           
 boolean isRejected()
           
 void reject()
           
 
Methods inherited from class com.google.gwt.event.shared.GwtEvent
getSource, toDebugString, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE

public static final GwtEvent.Type<PlaceChangeRequestedEvent.Handler<?>> TYPE
Constructor Detail

PlaceChangeRequestedEvent

public PlaceChangeRequestedEvent(P newPlace)
Method Detail

getAssociatedType

public GwtEvent.Type<PlaceChangeRequestedEvent.Handler<P>> getAssociatedType()
Description copied from class: GwtEvent
Returns the type used to register this event. Used by handler manager to dispatch events to the correct handlers.

Specified by:
getAssociatedType in class GwtEvent<PlaceChangeRequestedEvent.Handler<P extends Place>>
Returns:
the type

getNewPlace

public P getNewPlace()

isRejected

public boolean isRejected()

reject

public void reject()