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
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| bubbles | Boolean | readonly | True if the event is of a type that bubbles. |
| cancelable | Boolean | readonly | True if the default action associated with the event can be canceled with preventDefault(). |
| captures | Boolean | readonly | True if this event can be captured. |
| currentTarget | Boolean | 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 | The click count for a mouse-click event. |
| 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 object represents. Event types are listed in the JavaScript Tools Guide. |
| view | Any | readonly | The ScriptUI element that this event relates to. |
Methods
Constructor
UIEvent UIEvent (type:
String[, captures:
Boolean=false][, bubbles:
Boolean=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 | Boolean | Set to true if this event can be captured. (default: false) |
| bubbles | Boolean | Set to true if the event bubbles. (default: false) |
| view | Object | The ScriptUI element that this event relates to. (Optional) |
| detail | Number | The click count for a mouse-click event. (Optional) |
Instances
void initEvent (type:
String[, captures:
Boolean=false][, bubbles:
Boolean=false][, cancelable:
Boolean=false])
Initializes a UI event as a core W3C event.
| Parameter | Type | Description |
|---|---|---|
| type | String | The event type. |
| captures | Boolean | Set to true if this event can be captured. (default: false) |
| bubbles | Boolean | Set to true if the event bubbles. (default: false) |
| cancelable | Boolean | Set to true if the default action is cancelable. (default: false) |
void initUIEvent (type:
String[, captures:
Boolean=false][, bubbles:
Boolean=false][, view:
Object][, detail:
Number])
Initializes an event.
| Parameter | Type | Description |
|---|---|---|
| type | String | The event type. |
| captures | Boolean | Set to true if this event can be captured. (default: false) |
| bubbles | Boolean | Set to true if the event bubbles. (default: false) |
| view | Object | The ScriptUI element that this event relates to. (Optional) |
| detail | Number | The click count for a mouse-click event. (Optional) |
void preventDefault ()
Prevents the default action associated with this event from being called.
void stopPropagation ()
Stops the propagation of this event.
Return
UIEvent UIEvent.UIEvent (type: String[, captures: Boolean=false][, bubbles: Boolean=false][, view: Object][, detail: Number])
UIEvent Window (SUI).dispatchEvent ()
| Jongware, 18-Jan-2015 v1.0 | Contents :: Index |