com.extjs.gxt.ui.client.event
Class BaseEvent

java.lang.Object
  com.extjs.gxt.ui.client.event.BaseEvent

Direct Known Subclasses:

AppEvent, BindingEvent, CheckChangedEvent, ClickRepeaterEvent, ColumnModelEvent, ComponentManagerEvent, DomEvent, FilterEvent, FxEvent, LayoutEvent, LoadEvent, MvcEvent, ResizeEvent, RowExpanderEvent, SelectionChangedEvent, SelectionEvent, StateEvent, StoreEvent, WindowManagerEvent

public class BaseEvent
extends java.lang.Object

Base class for all GXT events.

Note: For a given event, only the fields which are appropriate will be filled in. The appropriate fields for each event are documented by the event source.

Constructor Summary

BaseEvent(EventType type)

BaseEvent(java.lang.Object source)
Creates a new base event instance.

Method Summary

java.lang.Object	getSource() Returns the object that fired the event.
EventType	getType() Returns the event's event type.
boolean	isCancelled() Returns true if the operation is being cancelled.
void	setCancelled(boolean cancelled) True to cancel the current operation (defaults to false).
void	setSource(java.lang.Object source) Sets the object that fired the event.
void	setType(EventType type) Sets the event's event type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseEvent

public BaseEvent(EventType type)

BaseEvent

public BaseEvent(java.lang.Object source)

Creates a new base event instance.

Parameters:

source - the source object

Method Detail

isCancelled

public boolean isCancelled()

Returns true if the operation is being cancelled.

Returns:

true if cancelled

setCancelled

public void setCancelled(boolean cancelled)

True to cancel the current operation (defaults to false). Only applies to events that can be cancelled as defined by the object firing the event. Canceling an operation does not stop all listeners from being notified of the event.

Parameters:

cancelled - true to cancel

getSource

public java.lang.Object getSource()

Returns the object that fired the event.

Returns:

the object that fired the event

getType

public EventType getType()

Returns the event's event type.

Returns:

the event type

setSource

public void setSource(java.lang.Object source)

Sets the object that fired the event.

Parameters:

source - the source object

setType

public void setType(EventType type)

Sets the event's event type.

Parameters:

type - the event type