com.sage.swt.client.widget.event
Class BeforeClickEvent

java.lang.Object
  com.google.web.bindery.event.shared.Event<H>
      com.google.gwt.event.shared.GwtEvent<BeforeClickHandler>
          com.sage.swt.client.widget.event.BeforeClickEvent

public class BeforeClickEvent
extends com.google.gwt.event.shared.GwtEvent<BeforeClickHandler>

Represents a before click event.

Nested Class Summary

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

com.google.gwt.event.shared.GwtEvent.Type<H>

Constructor Summary

protected

BeforeClickEvent(BeforeClickProceedCallback callback) Creates a new before click event.

Method Summary

void	cancel() Cancel the before click event.
protected void	dispatch(BeforeClickHandler handler)
static <S extends HasCancellableClickHandlers & com.google.gwt.event.shared.HasHandlers> BeforeClickEvent	fire(S source, BeforeClickProceedCallback callback) Fires a before click event on all registered handlers in the handler manager.
com.google.gwt.event.shared.GwtEvent.Type<BeforeClickHandler>	getAssociatedType()
BeforeClickProceedCallback	getCallback() Returns the callback that allows the next handler for this event to be called.
static com.google.gwt.event.shared.GwtEvent.Type<BeforeClickHandler>	getType() Gets the type associated with this event.
boolean	isCanceled() Has the click event already been canceled?

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

BeforeClickEvent

protected BeforeClickEvent(BeforeClickProceedCallback callback)

Creates a new before click event.

Method Detail

fire

public static <S extends HasCancellableClickHandlers & com.google.gwt.event.shared.HasHandlers> BeforeClickEvent fire(S source,
                                                                                                                     BeforeClickProceedCallback callback)

Fires a before click event on all registered handlers in the handler manager. If no such handlers exist, this method will do nothing.

Parameters:

source - the source of the handlers

Returns:

the event so that the caller can check if it was canceled, or null if no handlers of this event type have been registered

getType

public static com.google.gwt.event.shared.GwtEvent.Type<BeforeClickHandler> getType()

Gets the type associated with this event.

Returns:

returns the handler type

cancel

public void cancel()

Cancel the before click event. Classes overriding this method should still call super.cancel().

getAssociatedType

public final com.google.gwt.event.shared.GwtEvent.Type<BeforeClickHandler> getAssociatedType()

Overrides:

getAssociatedType in class com.google.gwt.event.shared.GwtEvent<BeforeClickHandler>

isCanceled

public boolean isCanceled()

Has the click event already been canceled?

Returns:

is canceled

getCallback

public BeforeClickProceedCallback getCallback()

Returns the callback that allows the next handler for this event to be called.

Returns:

the callback that allows the next handler for this event to be called.

dispatch

protected void dispatch(BeforeClickHandler handler)

Specified by:

dispatch in class com.google.gwt.event.shared.GwtEvent<BeforeClickHandler>