Adobe 65011817 Extended User Guide - Page 305

Message handler functions

Page 305 highlights

Last updated 12/8/2009 EXTENDING FIREWORKS 301 Auto Shapes Fireworks sends this message every time the mouse moves during a drag operation (as long as smartshape.getsDragEvents is set to true). For more information, see "SmartShape object" on page 265. • "EndDragInsert" Fireworks sends this message on a mouseUp event after a drag operation. • "BeginDragControlPoint" Fireworks sends this message when the user clicks and holds the mouse button on a control point. • "DragControlPoint" Fireworks sends this message every time the mouse moves during a drag operation (as long as smartshape.getsDragEvents is set to true). For more information, see "SmartShape object" on page 265. • "EndDragControlPoint" Fireworks sends this message when the drag operation is complete. • "SmartShapeEdited" Fireworks sends this message when any change has been made to the Auto Shape (for example, when the user deletes a node). Message handler functions Because Fireworks sends interaction messages as the user interacts with the Auto Shape, you can write functions to define, edit, and delete the Auto Shape and its properties. Specifically, you write functions defining the effect of manipulating the control points on the shape properties. You can define object properties at various stages of a drag operation: at the beginning of the operation, during the operation, and at its end. (If you define only the properties for the end result, Fireworks waits until the drag operation ends to show the changes to the user.) For example, to have your Auto Shape respond to an "EndDragControlPoint" message, you would write the following function: function EndDragControlPoint(){ cp.x = smartShape.currentMousePos; cp.y = smartShape.currentMousePos; } The following table lists all the available Fireworks message handler functions you can create (although, you don't have to write a response to every Fireworks message, only the ones important to your Auto Shape): Function InsertSmartShapeAt() BeginDragInsert() DragInsert() EndDragInsert() Description Draws the initial shape. This function is called when the user selects the shape from the Tools panel and clicks on the canvas, or drags the shape from the Auto Shapes panel to the canvas. Define all initial properties of the Auto Shape in this function. Tells Fireworks what to do when the user drags an Auto Shape on the canvas. You can define movements for control points and nodes that you defined in InsertSmartShapeAt(). This function is called every time the mouse moves during a drag operation (as long as smartshape.getsDragEvents is set to true). See "SmartShape object" on page 265. This function is called on a mouse-up event after a drag operation.

  • 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

301
EXTENDING FIREWORKS
Auto Shapes
Las
t
up
d
a
ted
12/8/2009
Fireworks sends this message every time the mouse moves during a drag operation (as long as
smartshape.getsDragEvents is set to
true
). For more information, see “
SmartShape object
” on page
265.
"EndDragInsert"
Fireworks sends this message on a
mouseUp
event after a drag operation.
"BeginDragControlPoint"
Fireworks sends this message when the user clicks and holds the mouse button on a control point.
"DragControlPoint"
Fireworks sends this message every time the mouse moves during a drag operation (as long as
smartshape.getsDragEvents is set to
true
). For more information, see “
SmartShape object
” on page
265.
"EndDragControlPoint"
Fireworks sends this message when the drag operation is complete.
"SmartShapeEdited"
Fireworks sends this message when any change has been made to the Auto Shape (for example, when the user
deletes a node).
Message handler functions
Because Fireworks sends interaction messages as the user interacts with the Auto Shape, you can write functions to
define, edit, and delete the Auto Shape and its properties. Specifically, you write functions defining the effect of
manipulating the control points on the shape properties. You can define object properties at various stages of a drag
operation: at the beginning of the operation, during the operation, and at its end. (If you define only the properties for
the end result, Fireworks waits until the drag operation ends to show the changes to the user.) For example, to have
your Auto Shape respond to an “EndDragControlPoint” message, you would write the following function:
function EndDragControlPoint(){
cp.x = smartShape.currentMousePos;
cp.y = smartShape.currentMousePos;
}
The following table lists all the available Fireworks message handler functions you can create (although, you don’t have
to write a response to every Fireworks message, only the ones important to your Auto Shape):
Function
Description
InsertSmartShapeAt()
Draws the initial shape. This function is called when the user selects the shape from the Tools
panel and clicks on the canvas, or drags the shape from the Auto Shapes panel to the canvas.
Define all initial properties of the Auto Shape in this function.
BeginDragInsert()
Tells Fireworks what to do when the user drags an Auto Shape on the canvas. You can define
movements for control points and nodes that you defined in
InsertSmartShapeAt()
.
DragInsert()
This function is called every time the mouse moves during a drag operation (as long as
smartshape.getsDragEvents
is set to
true
). See “
SmartShape object
” on page
265.
EndDragInsert()
This function is called on a mouse-up event after a drag operation.