com.sencha.gxt.widget.core.client.event

Class BeforeAddEvent

java.lang.Object

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

com.google.gwt.event.shared.GwtEvent<BeforeAddEvent.BeforeAddHandler>

com.sencha.gxt.widget.core.client.event.BeforeAddEvent

All Implemented Interfaces:

CancellableEvent

public class BeforeAddEvent
extends GwtEvent<BeforeAddEvent.BeforeAddHandler>
implements CancellableEvent

Fires before a widget is added to a container.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BeforeAddEvent.BeforeAddHandler Handler for BeforeAddEvent events.
static interface	BeforeAddEvent.HasBeforeAddHandlers A widget that implements this interface is a public source of BeforeAddEvent events.

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

GwtEvent.Type<H>

Constructor Summary

Constructors

Constructor and Description
BeforeAddEvent(Widget widget, int index)

Method Summary

Methods

Modifier and Type	Method and Description
GwtEvent.Type<BeforeAddEvent.BeforeAddHandler>	getAssociatedType()
int	getIndex() Returns the insert index of the widget to be added.
Container	getSource()
static GwtEvent.Type<BeforeAddEvent.BeforeAddHandler>	getType() Gets the type associated with this event.
Widget	getWidget() Returns the widget to be added.
boolean	isCancelled() Returns true if the event is cancelled.
void	setCancelled(boolean cancelled) True to cancel the event.

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

BeforeAddEvent

public BeforeAddEvent(Widget widget,
              int index)

Method Detail

getType

public static GwtEvent.Type<BeforeAddEvent.BeforeAddHandler> getType()

Gets the type associated with this event.

Returns:

returns the handler type

getAssociatedType

public GwtEvent.Type<BeforeAddEvent.BeforeAddHandler> getAssociatedType()

Overrides:

getAssociatedType in class GwtEvent<BeforeAddEvent.BeforeAddHandler>

getIndex

public int getIndex()

Returns the insert index of the widget to be added.

Returns:

the insert index

getSource

public Container getSource()

Overrides:

getSource in class GwtEvent<BeforeAddEvent.BeforeAddHandler>

getWidget

public Widget getWidget()

Returns the widget to be added.

Returns:

the widget to be added

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 cancelled)

Description copied from interface: CancellableEvent

True to cancel the event.

Specified by:

setCancelled in interface CancellableEvent

Parameters:

cancelled - true to cancel