Adobe 38039927 Extended User Guide - Page 52

dom.clipPasteAsMask

Page 52 highlights

ADOBE FIREWORKS CS3 48 Extending Guide Arguments whatIfResolutionDifferent An optional string that specifies how resampling should be done if the resolution of the Clipboard contents doesn't match the resolution of the document. Acceptable values for whatIfResolutionDifferent are "resample", "do not resample", and "ask user" (displays a dialog box to let the user decide). If whatIfResolutionDifferent is omitted or null, "ask user" is assumed. whatIfPastingIntoElementMask An optional argument, added in Fireworks 4, that applies only if the user is editing an element mask, and that element mask is an empty image mask. In this case, the pasted elements replace the existing mask (because it is essentially a mask that doesn't mask anything). If the image mask isn't empty, the pasted elements are added to the existing mask, rather than replacing it. Acceptable values for whatIfPastingIntoElementMask are "image", "vector", and "ask user". If whatIfPastingIntoElementMask is omitted or null, "ask user" is assumed. Returns Nothing. Description Pastes the Clipboard contents into the document. Example The following command pastes the Clipboard contents into the document. If there is a need for resampling, Fireworks asks the user to decide how to resample. fw.getDocumentDOM().clipPaste(); dom.clipPasteAsMask() Availability Fireworks 4. Usage dom.clipPasteAsMask(whatIfResolutionDifferent, masktype, maskReplaceOptions) Arguments whatIfResolutionDifferent A string that specifies how resampling should be done if the resolution of the Clipboard contents doesn't match the resolution of the document. Acceptable values for whatIfResolutionDifferent are "resample", "do not resample", and "ask user" (displays a dialog box to let the user decide). If whatIfResolutionDifferent is omitted or null, "ask user" is assumed. masktype Specifies how to paste the mask. Acceptable values are "image" (always paste as an image mask), "vector" (always paste as a vector mask), and "ask" (displays a dialog box to let the user decide). If the Clipboard contains a single image, it is pasted as an image mask, even if you pass "vector". maskReplaceOptions Acceptable values for maskReplaceOptions are "replace" (if an element mask already exists, replace it with the pasted one), "add" (if an element mask already exists, add the pasted mask to it), and "ask" (displays a dialog box to let the user decide). Returns Nothing.

  • 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
48
Arguments
whatIfResolutionDifferent
An optional string that specifies how resampling should be done if the resolution
of the Clipboard contents doesn’t match the resolution of the document. Acceptable values for
whatIfResolu-
tionDifferent
are
"resample"
,
"do not resample"
, and
"ask user"
(displays a dialog box to let the user
decide). If
whatIfResolutionDifferent
is omitted or
null
,
"ask user"
is assumed.
whatIfPastingIntoElementMask
An optional argument, added in Fireworks 4, that applies only if the user
is editing an element mask, and that element mask is an empty image mask. In this case, the pasted elements replace
the existing mask (because it is essentially a mask that doesn’t mask anything). If the image mask isn’t empty, the
pasted elements are added to the existing mask, rather than replacing it. Acceptable values for
whatIfPastingIn-
toElementMask
are
"image", "vector",
and
"ask user"
. If
whatIfPastingIntoElementMask
is omitted or
null
,
"ask user"
is assumed.
Returns
Nothing.
Description
Pastes the Clipboard contents into the document.
Example
The following command pastes the Clipboard contents into the document. If there is a need for resampling,
Fireworks asks the user to decide how to resample.
fw.getDocumentDOM().clipPaste();
dom.clipPasteAsMask()
Availability
Fireworks 4.
Usage
dom.clipPasteAsMask(
whatIfResolutionDifferent, masktype, maskReplaceOptions
)
Arguments
whatIfResolutionDifferent
A string that specifies how resampling should be done if the resolution of the
Clipboard contents doesn’t match the resolution of the document. Acceptable values for
whatIfResolutionDif-
ferent
are
"resample"
,
"do not resample"
, and
"ask user"
(displays a dialog box to let the user decide). If
whatIfResolutionDifferent
is omitted or
null
,
"ask user"
is assumed.
masktype
Specifies how to paste the mask. Acceptable values are "
image
" (always paste as an image mask),
"
vector
" (always paste as a vector mask), and "
ask
" (displays a dialog box to let the user decide). If the Clipboard
contains a single image, it is pasted as an image mask, even if you pass "
vector
".
maskReplaceOptions
Acceptable values for
maskReplaceOptions
are "
replace
" (if an element mask already
exists, replace it with the pasted one), "
add
" (if an element mask already exists, add the pasted mask to it), and "
ask
"
(displays a dialog box to let the user decide).
Returns
Nothing.