com.sencha.gxt.data.shared.loader

Class BeforeLoadEvent<C>

java.lang.Object

<any>

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

All Implemented Interfaces:

CancellableEvent

public class BeforeLoadEvent<C>
extends <any>
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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	dispatch(BeforeLoadEvent.BeforeLoadHandler<C> handler)
<any>	getAssociatedType()
C	getLoadConfig() Returns the load config.
static <any>	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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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 <any> getType()

Gets the type associated with this event.

Returns:

returns the handler type

getAssociatedType

public <any> getAssociatedType()

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

dispatch

protected void dispatch(BeforeLoadEvent.BeforeLoadHandler<C> handler)