User manual MACROMEDIA FIREWORKS MX 2004-EXTENDING FIREWORKS

[. . . ] Extending Fireworks Trademarks Afterburner, AppletAce, Attain, Attain Enterprise Learning System, Attain Essentials, Attain Objects for Dreamweaver, Authorware, Authorware Attain, Authorware Interactive Studio, Authorware Star, Authorware Synergy, Backstage, Backstage Designer, Backstage Desktop Studio, Backstage Enterprise Studio, Backstage Internet Studio, Contribute, Design in Motion, Director, Director Multimedia Studio, Doc Around the Clock, Dreamweaver, Dreamweaver Attain, Drumbeat, Drumbeat 2000, Extreme 3D, Fireworks, Flash, Fontographer, FreeHand, FreeHand Graphics Studio, Generator, Generator Developer's Studio, Generator Dynamic Graphics Server, Knowledge Objects, Knowledge Stream, Knowledge Track, LikeMinds, Lingo, Live Effects, MacRecorder Logo and Design, Macromedia, Macromedia Contribute, Macromedia Coursebuilder for Dreamweaver, Macromedia M Logo & Design, Macromedia Flash, Macromedia Xres, Macromind, Macromind Action, MAGIC, Mediamaker, Multimedia is the Message, Object Authoring, Power Applets, Priority Access, Roundtrip HTML, Scriptlets, SoundEdit, ShockRave, Shockmachine, Shockwave, shockwave. com, Shockwave Remote, Shockwave Internet Studio, Showcase, Tools to Power Your Ideas, Universal Media, Virtuoso, Web Design 101, Whirlwind and Xtra are trademarks of Macromedia, Inc. and may be registered in the United States or in other jurisdictions including internationally. Other product names, logos, designs, titles, words or phrases mentioned within this publication may be trademarks, servicemarks, or tradenames of Macromedia, Inc. or other entities and may be registered in certain jurisdictions including internationally. [. . . ] Tells Fireworks how to draw the final Auto Shape, after a drag operation is complete. If Fireworks handled shape changes through the BeginDragControlPoint() function, then you can use the end result of that function as a starting point. In that case, the code need not reflect every change in shape, but just the changes that aren't handled by BeginDragControlPoint(). EndDragControlPoint() SmartShapeEdited() This function is called when any changes have been made to the Auto Shape that might change the shape's behavior (such as removing a node inside an Auto Shape object). Creating an Auto Shape 99 These functions correspond directly with the messages listed in "Fireworks messages" on page 98. To invoke your own function names in response to Fireworks messages, you need to write a switch() statement. Switch Statements If you take a look at some existing Auto Shapes (in the Configuration/Auto Shapes folder and in the Configuration/Auto Shape Tools folders), you'll notice a switch() statement near the beginning of the file. The Auto Shape JavaScript code in these files uses a switch() statement as the initial message handler in the file. The switch() statement sorts the messages sent by Fireworks so each message (that is useful to the particular Auto Shape) invokes a corresponding function. You can see this switch statement in each of the Auto Shape JavaScript files. Again, a single Auto Shape object may not need to process every message Fireworks sends, so only the useful messages are written into the JavaScript file using the case qualifier. Effectively, the JavaScript file states in case of a certain message, or messages, perform the following function. In the Frame Auto Shape, this code is used to call PlaceControlPoints() when Fireworks sends a "SmartShapeEdited" message: switch(smartShape. operation) { case "BeginDragInsert": case "InsertSmartShapeAt": InsertSmartShapeAt(true); break; case "BeginDragControlPoint": BeginDragControlPoint(); break; case "DragControlPoint": DragControlPoint(); break; case "EndDragControlPoint": EndDragControlPoint(); break; case "SmartShapeEdited": PlaceControlPoints(); break; } You don't need a response for every message Fireworks sends; but you do need to make sure the switch statement handles the responses required by your shape. You can also invoke a single function for several messages: case "BeginDragInsert": case "InsertSmartShapeAt": InsertSmartShapeAt(true); break; 100 Chapter 4: Auto Shapes Supporting functions and methods Since the Auto Shape file is written in JavaScript, your functions can use global variables, common functions, and the Fireworks JavaScript API. The Auto Shape JavaScript file contains the definition of the shape's points, and a series of functions to handle the Fireworks messages as the user interacts with the shape. The file also includes a series of commands and functions defining the shape's properties and other functionality. These functions are often separate from the message handling functions so they can be used by multiple message handling functions. For example, the Cog Auto Shape JavaScript file (Configuration/Auto Shapes/Cog. jsf ) contains userdefined functions near the bottom of the file. These functions perform calculations and create shapes that are useful for the message handling functions. The top of the file contains a series of variable statements that define useful values for tooltips, global variables, and constants used throughout the Auto Shape JavaScript file. You can use the Fireworks JavaScript API and the Fireworks Object Model, along with efficient JavaScript coding practices, to create effective Auto Shapes (and continue to reuse the most useful functions from each Auto Shape JavaScript file). For more information, see "Fireworks JavaScript API" on page 103 and the "The Fireworks Object Model" on page 9. Creating an Auto Shape 101 102 Chapter 4: Auto Shapes CHAPTER 5 Fireworks JavaScript API This chapter lists JavaScript functions supported by Macromedia Fireworks MX 2004 that enable you to create useful Fireworks extensions and customized Fireworks menus. Almost any task that the user can accomplish in Fireworks with the menus, tools, or floating panels can be done programmatically using JavaScript. Using Fireworks API functions Three categories of API functions are described in this chapter: Document functions, History panel functions, and Fireworks functions. Zero-based indexes Some functions take an index argument which is a zero-based, one-dimensional array. [. . . ] fw. hidePIWindow() Availability Fireworks MX. Usage fw. hidPIWindow() Arguments None. Returns Nothing. Description Makes the Property inspector window invisible. fw. isPIExpanded() Availability Fireworks MX. Usage fw. isPIExpanded() Arguments None. Returns A Boolean value: true if expanded; false otherwise. Description Determines whether the Property inspector window is currently expanded or minimized fw. isPIVisible() Availability Fireworks MX. Usage fw. isVisible() 276 Chapter 5: Fireworks JavaScript API Arguments None. Returns A Boolean value: true if visible; false otherwise. Description Determines whether the Property inspector window is currently hidden or shown. fw. growPIWindow() Availability Fireworks MX. Usage fw. growPIWindow() Arguments None. Returns Nothing. Description Expands the Property inspector window. fw. shrinkPIWindow() Availability Fireworks MX. Usage fw. shrinkPIWindow() Arguments None. Returns Nothing. Description Minimizes the Property inspector window. Property inspector functions 277 fw. setPIPosition() Availability Fireworks MX. Usage fw. setPIPosition(pt) Arguments pt A point in screen coordinates. Returns Nothing. Description Moves the upper left corner of the Property inspector window to the specified location. [. . . ]