com.gwtplatform.mvp.client.proxy

Class LockInteractionEvent

java.lang.Object

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

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

com.gwtplatform.mvp.client.proxy.LockInteractionEvent

public class LockInteractionEvent
extends GwtEvent<LockInteractionHandler>

This event is fired whenever interaction should be locked throughout the application, usually because a navigation operation is taking place and interacting could cause unexpected state switches.

This event is typically fired by the PlaceManager whenever a navigation operation starts or stops. It is handled by the default RootPresenter implementation. Override com.gwtplatform.mvp.client.RootPresenter#lockInteraction(boolean) to customize the behaviour.

Nested Class Summary

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

GwtEvent.Type<H>

Constructor Summary

Constructors

Constructor and Description
LockInteractionEvent(boolean lock)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	dispatch(LockInteractionHandler handler)
static void	fire(HasHandlers source, boolean lock) Fires a LockInteractionEvent into a source that has access to an EventBus specifying whether interaction should be locked or unlocked.
GwtEvent.Type<LockInteractionHandler>	getAssociatedType()
static GwtEvent.Type<LockInteractionHandler>	getType()
boolean	shouldLock()

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

LockInteractionEvent

public LockInteractionEvent(boolean lock)

Method Detail

fire

public static void fire(HasHandlers source,
        boolean lock)

Fires a LockInteractionEvent into a source that has access to an EventBus specifying whether interaction should be locked or unlocked.

Parameters:

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

lock - true to lock interaction, false to unlock it.

getType

public static GwtEvent.Type<LockInteractionHandler> getType()

getAssociatedType

public GwtEvent.Type<LockInteractionHandler> getAssociatedType()

Overrides:

getAssociatedType in class GwtEvent<LockInteractionHandler>

shouldLock

public boolean shouldLock()

dispatch

protected void dispatch(LockInteractionHandler handler)

Specified by:

dispatch in class GwtEvent<LockInteractionHandler>