Main Page | Packages | Class Tree | Index | Help
Previous | NextFrames | No Frames
Summary: Field | Property | Contructor | MethodDetail: Field | Property | Contructor | Method
xp.system

class DispatcherObject

Object
  |
  +--xp.system.DispatcherObject

All Known Subclasses: Connector, ContentLoaderListener, DBMSResolver, EventBroadcaster, FileDownloadManager, FileUploadManager, ItemDataSource, ListCollection, TimeSeriesDataProvider, TreeEditManager, XMLLoader
class DispatcherObject
extends Object

Base class for all objects that dispatch events.


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:
support@epresenterplus.com, xp.events.EventDispatcher, xp.events.Event

Field Summary

public
parent: Object
A parent or host object to route events to

Constructor

public
DispatcherObject ( )
Constructor

Method Summary

public
addEventListener ( event: String, obj: Object, handler: String ): Void
Registers a listener to an object instance.

public
removeEventListener ( event: String, obj: Object ): Void
Removes a registered listener from an object instance.

public
routeEvent ( e: Event ): Void
Routes an event to the parent if the routeEvents property is true.


Field Documentation

parent

public var parent: Object
A parent or host object to route events to

Constructor Documentation

DispatcherObject

public function DispatcherObject()
Constructor

Initializes the dispatcher

Method Documentation

addEventListener

public function addEventListener(event: String,
 obj: Object,
 handler: String): Void
Registers a listener to an object instance.

See also:
xp.events.EventDispatcher

removeEventListener

public function removeEventListener(event: String,
 obj: Object): Void
Removes a registered listener from an object instance.

See also:
xp.events.EventDispatcher

routeEvent

public function routeEvent(e: Event): Void
Routes an event to the parent if the routeEvents property is true.

Parameters:
e
A reference to an event object. The event object must have a type property that is a string indicating the name of the event. Generally, the event object also has a target property that is the name of the instance broadcasting the event. You can define other properties on the event object that will help a user capture information about the event when it is dispatched.

The documentation was generated from the following file:

Generated on 10/30/2005 9:34:02 PM by AS2Doc