Adobe 38039927 Extended User Guide - Page 27

Document functions

Page 27 highlights

ADOBE FIREWORKS CS3 23 Extending Guide Property top useMatteColor width Data type integer Boolean integer Notes Coordinate of the top edge of the document, in pixels. To find the bottom edge of the document, use document.top + document.height. If set to true, the matteColor property is used when exporting documents with transparent backgrounds. If set to false, the matteColor property is ignored in this situation, and the exported file is matted against the document's canvas color. The width of the document, in pixels. To find the right edge of the document, use document.left + document.width. The pngText property Fireworks maintains the following fields for use with the pngText property: Field name CreationTime Software Value The date and time the document was created. The software used to create the document. The current version of Fireworks always sets this value to "Adobe Fireworks CS3." You can edit these or add your own fields, and they will be preserved across file saves. The pngText object corresponds directly to the 'tEXt' chunk of the document's PNG structure. Document functions As discussed in an earlier section, you get and set document properties by calling functions as methods of the document's Document Object Model (DOM) (see "Accessing a Fireworks document" on page 4). Methods that operate on a document's DOM are listed in this section as dom.functionName(). However, you cannot simply type dom.functionName(). In place of dom, you must type fw.getDocumentDOM() or fw.documents[documentIndex]. For example: • How a function looks in this manual: dom.addNewHotspot() • How you must type it: fw.getDocumentDOM().addNewHotspot(); // operates on active document or fw.documents[documentIndex].addNewHotspot(); // operates on specified document dom.addBehavior() Availability Fireworks 3. Usage dom.addBehavior(action, event, eventIndex)

  • 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
23
The pngText property
Fireworks maintains the following fields for use with the pngText property:
You can edit these or add your own fields, and they will be preserved across file saves.
The pngText object corresponds directly to the
'tEXt'
chunk of the document’s PNG structure.
Document functions
As discussed in an earlier section, you get and set document properties by calling functions as methods of the
document’s Document Object Model (DOM) (see “Accessing a Fireworks document” on page 4). Methods that
operate on a document’s DOM are listed in this section as
dom.functionName()
. However, you cannot simply type
dom.functionName()
. In place of dom, you must type
fw.getDocumentDOM()
or
fw.documents[documentIndex]
. For example:
How a function looks in this manual:
dom.addNewHotspot()
How you must type it:
fw.getDocumentDOM().addNewHotspot(); // operates on active document
or
fw.documents[documentIndex].addNewHotspot(); // operates on specified document
dom.addBehavior()
Availability
Fireworks 3.
Usage
dom.addBehavior(action, event, eventIndex)
top
integer
Coordinate of the top edge of the document, in
pixels. To find the bottom edge of the document, use
document.top + document.height.
useMatteColor
Boolean
If set to
true
, the
matteColor
property is used
when exporting documents with transparent back-
grounds. If set to
false
, the
matteColor
prop-
erty is ignored in this situation, and the exported file
is matted against the document’s canvas color.
width
integer
The width of the document, in pixels. To find the right
edge of the document, use
document.left +
document.width.
Field name
Value
CreationTime
The date and time the document was created.
Software
The software used to create the document. The current version of Fireworks always
sets this value to “Adobe Fireworks CS3.”
Property
Data type
Notes