Adobe 38039927 Extended User Guide - Page 275

Using the API wrapper extension in Adobe Flash

Get Adobe 38039927 - Fireworks CS3 - PC PDF manuals and user guides
UPC - 883919091389
View all Adobe 38039927 manuals
Add to My Manuals
Save this manual to your list of manuals

Page 275 highlights

ADOBE FIREWORKS CS3 271 Extending Guide Returns Nothing. Description This function should be called whenever the user clicks the OK or Cancel buttons provided in the Flash content to execute or cancel a command. This function is used only for modal commands, not for Flash panels. Note: MMEndCommand supersedes the FWEndCommand command. However, FWEndCommand still works in the current version of Fireworks. Using the API wrapper extension in Adobe Flash You can install a special extension that was developed specifically for writing Fireworks functions in ActionScript (currently, only ActionScript 1.0) either as a replacement for the MMExecute() and MMEndCommand() functions or to be used in conjunction with them. After it is installed, the API wrapper appears in the Adobe Flash interface. This wrapper simplifies the writing of Fireworks commands. Instead of having to embed every Fireworks function in MMExecute(), you can use a series of fwapi functions in the ActionScript. Then, when it is published, the wrapper translates the fwapi functions into the expanded Fireworks functions. You can also mix the fwapi functions with MMExecute() statements. To install the API wrapper, make sure you have the Adobe Extension Manager installed and double-click the Extension file. In Adobe Flash, the wrapper appears in the Components window as FWCommandComponents. The following example shows a command without the wrapper: var path = MMExecute("fw.appPatternsDir;"); The following example shows the same command using the wrapper: var path =fwapi.getAppPatternsDir(); Working with ActionScript files You can simplify the editing task by keeping a separate ActionScript file for ActionScript; in this way, you don't need to open and edit the FLA file directly. Your FLA file must have a #include myStringFile.as statement in the first frame (where myStringFile is the name of your ActionScript file) to ensure that the ActionScript strings are complied at publishing time. Note: The FLA and ActionScript files should reside in the same folder so that the ActionScript file can be easily found for compiling. Guidelines for creating panels and commands • You need to surround nested quotation marks need with backslash (\). The following example prints: John's example is really "complex"! MMExecute('alert("John\'s example is really \"complex\"!")'; • The movie size set in Flash is used in Fireworks as the minimum and default size of the command panel. • To improve the appearance and positioning of a modeless panel, turn off scaling and align the panel contents with the upper-left corner of the Stage. You can make these changes with the following ActionScript code: Stage.align = "TC"; Stage.scaleMode = "noScale";

  • 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
  • 254
  • 255
  • 256
  • 257
  • 258
  • 259
  • 260
  • 261
  • 262
  • 263
  • 264
  • 265
  • 266
  • 267
  • 268
  • 269
  • 270
  • 271
  • 272
  • 273
  • 274
  • 275
  • 276
  • 277
  • 278
  • 279
  • 280
  • 281
  • 282
  • 283
  • 284
  • 285
  • 286
  • 287
  • 288
  • 289
  • 290
  • 291
  • 292
  • 293
  • 294
  • 295
  • 296
  • 297
  • 298
  • 299
  • 300
  • 301
  • 302
  • 303
  • 304
  • 305
  • 306
  • 307
  • 308
  • 309
  • 310
  • 311
  • 312
  • 313
  • 314
  • 315
ADOBE FIREWORKS CS3
Extending Guide
271
Returns
Nothing.
Description
This function should be called whenever the user clicks the OK or Cancel buttons provided in the Flash content to
execute or cancel a command. This function is used only for modal commands, not for Flash panels.
Note:
MMEndCommand
supersedes the
FWEndCommand
command. However,
FWEndCommand
still works in the current
version of Fireworks.
Using the API wrapper extension in Adobe Flash
You can install a special extension that was developed specifically for writing Fireworks functions in ActionScript
(currently, only ActionScript 1.0) either as a replacement for the
MMExecute()
and
MMEndCommand()
functions or
to be used in conjunction with them. After it is installed, the API wrapper appears in the Adobe Flash interface. This
wrapper simplifies the writing of Fireworks commands. Instead of having to embed every Fireworks function in
MMExecute()
, you can use a series of
fwapi
functions in the ActionScript. Then, when it is published, the wrapper
translates the
fwapi
functions into the expanded Fireworks functions. You can also mix the
fwapi
functions with
MMExecute()
statements.
To install the API wrapper, make sure you have the Adobe Extension Manager installed and double-click the
Extension file. In Adobe Flash, the wrapper appears in the Components window as FWCommandComponents.
The following example shows a command without the wrapper:
var path = MMExecute("fw.appPatternsDir;");
The following example shows the same command using the wrapper:
var path =fwapi.getAppPatternsDir();
Working with ActionScript files
You can simplify the editing task by keeping a separate ActionScript file for ActionScript; in this way, you don’t need
to open and edit the FLA file directly. Your FLA file must have a
#include
myStringFile
.as
statement in the first
frame (where
myStringFile
is the name of your ActionScript file) to ensure that the ActionScript strings are
complied at publishing time.
Note:
The FLA and ActionScript files should reside in the same folder so that the ActionScript file can be easily found
for compiling.
Guidelines for creating panels and commands
•
You need to surround nested quotation marks need with backslash (\). The following example prints:
John’s
example is really “complex”!
MMExecute('alert("John\'s example is really \"complex\"!")';
•
The movie size set in Flash is used in Fireworks as the minimum and default size of the command panel.
•
To improve the appearance and positioning of a modeless panel, turn off scaling and align the panel contents with
the upper-left corner of the Stage. You can make these changes with the following ActionScript code:
Stage.align = "TC";
Stage.scaleMode = "noScale";