Adobe 65011817 Extended User Guide - Page 317

Example script

Page 317 highlights

Last updated 12/8/2009 EXTENDING FIREWORKS 313 Rich symbols textOnly String. If defined, this represents the entire MXML output to be used for the export. If this is defined, no other properties need to be set within the definition. Any properties set are ignored. Example textOnly = ""; ignored Boolean. If true, the object is completely ignored during export; no MXML is created and no image is exported. If this is set to true, no other properties need to be set within the definition. Any properties set are ignored. Note: The ignored property has precedence over textOnly. Example ignored = true; Example script The following is an example of a custom symbol script using a custom definition object to determine the output created by the Fireworks MXML and Images export. function setDefaultValues() { var currValues = new Array(); currValues.push({ name:"name", type:"Text", value:"star name" }); currValues.push({ name:"label", type:"Text", value:"Star" }); currValues.push({ name:"color", type:"Color", value:"#FFFFFF" }); currValues.push({ name:"enabled", type:"Boolean", value:"true" }); Widget.elem.customData["currentValues"] = currValues; Widget.elem.customData["flexClassName"] = "Star"; var classDef = new Object(); classDef.margin = {top:0, right:3, bottom:10, left:3}; classDef.padding = {top:30, right:10, bottom:10, left:10}; classDef.sizeOffset = {width:10, height:0}; classDef.customValues = {staticValue:"static"}; classDef.attributeProperties = ["staticValue", "name"]; classDef.styleProperties = ["color"]; classDef.defaultProperties = ["x","y","width","height"]; classDef.namespace = {ns:"http://www.example.com/2007/mxml"}; Widget.elem.customData["flexClassDefinition"] = classDef; } function applyCurrentValues() { var vals = Widget.elem.customData["currentValues"]; Widget.GetObjectByName("label").textChars = vals[1].value; Widget.GetObjectByName("label").pathAttributes.fillColor = vals[2].value; Widget.GetObjectByName("disabled").visible = !vals[3].value; } switch (Widget.opCode) { case 1: setDefaultValues(); break; case 2: applyCurrentValues(); break; } A document containing this rich symbol that is exported using the MXML and Images export would result in the following MXML document.

  • 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

313
EXTENDING FIREWORKS
Rich symbols
Las
t
up
d
a
ted
12/8/2009
textOnly
String. If defined, this represents the entire MXML output to be used for the export. If this is defined, no other
properties need to be set within the definition. Any properties set are ignored.
Example
textOnly = "<mx:ColorPicker id=\"cp\" selectedColor=\"#FFFFFF\"/>";
ignored
Boolean. If true, the object is completely ignored during export; no MXML is created and no image is exported. If this
is set to true, no other properties need to be set within the definition. Any properties set are ignored.
Note:
The
ignored
property has precedence over
textOnly
.
Example
ignored = true;
Example script
The following is an example of a custom symbol script using a custom definition object to determine the output created
by the Fireworks MXML and Images export.
function setDefaultValues() {
var currValues = new Array();
currValues.push({ name:"name",
type:"Text",
value:"star name" });
currValues.push({ name:"label",
type:"Text",
value:"Star"
});
currValues.push({ name:"color",
type:"Color",
value:"#FFFFFF"
});
currValues.push({ name:"enabled", type:"Boolean", value:"true"
});
Widget.elem.customData["currentValues"] = currValues;
Widget.elem.customData["flexClassName"] = "Star";
var classDef = new Object();
classDef.margin = {top:0, right:3, bottom:10, left:3};
classDef.padding = {top:30, right:10, bottom:10, left:10};
classDef.sizeOffset = {width:10, height:0};
classDef.customValues = {staticValue:"static"};
classDef.attributeProperties = ["staticValue", "name"];
classDef.styleProperties = ["color"];
classDef.defaultProperties = ["x","y","width","height"];
classDef.namespace = {ns:"http://www.example.com/2007/mxml"};
Widget.elem.customData["flexClassDefinition"] = classDef;
}
function applyCurrentValues() {
var vals = Widget.elem.customData["currentValues"];
Widget.GetObjectByName("label").textChars = vals[1].value;
Widget.GetObjectByName("label").pathAttributes.fillColor = vals[2].value;
Widget.GetObjectByName("disabled").visible = !vals[3].value;
}
switch (Widget.opCode) {
case 1: setDefaultValues();
break;
case 2: applyCurrentValues(); break;
}
A document containing this rich symbol that is exported using the MXML and Images export would result in the
following MXML document.