Print Friendly

Class Ext.util.Observable

Package:Ext.util
Class:Observable
Extends:Object
Subclasses:BasicDialog, BasicLayoutRegion, Button, ContentPanel, LayoutManager, LayoutRegion, Resizable, SplitBar, TabPanel, TabPanelItem, UpdateManager, View, Node, Tree, AbstractSelectionModel, CellSelectionModel, ColumnModel, Grid, RowSelectionModel, DefaultSelectionModel, MultiSelectionModel, ClickRepeater
Defined In:Observable.js
Abstract base class that provides a common interface for publishing events. Subclasses are expected to to have a property "events" with all the events defined.
For example:
var Employee = function(name){
    this.name = name;
    this.events = {
        'fired' : true,
        'quit' : true
    }
 }
 YAHOO.extend(Employee, Ext.util.Observable);

Properties   -  Methods   -  Events

Public Properties

This class has no public properties.

Public Methods

Method Defined By
  Observable.capture(Observable o, Function fn, [Object scope]) : void Observable
<static> Starts capture on the specified Observable. All events will be passed to the supplied function with th...
  Observable.releaseCapture(Observable o) : void Observable
<static> Removes all added captures from the Observable.
  addListener(String eventName, Function handler, [Object options]) : void Observable
Appends an event handler to this component
  fireEvent(String eventName, Object... args) : Boolean Observable
Fires the specified event with the passed parameters (minus the event name).
  on(String eventName, Function handler, [Object options]) : void Observable
Appends an event handler to this element (shorthand for addListener)
  purgeListeners() : void Observable
Removes all listeners for this object
  removeListener(String eventName, Function handler, [Object scope]) : void Observable
Removes a listener
  un(String eventName, Function handler, [Object scope]) : void Observable
Removes a listener (shorthand for removeListener)

Public Events

This class has no public events.

Method Details

Observable.capture

public function Observable.capture(Observable o, Function fn, [Object scope])
<static> Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + standard signature of the event before the event is fired. If the supplied function returns false, the event will not fire.
Parameters:
  • o : Observable
    The Observable to capture
  • fn : Function
    The function to call
  • scope : Object
    (optional) The scope (this object) for the fn
Returns:
  • void
This method is defined by Observable.

Observable.releaseCapture

public function Observable.releaseCapture(Observable o)
<static> Removes all added captures from the Observable.
Parameters:
  • o : Observable
    The Observable to release
Returns:
  • void
This method is defined by Observable.

addListener

public function addListener(String eventName, Function handler, [Object options])
Appends an event handler to this component
Parameters:
  • eventName : String
    The type of event to listen for
  • handler : Function
    The method the event invokes
  • options : Object
    (optional)
Returns:
  • void
This method is defined by Observable.

fireEvent

public function fireEvent(String eventName, Object... args)
Fires the specified event with the passed parameters (minus the event name).
Parameters:
  • eventName : String
  • args : Object...
    Variable number of parameters are passed to handlers
Returns:
  • Boolean
    returns false if any of the handlers return false otherwise it returns true
This method is defined by Observable.

on

public function on(String eventName, Function handler, [Object options])
Appends an event handler to this element (shorthand for addListener)
Parameters:
  • eventName : String
    The type of event to listen for
  • handler : Function
    The method the event invokes
  • options : Object
    (optional)
Returns:
  • void
This method is defined by Observable.

purgeListeners

public function purgeListeners()
Removes all listeners for this object
Parameters:
  • None.
Returns:
  • void
This method is defined by Observable.

removeListener

public function removeListener(String eventName, Function handler, [Object scope])
Removes a listener
Parameters:
  • eventName : String
    The type of event to listen for
  • handler : Function
    The handler to remove
  • scope : Object
    (optional) The scope (this object) for the handler
Returns:
  • void
This method is defined by Observable.

un

public function un(String eventName, Function handler, [Object scope])
Removes a listener (shorthand for removeListener)
Parameters:
  • eventName : String
    The type of event to listen for
  • handler : Function
    The handler to remove
  • scope : Object
    (optional) The scope (this object) for the handler
Returns:
  • void
This method is defined by Observable.

yui-ext - Copyright © 2006 Jack Slocum. | Yahoo! UI - Copyright © 2006 Yahoo! Inc.
All rights reserved.