Adobe 12040118 Using Help - Page 205

button, panel, dialog

Page 205 highlights

Adobe After Effects Help Using Help Creating User Interface Elements Back 205 Each class of UI element has a set of callback methods defined for it. For windows, there are callbacks like onClose(), onMove(), and onResize(). For controls, callbacks vary from type to type. A typical callback is onClick() for button, radiobutton, and checkbox elements, and onChange() for edittext fields, scrollbars, and sliders. To handle a given event for some UI element, simply define a property of the same name as the event callback in the element and assign a JavaScript function you have defined to it. The example below uses "in line" functions, which employ a unique syntax and do not require a name. However, you can also define the function elsewhere in the script. In that case, simply assign the name of the function to the event handler property. The scripting user interface calls these functions on event notifications if defined. Examples: /*'has buttons' checkbox enables or disables the panel that determines the justification of the 'alert' button group */ dlg.hasBtnsCb.onClick = function () { this.parent.alertBtnsPnl.enabled = this.value; }; //The Build and Cancel buttons close this dialog with (dlg.btnPnl) { buildBtn.onClick = function () { this.parent.parent.close(1); }; cancelBtn.onClick = function () { this.parent.parent.close(2); }; }; Because event callback functions work as methods of the object in which they are defined, the functions have access to the object via the "this" JavaScript keyword. In the examples above, "this" refers to the UI object a given callback is defined in, so properties of the UI object can be accessed relative to the "this". For example, because each UI object has a parent property which is a reference to its container object, this.parent gets you a reference to the object's parent object. To elaborate further on this point, a button( ) is contained within a panel, which is contained within a window, all of which are ultimately closed. The progression is from smaller to larger UI moving from left to right. buildBtn.onClick = function () {this.parent.parent.close(1);}; button panel dialog Also be aware that you can simulate user actions by sending an event notification directly to a UI element, via the element's notify() method. In this manner, a script can generate events in the controls of a window, as if a user was clicking buttons, entering text, moving a window, etc. radiobutton and checkbox elements have a boolean value property; using notify() to simulate a click on these elements also changes the value of this property, just like clicking the element would do. For instance, if the value of a checkbox 'hasBtnsCb' in our example above is true, the following example changes the value to false: if (dlg.hasBtnsCb.value == true) dlg.hasBtnsCb.notify(); // dlg.hasBtnsCb.value is now false For a complete description of the different event callback methods and notify(), see "Common methods and event handlers" on page 217. Using Help Back 205

  • 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
205
Adobe After Effects Help
Creating User Interface Elements
U
sing H
elp
B
ack
205
Each class of UI element has a set of callback methods defined for it. For windows, there are callbacks like
onClose(), onMove(), and onResize()
. For controls, callbacks vary from type to type. A typical callback is
onClick()
for button, radiobutton, and checkbox elements, and
onChange()
for edittext fields, scrollbars, and
sliders.
To handle a given event for some UI element, simply define a property of the same name as the event callback
in the element and assign a JavaScript function you have defined to it. The example below uses "in line"
functions, which employ a unique syntax and do not require a name. However, you can also define the
function elsewhere in the script. In that case, simply assign the name of the function to the event handler
property. The scripting user interface calls these functions on event notifications if defined.
Examples:
/*‘has buttons’ checkbox enables or disables the panel that
determines the justification of the ‘alert’ button group */
dlg.hasBtnsCb.onClick =
function () { this.parent.alertBtnsPnl.enabled = this.value; };
//The Build and Cancel buttons close this dialog
with (dlg.btnPnl) {
buildBtn.onClick =
function () { this.parent.parent.close(1); };
cancelBtn.onClick =
function () { this.parent.parent.close(2); };
};
Because event callback functions work as methods of the object in which they are defined, the functions have
access to the object via the “this” JavaScript keyword. In the examples above, “this” refers to the UI object a
given callback is defined in, so properties of the UI object can be accessed relative to the “this”. For example,
because each UI object has a
parent
property which is a reference to its container object,
this.parent
gets you a
reference to the object’s parent object.
To elaborate further on this point, a
button( )
is contained within a panel, which is contained within a window,
all of which are ultimately closed. The progression is from smaller to larger UI moving from left to right.
Also be aware that you can simulate user actions by sending an event notification directly to a UI element, via
the element’s
notify()
method. In this manner, a script can generate events in the controls of a window, as if a
user was clicking buttons, entering text, moving a window, etc.
radiobutton
and
checkbox
elements have a boolean
value
property; using
notify()
to simulate a click on these
elements also changes the value of this property, just like clicking the element would do. For instance, if the
value
of a
checkbox
hasBtnsCb
’ in our example above is true, the following example changes the value to false:
if (dlg.hasBtnsCb.value == true)
dlg.hasBtnsCb.notify();
// dlg.hasBtnsCb.value is now false
For a complete description of the different event callback methods and notify(), see “Common methods and
event handlers” on page 217
.
buildBtn.onClick = function () {this.parent.parent.close(1);};
button
panel
dialog