Adobe 65011817 Extended User Guide - Page 196

Fireworks functions

Page 196 highlights

Last updated 12/8/2009 EXTENDING FIREWORKS 192 The Fireworks Object Property textInsertionIndex • textInsertionLength • textOutputEncoding userJsCommandsDir Data type integer integer string string userSmartShapesDir • userSmartShapeToolsDir • userSymbolLibrariesDir • userSwfCommandsDir string string string string xhtmlFormat Boolean Notes Insertion index into the current active text object. If there is no text selected, returns a value of -1. Insertion length into the current active text object. If there is no text selected, returns a value of -1. The default text encoding for any text file that the JavaScript interpreter generates. Use "iso-8859-1" for ASCII or "utf-8" for Unicode. The path to the user-level Commands directory, which is expressed as a file://URL. In Fireworks, this folder is stored on a per-user basis on multiuser systems. Even on single-user systems, this folder is not inside the Fireworks installation directory. The path to the user's Auto Shapes directory, which is expressed as a file://URL The path to the user's Auto Shape Tools directory, which is expressed as a file://URL. The path to the user's Symbol Libraries, which is expressed as file://URL. The path to the user-level SWF Commands directory, which is expressed as a file://URL. In Fireworks, this folder is stored on a per-user basis on multiuser systems. Even on single-user systems, this folder is not inside the Fireworks installation directory. Determines whether the JavaScript interpreter should output XHTML formatted files or HTML formatted files; XHTML (true) or HTML (false). Fireworks functions In Fireworks CS4, fw is synonymous with the Fireworks object. All methods of the Fireworks object can be referred to as fireworks.functionName() or as fw.functionName(). fw.browseDocument() Availability Fireworks 3. Usage fw.browseDocument(URL) Arguments URL The URL of the page appear in the browser. Any legal URL (including http://, ftp://, and so on) can be passed. Fireworks does not check this argument for syntax; if you pass an illegal value, the browser does not open the URL.

  • 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
  • 316
  • 317
  • 318
  • 319
  • 320
  • 321
  • 322
  • 323
  • 324
  • 325
  • 326
  • 327
  • 328
  • 329
  • 330
  • 331
  • 332
  • 333
  • 334
  • 335
  • 336

192
EXTENDING FIREWORKS
The Fireworks Object
Las
t
up
d
a
ted
12/8/2009
Fireworks functions
In Fireworks CS4,
fw
is synonymous with the Fireworks object
.
All methods of the Fireworks object can be referred
to as
fireworks.
functionName()
or as
fw
.functionName()
.
fw.browseDocument()
Availability
Fireworks 3.
Usage
fw.browseDocument(
URL
)
Arguments
URL
The URL of the page appear in the browser. Any legal URL (including http://, ftp://, and so on) can be passed.
Fireworks does not check this argument for syntax; if you pass an illegal value, the browser does not open the URL.
textInsertionIndex
integer
Insertion index into the current active text object. If there is no
text selected, returns a value of -1.
textInsertionLength
integer
Insertion length into the current active text object. If there is no
text selected, returns a value of -1.
textOutputEncoding
string
The default text encoding for any text file that the JavaScript
interpreter generates.
Use
"iso-8859-1"
for ASCII or
"utf-8"
for Unicode.
userJsCommandsDir
string
The path to the user-level Commands directory, which is
expressed as a file://URL.
In Fireworks, this folder is stored on a per-user basis on
multiuser systems. Even on single-user systems, this folder is
not inside the Fireworks installation directory.
userSmartShapesDir
string
The path to the user’s Auto Shapes directory, which is
expressed as a file://URL
userSmartShapeToolsDir
string
The path to the user’s Auto Shape Tools directory, which is
expressed as a file://URL.
userSymbolLibrariesDir
string
The path to the user’s Symbol Libraries, which is expressed as
file://URL.
userSwfCommandsDir
string
The path to the user-level SWF Commands directory, which is
expressed as a file://URL.
In Fireworks, this folder is stored on a per-user basis on
multiuser systems. Even on single-user systems, this folder is
not inside the Fireworks installation directory.
xhtmlFormat
Boolean
Determines whether the JavaScript interpreter should output
XHTML formatted files or HTML formatted files; XHTML (
true
)
or HTML (
false
).
Property
Data type
Notes