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

class Event

Object
  |
  +--xp.events.Event

All Known Subclasses: ButtonEditorEvent, ChartMouseEvent, CommandEvent, CompletedEvent, DialogResultEvent, DragDropEvent, FaultEvent, ItemChangeEvent, ItemEvent, KeyEvent, ListItemEvent, MarkerEvent, MenuEvent, ModelChangedEvent, MouseMoveEvent, MouseWheelEvent, NodeEvent, PanelEvent, ProgressEvent, PropertyChangedEvent, ResponseEvent, ResultEvent, RPCStatusEvent, RPCValidateParamsEvent, StateEvent, ValueChangedEvent
class Event
extends Object

The base class for all events. This class is also used for all events without event arguments.

XPComponents use a dispatcher/listener event model. When a component broadcasts an event, the event is handled by a function (also called a handler) that is attached to a listener object (listenerObject) that you create. You call the addEventListener() method and pass it the name of the handler as a parameter. When the event is triggered, it automatically passes an event object (eventObject) to the handler. Each event object has properties that contain information about the event. You can use these properties to write code that handles the event


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:
support@epresenterplus.com

Field Summary

public
bubbles: Boolean
Controls wheher this event can be routed or bubbled

public
cancel: Boolean
Gets or sets a value indicating whether the event should be canceled.

public
currentTarget: Object
Used to indicate the EventTarget whose EventListeners are currently being processed.

public
handled: Boolean
Has this event been handled

public
target: Object
The target of the event

public
type: String
The type or name of event

Constructor

public
Event ( type: String)
Constructs a new event


Field Documentation

bubbles

public var bubbles: Boolean
Controls wheher this event can be routed or bubbled

Controls will route or bubble events to their parents when dispatched

cancel

public var cancel: Boolean
Gets or sets a value indicating whether the event should be canceled.

Not all events can be cancelled. See xp.events.EventTypes and particular event for details Setting this property has no effect on events that are not cancelable. Events that are cancelable usually end in "ing" like selecting, loading etc.

currentTarget

public var currentTarget: Object
Used to indicate the EventTarget whose EventListeners are currently being processed.

This is particularly useful during event bubbling.

handled

public var handled: Boolean
Has this event been handled

Routed events will stop being bubbled if this property is set to true

target

public var target: Object
The target of the event

The object raising the event

type

public var type: String
The type or name of event

The type or name of event

Constructor Documentation

Event

public function Event(type: String)
Constructs a new event

The documentation was generated from the following file:

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