Adobe 65011817 Extended User Guide - Page 252

Group object

Page 252 highlights

Last updated 12/8/2009 EXTENDING FIREWORKS 248 Objects within Fireworks documents Property height • isLayer isSmartShape • left mask name opacity rawLeft rawTop top pixelRect visible width • Data type float Boolean Boolean float object string float float float float rect Boolean float Notes Read-only in the base class; other properties or API calls are used to resize specific types of elements. Always false for an element. Confirms whether the element is an Auto Shape. Can round to an integer. ElementMask object (for more information, see "ElementMask object" on page 252). Returns null if the element has no element mask. Can be null (removes any existing name). Acceptable values, 0 to 100, represent percent opacity. Leftmost space occupied by the pixels (not the left location of the bounding box). Top space occupied by the pixels (not the top location of the bounding box).> Can round to an integer. Rectangle of the area occupied by the pixels. For example, the pixelRect of a text object is smaller than what the property inspector reports, since the actual pixels are inside the bounding box. If set to false, the element is hidden. The default value is true. Read-only in the base class; other properties or API calls are used to resize specific types of elements. The following table lists the methods of the Element object, along with their parameters. Method generateSmartShapeCode Parameter root Definition The root parameter is a string value that is prefixed to each line of output. Group object Group is a subclass of the base class Element and contains the following properties in addition to those in Element (for more information, see "Element object" on page 247). Property controlPoints • elements Data type array array Notes Array of control points defined for the Auto Shape object. Array of Element objects in the group (for more information, see "Element object" on page 247).

  • 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

248
EXTENDING FIREWORKS
Objects within Fireworks documents
Las
t
up
d
a
ted
12/8/2009
The following table lists the methods of the Element object, along with their parameters.
Group object
Group is a subclass of the base class Element and contains the following properties in addition to those in Element (for
more information, see “
Element object
” on page
247).
height
float
Read-only in the base class; other properties or API calls are
used to resize specific types of elements.
isLayer
Boolean
Always false for an element.
isSmartShape
Boolean
Confirms whether the element is an Auto Shape.
left
float
Can round to an integer.
mask
object
ElementMask object (for more information, see “
ElementMask
object
” on page
252). Returns
null
if the element has no
element mask.
name
string
Can be
null
(removes any existing name).
opacity
float
Acceptable values, 0 to 100, represent percent opacity.
rawLeft
float
Leftmost space occupied by the pixels (not the left location of
the bounding box).
rawTop
float
Top space occupied by the pixels (not the top location of the
bounding box).>
top
float
Can round to an integer.
pixelRect
rect
Rectangle of the area occupied by the pixels. For example, the
pixelRect of a text object is smaller than what the property
inspector reports, since the actual pixels are inside the
bounding box.
visible
Boolean
If set to
false
, the element is hidden. The default value is
true
.
width
float
Read-only in the base class; other properties or API calls are
used to resize specific types of elements.
Method
Parameter
Definition
generateSmartShapeCode
root
The root parameter is a string value that is prefixed to each line
of output.
Property
Data type
Notes
controlPoints
array
Array of control points defined for the Auto Shape object.
elements
array
Array of Element objects in the group (for more information,
see “
Element object
” on page
247).
Property
Data type
Notes