Adobe 38039927 Extended User Guide - Page 25

Extending Guide, Property, Data type, Notes

Page 25 highlights

ADOBE FIREWORKS CS3 21 Extending Guide Property frameLoopingCount Data type integer frames • gammaPreview gradients • gridColor gridOrigin gridSize guides • height array Boolean array string point point object integer isDirty isPaintMode • isSymbolDocument • Boolean Boolean Boolean isValid Boolean lastExportDirectory string lastExportFile string Notes -1 - don't repeat 0 - repeat forever > 0 - repeat this number of times Array of Frame objects in the document (for more information, see "Frame object" on page 234). If set to true, the document should be previewed in opposite-platform gamma. If set to false, the document colors are unadjusted. Array of Gradient objects that are available for use in the document (for more information, see "Gradient object" on page 235). A color string that specifies the color of the grid display (for more information, see "Color string data type" on page 5). Used to set the origin of the grid. Corresponds to the point set when dragging the ruler origin from the upper-left of the document when rulers are visible. gridSize.x is the horizontal grid size; gridSize.y is the vertical grid size. Guides object (for more information, see "Guides object" on page 235). Total height of the document, in pixels. To find the bottom edge of the document, use document. top + document.height. Set to true if the document was modified since the last ti me it was saved. Set to true if the document is currently in paintmode editing, false otherwise. Set to true if the document is a Symbol or Button document, false if it is an ordinary document. You might see this when looking through the list of open documents and one is a symbol-editing window. Set to true if the document is open in Fireworks; false otherwise. (Occasionally the JavaScript object that is associated with a document lingers after the document closes; this property lets you check for that eventuality.) The path to the last directory to which the file was exported, which is expressed as file://URL, or null if the file was never exported. For instance, if the document was last exported to "file:///files/current/logo.gif", it returns "file:///files/current". The name that was used the last time the file was exported, or null if the file was never exported. For instance, if the document was last exported to "file:///files/current/logo.gif", it returns "logo.gif".

  • 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
21
frameLoopingCount
integer
–1 — don’t repeat
0 — repeat forever
> 0 — repeat this number of times
frames •
array
Array of Frame objects in the document (for more
information, see “Frame object” on page 234).
gammaPreview
Boolean
If set to
true
, the document should be previewed in
opposite-platform gamma. If set to
false
, the
document colors are unadjusted.
gradients •
array
Array of Gradient objects that are available for use in
the document (for more information, see “Gradient
object” on page 235).
gridColor
string
A color string that specifies the color of the grid
display (for more information, see “Color string data
type” on page 5).
gridOrigin
point
Used to set the origin of the grid. Corresponds to the
point set when dragging the ruler origin from the
upper-left of the document when rulers are visible.
gridSize
point
gridSize.x
is the horizontal grid size;
grid-
Size.y
is the vertical grid size.
guides •
object
Guides object (for more information, see “Guides
object” on page 235).
height
integer
Total height of the document, in pixels. To find the
bottom edge of the document, use document.
top + document.height.
isDirty
Boolean
Set to
true
if the document was modified since the
last ti me it was saved.
isPaintMode •
Boolean
Set to
true
if the document is currently in paint-
mode editing,
false
otherwise.
isSymbolDocument •
Boolean
Set to
true
if the document is a Symbol or Button
document,
false
if it is an ordinary document. You
might see this when looking through the list of open
documents and one is a symbol-editing window.
isValid
Boolean
Set to
true
if the document is open in Fireworks;
false
otherwise. (Occasionally the JavaScript
object that is associated with a document lingers
after the document closes; this property lets you
check for that eventuality.)
lastExportDirectory
string
The path to the last directory to which the file was
exported, which is expressed as
file://URL
, or
null
if
the file was never exported. For instance, if the docu-
ment was last exported to
"
file:///files/current/logo.gif"
, it
returns
"file:///files/current"
.
lastExportFile
string
The name that was used the last time the file was
exported, or
null
if the file was never exported. For
instance, if the document was last exported to
"file:///files/current/logo.gif"
, it
returns
"logo.gif"
.
Property
Data type
Notes