com.google.gwt.event.logical.shared
Class BeforeSelectionEvent<I>

java.lang.Object
  com.google.gwt.event.shared.GwtEvent<BeforeSelectionHandler<I>>
      com.google.gwt.event.logical.shared.BeforeSelectionEvent<I>

Type Parameters:

I - the type about to be selected

public class BeforeSelectionEvent<I>
extends GwtEvent<BeforeSelectionHandler<I>>

Represents a before selection event.

BeforeSelectionEvent

protected BeforeSelectionEvent()

Creates a new before selection event.

fire

public static <I> BeforeSelectionEvent<I> fire(HasBeforeSelectionHandlers<I> source,
                                               I item)

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

Type Parameters:

I - the item type

Parameters:

source - the source of the handlers

item - the item

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 GwtEvent.Type<BeforeSelectionHandler<?>> getType()

Gets the type associated with this event.

Returns:

returns the handler type

cancel

public void cancel()

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

getAssociatedType

public final GwtEvent.Type<BeforeSelectionHandler<I>> 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<BeforeSelectionHandler<I>>

Returns:

the type

getItem

public I getItem()

Gets the item.

Returns:

the item

isCanceled

public boolean isCanceled()

Has the selection event already been canceled?

Returns:

is canceled

dispatch

protected void dispatch(BeforeSelectionHandler<I> handler)

Description copied from class: GwtEvent

Should only be called by HandlerManager. In other words, do not use or call.

Specified by:

dispatch in class GwtEvent<BeforeSelectionHandler<I>>

Parameters:

handler - handler

setItem

protected final void setItem(I item)

Sets the item.

Parameters:

item - the item