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, ColumnConfig, ColumnModel, ComponentManager, Dispatcher, Draggable, DragSource, DropTarget, Fx, GridView, KeyNav, Layout, Provider, Registry, Resizable, Store, StoreBinder, TableColumnModel, WindowManager

public class BaseObservable
extends java.lang.Object
implements Observable

Constructor Summary

BaseObservable()

Method Summary

void	addListener(int eventType, Listener listener) Adds a listener bound by the given event type.
boolean	fireEvent(int eventType) Fires an event.
boolean	fireEvent(int eventType, BaseEvent be) Fires an event.
boolean	getFiresEvents() Returns true if events are being fired.
boolean	hasListeners() Returns true if the observable has any listeners.
boolean	hasListeners(int eventType) Returns true if the obsersable has listeners for the given event type.
void	removeAllListeners() Removes all listeners.
void	removeListener(int eventType, Listener 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(int eventType,
                        Listener 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

fireEvent

public boolean fireEvent(int eventType)

Fires an event.

Parameters:

eventType - the event type

Returns:

true if any listeners cancel the event.

fireEvent

public boolean fireEvent(int 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

hasListeners

public boolean hasListeners()

Returns true if the observable has any listeners.

Returns:

true for listeners

hasListeners

public boolean hasListeners(int eventType)

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

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(int eventType,
                           Listener 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