Adobe 0046100128056 Scripting Guide - Page 119

Working with Event Listeners

Page 119 highlights

CHAPTER 8: Events Working with Event Listeners 119 triggering any qualifying eventListeners registered to objects above the target in the scripting object model hierarchy. The following table provides more detail on the properties of an event and the ways in which they relate to event propagation through the scripting object model. Property Bubbles Cancelable CurrentTarget DefaultPrevented EventPhase EventType PropagationStopped Target TimeStamp Description If true, the event propagates to scripting objects above the object initiating the event. If true, the default behavior of the event on its target can be canceled. To do this, use the PreventDefault method . The current scripting object processing the event. See target in this table. If true, the default behavior of the event on the current target was prevented, thereby canceling the action. See target in this table. The current stage of the event propagation process. The type of the event, as a string (for example, "beforeNew"). If true, the event has stopped propagating beyond the current target (see target in this table). To stop event propagation, use the stopPropagation method . The object from which the event originates. For example, the target of a beforeImport event is a document; of a beforeNew event, the application. The time and date when the event occurred. Working with Event Listeners When you create an eventListener, you specify the event type and the event handler (as a function or file reference). The following script fragment shows how to add an eventListener for a specific event (for the complete script, see AddEventListener). var myEventListener = app.addEventListener("afterNew", myDisplayEventType, false); The preceding script fragment refers to the following function: function myDisplayEventType(myEvent){ alert("This event is the " + myEvent.eventType + " event."); } To remove the eventListener created by the preceding script, run the following script (from the RemoveEventListener tutorial script): app.removeEventListener("afterNew", myDisplayEventType); When an eventListener responds to an event, the event may still be processed by other eventListeners that might be monitoring the event (depending on the propagation of the event). For example, the afterOpen event can be observed by eventListeners associated with both the application and the document.

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209

C
HAPTER
8: Events
Working with Event Listeners
119
triggering any qualifying
eventListeners
registered to objects above the
target
in the scripting
object model hierarchy.
The following table provides more detail on the properties of an
event
and the ways in which they relate
to event propagation through the scripting object model.
Working with Event Listeners
When you create an
eventListener
, you specify the event type and the event handler (as a function or
file reference). The following script fragment shows how to add an
eventListener
for a specific event (for
the complete script, see AddEventListener).
var myEventListener = app.addEventListener("afterNew", myDisplayEventType, false);
The preceding script fragment refers to the following function:
function myDisplayEventType(myEvent){
alert("This event is the " + myEvent.eventType + " event.");
}
To remove the
eventListener
created by the preceding script, run the following script (from the
RemoveEventListener tutorial script):
app.removeEventListener("afterNew", myDisplayEventType);
When an
eventListener
responds to an event, the event may still be processed by other
eventListeners
that might be monitoring the event (depending on the propagation of the event). For
example, the
afterOpen
event can be observed by
eventListeners
associated with both the application
and the document.
Property
Description
Bubbles
If true, the
event
propagates to scripting objects
above
the object initiating
the
event
.
Cancelable
If true, the default behavior of the
event
on its
target
can be canceled. To do
this, use the
PreventDefault
method .
CurrentTarget
The current scripting object processing the
event
. See
target
in this table.
DefaultPrevented
If true, the default behavior of the
event
on the current
target
was
prevented, thereby canceling the action. See
target
in this table.
EventPhase
The current stage of the
event
propagation process.
EventType
The type of the
event
, as a string (for example,
"beforeNew"
).
PropagationStopped
If true, the
event
has stopped propagating beyond the
current
target
(see
target
in this table). To stop event propagation, use the
stopPropagation
method .
Target
The object from which the
event
originates. For example, the
target
of a
beforeImport
event is a document; of a
beforeNew
event, the application.
TimeStamp
The time and date when the
event
occurred.