com.gwtplatform.mvp.client.proxy

Class GetPlaceTitleEvent

java.lang.Object

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

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

com.gwtplatform.mvp.client.proxy.GetPlaceTitleEvent

public class GetPlaceTitleEvent
extends GwtEvent<GetPlaceTitleHandler>

This event is fired whenever the user wants to have access to the title of a place.

Important! You should never fire that event directly. Instead, use PlaceManager.getCurrentTitle(SetPlaceTitleHandler) or PlaceManager.getTitle(int, SetPlaceTitleHandler).

Author:

Philippe Beaudoin

Nested Class Summary

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

GwtEvent.Type<H>

Constructor Summary

Constructors

Constructor and Description
GetPlaceTitleEvent(PlaceRequest request, SetPlaceTitleHandler handler)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	dispatch(GetPlaceTitleHandler handler)
static void	fire(HasHandlers source, PlaceRequest request, SetPlaceTitleHandler handler) Fires a GetPlaceTitleEvent into a source that has access to an EventBus.
GwtEvent.Type<GetPlaceTitleHandler>	getAssociatedType()
SetPlaceTitleHandler	getHandler()
PlaceRequest	getRequest()
static GwtEvent.Type<GetPlaceTitleHandler>	getType()
boolean	isHandled() Checks if the event was handled.
void	setHandled() Indicates that the event was handled and that other handlers should not process it.

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

GetPlaceTitleEvent

public GetPlaceTitleEvent(PlaceRequest request,
                  SetPlaceTitleHandler handler)

Method Detail

fire

public static void fire(HasHandlers source,
        PlaceRequest request,
        SetPlaceTitleHandler handler)

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

Important! You should never fire that event directly. See GetPlaceTitleEvent for details.

Parameters:

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

request - The PlaceRequest for which to obtain the title.

handler - The SetPlaceTitleHandler that will be invoked when the title is obtained.

getType

public static GwtEvent.Type<GetPlaceTitleHandler> getType()

getAssociatedType

public GwtEvent.Type<GetPlaceTitleHandler> getAssociatedType()

Overrides:

getAssociatedType in class GwtEvent<GetPlaceTitleHandler>

getHandler

public SetPlaceTitleHandler getHandler()

getRequest

public PlaceRequest getRequest()

isHandled

public boolean isHandled()

Checks if the event was handled. If it was, then it should not be processed further.

Returns:

true if the event was handled. false otherwise.

setHandled

public void setHandled()

Indicates that the event was handled and that other handlers should not process it.

dispatch

protected void dispatch(GetPlaceTitleHandler handler)

Specified by:

dispatch in class GwtEvent<GetPlaceTitleHandler>