com.extjs.gxt.ui.client.event
Interface Observable

All Known Subinterfaces:
ListLoader<D>, Loader<D>, PagingLoader<D>, RemoteSortTreeLoader<M>, TreeLoader<M>
All Known Implementing Classes:
AbsoluteLayout, AbstractStoreSelectionModel, AccordionLayout, AdapterField, AdapterMenuItem, AnchorLayout, BaseEventPreview, BaseListLoader, BaseLoader, BaseObservable, BasePagingLoader, BaseRemoteSortTreeLoader, BaseTreeLoader, Bindings, BooleanFilter, BorderLayout, BoxComponent, BoxLayout, BufferView, Button, ButtonBar, ButtonGroup, CardLayout, CardPanel, CellEditor, CellSelectionModel, CellTreeGridSelectionModel, CenterLayout, Chart, CheckBox, CheckBoxGroup, CheckBoxListView, CheckBoxSelectionModel, CheckColumnConfig, CheckMenuItem, ClickRepeater, CollapsePanel, ColorMenu, ColorPalette, ColumnConfig, ColumnFooter, ColumnFooter.FooterRow, ColumnHeader, ColumnHeader.GridSplitBar, ColumnHeader.Group, ColumnHeader.Head, ColumnLayout, ColumnModel, ComboBox, Component, ComponentManager, Composite, Container, ContentPanel, CookieProvider, DataList, DataListBinder, DataListItem, DataView, DataViewBinder, DataViewItem, DateField, DateFilter, DateMenu, DatePicker, Dialog, Dispatcher, Document, Draggable, DragSource, DropTarget, DualListField, Editor, EditorGrid, EditorTreeGrid, Field, FieldSet, FileUploadField, FillLayout, FillToolItem, Filter, FitLayout, FlashComponent, FlowLayout, FocusFrame, FocusManagerSupport, FormBinding, FormLayout, FormPanel, FramePanel, Fx, Grid, GridDragSource, GridDropTarget, GridSelectionModel, GridView, GroupingStore, GroupingView, GroupSummaryView, HBoxLayout, Header, HeaderMenuItem, HiddenField, HorizontalPanel, Html, HtmlContainer, HtmlEditor, HtmlEditor.rte, IconButton, Info, InputSlider, Insert, Item, KeyNav, Label, LabelField, LabelToolItem, Layout, LayoutContainer, ListField, ListFilter, ListMenu, ListStore, ListView, ListViewDragSource, ListViewDropTarget, ListViewSelectionModel, LiveGridView, LiveToolItem, Menu, MenuBar, MenuBarItem, MenuItem, MenuLayout, ModalPanel, MultiField, NumberField, NumericFilter, PagingToolBar, Popup, Portal, Portlet, ProgressBar, Provider, QuickTip, Radio, RadioGroup, RangeMenu, Registry, Resizable, RootTreeTableItem, RowEditor, RowExpander, RowLayout, RowNumberer, ScrollContainer, SeparatorMenuItem, SeparatorToolItem, Shortcut, SimpleComboBox, Slider, SliderField, SpinnerField, SplitBar, SplitButton, StartMenu, Status, StatusProxy, Store, StoreBinder, StoreFilterField, StringFilter, SummaryColumnConfig, TabItem, TabItem.HeaderItem, Table, TableBinder, TableColumnModel, TableColumnUI, TableHeader, TableItem, TableLayout, TableRowLayout, TabPanel, TaskBar, Text, TextArea, TextField, ThemeSelector, TimeField, Tip, ToggleButton, ToolBar, ToolBarLayout, ToolButton, ToolTip, Tree, TreeBinder, TreeDragSource, TreeDropTarget, TreeGrid, TreeGridDragSource, TreeGridDropTarget, TreeGridSelectionModel, TreeGridView, TreeItem, TreePanel, TreePanelDragSource, TreePanelDropTarget, TreePanelSelectionModel, TreeStore, TreeTable, TreeTableBinder, TreeTableColumnModel, TreeTableHeader, TreeTableItem, TriggerField, TwinTriggerField, VBoxLayout, VerticalPanel, Viewport, WidgetComponent, Window, WindowManager

public interface Observable

Abstract base class for objects that register listeners and fire events.

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

      }
    });
    observable.fireEvent(Events.Select, new BaseEvent()); 
 

See Also:
Listener, BaseEvent

Method Summary
 void addListener(EventType eventType, Listener<? extends BaseEvent> listener)
          Adds a listener bound by the given event type.
 boolean fireEvent(EventType eventType, BaseEvent be)
          Fires an event.
 java.util.List<Listener<? extends BaseEvent>> getListeners(EventType eventType)
          Returns a list of listeners registered for the given event type.
 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.
 

Method Detail

addListener

void addListener(EventType eventType,
                 Listener<? extends BaseEvent> listener)
Adds a listener bound by the given event type.

Parameters:
eventType - the eventType
listener - the listener to be added

fireEvent

boolean fireEvent(EventType eventType,
                  BaseEvent be)
Fires an event.

Parameters:
eventType - eventType the event type
be - the base event
Returns:
false if any listeners cancel the event.

getListeners

java.util.List<Listener<? extends BaseEvent>> getListeners(EventType eventType)
Returns a list of listeners registered for the given event type. The returned list may be modified.

Parameters:
eventType - the event type
Returns:
the list of listeners

hasListeners

boolean hasListeners()
Returns true if the observable has any listeners.

Returns:
true for any listeners

hasListeners

boolean hasListeners(EventType eventType)
Returns true if the observable 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

void removeAllListeners()
Removes all listeners.


removeListener

void removeListener(EventType eventType,
                    Listener<? extends BaseEvent> listener)
Removes a listener.

Parameters:
eventType - the event type
listener - the listener to be removed