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

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

All Implemented Interfaces:

Observable

Direct Known Subclasses:

AbstractStoreSelectionModel, BaseEventPreview, BaseLoader, Bindings, ClickRepeater, ColumnConfig, ColumnModel, ComponentManager, Dispatcher, Draggable, DragSource, DropTarget, FocusFrame, Fx, GridView, KeyNav, Layout, Provider, Registry, Resizable, Store, StoreBinder, TableColumnModel, WindowManager

public class BaseObservable
extends java.lang.Object
implements Observable

Default implementation of the Observable interface.

 Observable observable = new BaseObservable();
 observable.addListener(Events.Select, new Listener<BaseEvent>() {
   public void handleEvent(BaseEvent be) {
 
   }
 });
 observable.fireEvent(Events.Select, new BaseEvent());
 

Constructor Summary

BaseObservable()

Method Summary

void	addListener(EventType eventType, Listener<? extends BaseEvent> listener) Adds a listener bound by the given event type.
boolean	fireEvent(EventType eventType) Fires an event.
boolean	fireEvent(EventType eventType, BaseEvent be) Fires an event.
boolean	getFiresEvents() Returns true if events are being fired.
java.util.List<Listener<? extends BaseEvent>>	getListeners(EventType eventType) Returns a list of listeners registered for the given event type.
boolean	hasActiveEvent() Returns true if there is an active event
boolean	hasListeners() Returns true if the observable has any listeners.
boolean	hasListeners(EventType eventType) Returns true if the observable has listeners for the given event type.
void	removeAllListeners() Removes all listeners.
void	removeListener(EventType eventType, Listener<? extends BaseEvent> listener) Removes a listener.
void	setFiresEvents(boolean firesEvents) Sets whether events should be fired (defaults to true).

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseObservable

public BaseObservable()

Method Detail

addListener

public void addListener(EventType eventType,
                        Listener<? extends BaseEvent> listener)

Adds a listener bound by the given event type.

Specified by:

addListener in interface Observable

Parameters:

eventType - the eventType

listener - the listener to be added

getListeners

public java.util.List<Listener<? extends BaseEvent>> getListeners(EventType eventType)

Description copied from interface: Observable

Returns a list of listeners registered for the given event type. The returned list may be modified.

Specified by:

getListeners in interface Observable

Parameters:

eventType - the event type

Returns:

the list of listeners

fireEvent

public boolean fireEvent(EventType eventType)

Fires an event.

Parameters:

eventType - the event type

Returns:

true if any listeners cancel the event.

fireEvent

public boolean fireEvent(EventType eventType,
                         BaseEvent be)

Fires an event.

Specified by:

fireEvent in interface Observable

Parameters:

eventType - eventType the event type

be - the base event

Returns:

true if any listeners cancel the event.

getFiresEvents

public boolean getFiresEvents()

Returns true if events are being fired.

Returns:

the fire event state

hasActiveEvent

public boolean hasActiveEvent()

Returns true if there is an active event

Returns:

the active event start

hasListeners

public boolean hasListeners()

Description copied from interface: Observable

Returns true if the observable has any listeners.

Specified by:

hasListeners in interface Observable

Returns:

true for any listeners

hasListeners

public boolean hasListeners(EventType eventType)

Description copied from interface: Observable

Returns true if the observable has listeners for the given event type.

Specified by:

hasListeners in interface Observable

Parameters:

eventType - the event type

Returns:

true for 1 or more listeners with the given event type

removeAllListeners

public void removeAllListeners()

Removes all listeners.

Specified by:

removeAllListeners in interface Observable

removeListener

public void removeListener(EventType eventType,
                           Listener<? extends BaseEvent> listener)

Removes a listener.

Specified by:

removeListener in interface Observable

Parameters:

eventType - the event type

listener - the listener to be removed

setFiresEvents

public void setFiresEvents(boolean firesEvents)

Sets whether events should be fired (defaults to true).

Parameters:

firesEvents - true to fire events, false to disable events