Class

UIEvent

 

Encapsulates input event information for an event that propagates through a container and control hierarchy.

Implements W3C standard event handling. This object is passed to a function that you register to respond to events of a certain type that occur in a window or control. Use windowObj.addEventListener() or controlObj.addEventListener() to register a handler function.

QuickLinks

UIEvent, initEvent, initUIEvent, preventDefault, stopPropagation

Properties

Property	Type	Access	Description
bubbles	bool	readonly	True if the event is of a type that bubbles.
cancelable	bool	readonly	True if the default action associated with the event can be canceled with preventDefault().
captures	bool	readonly	True if this event can be captured.
currentTarget	bool	readonly	The event target object which is currently handling the event. During capturing and bubbling, this is different from the property target.
detail	Any	readonly	Passed in to initEvent(); it can e.g. be a mouse click count.
eventPhase	String	readonly	The current phase of event propagation; one of none, target, capture, bubble.
target	Object	readonly	The event target object for this event.
timeStamp	Date	readonly	The date and time at which the event occurred.
type	String	readonly	The name of the event that this Event object represents.
view	Any	readonly

Methods

Constructor

UIEvent UIEvent (type: String[, captures: bool=false][, bubbles: bool=false][, view: Object][, detail: Number])
Creates an event.
The UIEvent object is normally created by ScriptUI and passed to your event handler. However, you can simulate a user action by constructing an event object and sending it to a target object’s dispatchEvent() function.

Parameter	Type	Description
type	String	The event type. See UIEvent.type property.
captures	bool	Set to true if this event can be captured. (default: false)
bubbles	bool	Set to true if the event bubbles. (default: false)
view	Object	The ScriptUI element that this event relates to. (Optional)
detail	Number	This value sets the detail property; it can e.g. be a mouse click count. (Optional)

Instances

void initEvent (type: String[, captures: bool=false][, bubbles: bool=false][, cancelable: bool=false])
Initializes an UI event as a core W3C event.

Parameter	Type	Description
type	String	The event type.
captures	bool	Set to true if this event can be captured. (default: false)
bubbles	bool	Set to true if the event bubbles. (default: false)
cancelable	bool	Set to true if the default action is cancelable. (default: false)

void initUIEvent (type: String[, captures: bool=false][, bubbles: bool=false][, view: Object][, detail: Number])
Initializes an event.

Parameter	Type	Description
type	String	The event type.
captures	bool	Set to true if this event can be captured. (default: false)
bubbles	bool	Set to true if the event bubbles. (default: false)
view	Object	The ScriptUI element that this event relates to. (Optional)
detail	Number	This value sets the detail property; it can e.g. be a mouse click count. (Optional)

void preventDefault ()
Calling this function causes the default action associated with this event not to be called.

void stopPropagation ()
Stops the propagation of this event.

Return

UIEvent UIEvent.UIEvent (type: String[, captures: bool=false][, bubbles: bool=false][, view: Object][, detail: Number])

UIEvent Window (SUI).dispatchEvent ()

Jongware, 20-Jun-2010 v3.0.3d

Contents :: Index