com.sencha.gxt.data.shared.loader

Class BeforeLoadEvent<C>

java.lang.Object

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

com.google.gwt.event.shared.GwtEvent<BeforeLoadEvent.BeforeLoadHandler<C>>

com.sencha.gxt.data.shared.loader.BeforeLoadEvent<C>

All Implemented Interfaces:

CancellableEvent

public class BeforeLoadEvent<C>
extends GwtEvent<BeforeLoadEvent.BeforeLoadHandler<C>>
implements CancellableEvent

Event type for loader events.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BeforeLoadEvent.BeforeLoadHandler<C> Handler class for BeforeLoadEvent events.
static interface	BeforeLoadEvent.HasBeforeLoadHandlers<C> A widget that implements this interface is a public source of BeforeLoadEvent events.

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

GwtEvent.Type<H>

Constructor Summary

Constructors

Constructor and Description
BeforeLoadEvent(C loadConfig) Creates a before load event.

Method Summary

Methods

Modifier and Type	Method and Description
GwtEvent.Type<BeforeLoadEvent.BeforeLoadHandler<C>>	getAssociatedType()
C	getLoadConfig() Returns the load config.
static GwtEvent.Type<BeforeLoadEvent.BeforeLoadHandler<?>>	getType() Gets the type associated with this event.
boolean	isCancelled() Returns true if the event is cancelled.
void	setCancelled(boolean cancel) True to cancel the event.

Methods inherited from class com.google.gwt.event.shared.GwtEvent

getSource

Methods inherited from class com.google.web.bindery.event.shared.Event

toDebugString, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BeforeLoadEvent

public BeforeLoadEvent(C loadConfig)

Creates a before load event.

Parameters:

loadConfig - the load configuration that will be used to load the data

Method Detail

getType

public static GwtEvent.Type<BeforeLoadEvent.BeforeLoadHandler<?>> getType()

Gets the type associated with this event.

Returns:

returns the handler type

getAssociatedType

public GwtEvent.Type<BeforeLoadEvent.BeforeLoadHandler<C>> getAssociatedType()

Overrides:

getAssociatedType in class GwtEvent<BeforeLoadEvent.BeforeLoadHandler<C>>

getLoadConfig

public C getLoadConfig()

Returns the load config.

Returns:

the load config

isCancelled

public boolean isCancelled()

Description copied from interface: CancellableEvent

Returns true if the event is cancelled.

Specified by:

isCancelled in interface CancellableEvent

Returns:

true for cancelled

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: CancellableEvent

True to cancel the event.

Specified by:

setCancelled in interface CancellableEvent

Parameters:

cancel - true to cancel