Adobe 12040118 Using Help - Page 218

Method, Returns, Description, close [value], notify[event], onClick, onChange, onClose

Page 218 highlights

Adobe After Effects Help Using Help Method close ([value]) hide() notify([event]) show() onClick() onChange() onClose() Creating User Interface Elements Back 218 Returns no return value Description Closes a Window. For modal dialogs, the optional value is returned as the result of the show() call that caused the dialog to display and execute. no return value Hides the element. If hide() is called on a modal dialog, dismiss the dialog and set the dialog result to 0. The application may choose to ignore this call for certain UI object types. no return value Sends a notification message to whatever listens to the UI object. notify() effectively lets you control a dialog programmatically. Calling this method with no argument on a control simulates the activation of the control; a Button signals that it has been clicked via its onClick() method, an EditText element tells its listener that it contents have changed via its onChange() method, and so on. You can supply an optional argument to notify(), which is the name of the event handler to call. For instance, to simulate a dialog dlg being moved by a user, you can send a notification message as follows: dlg.notify("onMove"). Number Displays the UI object. A Window may choose to ignore the setting of the visibility state if it is not applicable, like for inspectors whose visibility is controlled by the application only. If show() is called for a modal dialog, the dialog is displayed and executed. The call to show() will not return until the dialog has been dismissed. The result of show() is the dialog result as supplied to close(). For all other elements, the result is 0. no return value This method is called when a control has been activated by clicking it. Not all types of controls implement this callback. If you are interested in processing this event, define a function of this name in the control element. no return value This method is called when the content of a control has been changed. Not all types of controls implement this callback. If you are interested in processing this event, define a function of this name in the control element. no return value This method is called when a Window is closed. If you are interested in processing this event, define a function of this name in the Window object. Using Help Back 218

  • 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
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217
  • 218
  • 219
  • 220
  • 221
  • 222
  • 223
  • 224
  • 225
  • 226
  • 227
  • 228
  • 229
  • 230
  • 231
  • 232
  • 233
  • 234
  • 235
  • 236
  • 237
  • 238
  • 239
  • 240
  • 241
  • 242
  • 243
  • 244
  • 245
  • 246
  • 247
  • 248
  • 249
  • 250
  • 251
  • 252
  • 253

U
sing H
elp
B
ack
218
Adobe After Effects Help
Creating User Interface Elements
U
sing H
elp
B
ack
218
close ([value])
no return value
Closes a
Window
. For modal dialogs, the optional
value is returned as the result of the
show()
call that
caused the dialog to display and execute.
hide()
no return value
Hides the element. If
hide()
is called on a modal dia-
log, dismiss the dialog and set the dialog result to 0.
The application may choose to ignore this call for cer-
tain UI object types.
notify([event])
no return value
Sends a notification message to whatever listens to
the UI object.
notify()
effectively lets you control a
dialog programmatically. Calling this method with
no argument on a control simulates the activation of
the control; a Button signals that it has been clicked
via its
onClick()
method, an EditText element tells its
listener that it contents have changed via its
onChange()
method, and so on. You can supply an
optional argument to
notify()
, which is the name of
the event handler to call. For instance, to simulate a
dialog
dlg
being moved by a user, you can send a
notification message as follows:
dlg.notify(“onMove”)
.
show()
Number
Displays the UI object. A
Window
may choose to
ignore the setting of the visibility state if it is not
applicable, like for inspectors whose visibility is con-
trolled by the application only. If
show()
is called for a
modal dialog, the dialog is displayed and executed.
The call to
show()
will not return until the dialog has
been dismissed. The result of
show()
is the dialog
result as supplied to
close()
. For all other elements,
the result is 0.
onClick()
no return value
This method is called when a control has been acti-
vated by clicking it. Not all types of controls imple-
ment this callback. If you are interested in processing
this event, define a function of this name in the con-
trol element.
onChange()
no return value
This method is called when the content of a control
has been changed. Not all types of controls imple-
ment this callback. If you are interested in processing
this event, define a function of this name in the con-
trol element.
onClose()
no return value
This method is called when a
Window
is closed. If you
are interested in processing this event, define a func-
tion of this name in the
Window
object.
Method
Returns
Description