User manual MACROMEDIA DREAMWEAVER 8-EXTENDING DREAMWEAVER

[. . . ] Extending Dreamweaver Trademarks 1 Step RoboPDF, ActiveEdit, ActiveTest, Authorware, Blue Sky Software, Blue Sky, Breeze, Breezo, Captivate, Central, ColdFusion, Contribute, Database Explorer, Director, Dreamweaver, Fireworks, Flash, FlashCast, FlashHelp, Flash Lite, FlashPaper, Flex, Flex Builder, Fontographer, FreeHand, Generator, HomeSite, JRun, MacRecorder, Macromedia, MXML, RoboEngine, RoboHelp, RoboInfo, RoboPDF, Roundtrip, Roundtrip HTML, Shockwave, SoundEdit, Studio MX, UltraDev, and WebHelp are either registered trademarks or 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, service marks, or trade names of Macromedia, Inc. or other entities and may be registered in certain jurisdictions including internationally. [. . . ] For color pickers, the value should be a valid color but Dreamweaver does not enforce this. The value attribute is equivalent to the getCurrentValue() function in a toolbar command file. update="update_frequency_list" Optional. This attribute specifies how often the enabled, checked, showif, and value handlers should run to update the visible state of the item. The update attribute is equivalent to the getUpdateFrequency() function in a toolbar command file. You must specify the update frequency for toolbar items because these items are always visible, unlike menu items. For this reason, you should always select the lowest frequency possible and make sure your handlers for the enabled, checked, and value handlers are as simple as possible. 236 Toolbars The following list shows the possible handlers for update_frequency_list, from least to most frequent. If you do not specify the update attribute, the update frequency defaults to onEdit frequency. The handlers run on any of the following specified events: onServerModelChange executes when the server model of the current page changes. onCodeViewSyncChange executes when the Code view becomes in or out of sync with the Design view. onViewChange executes whenever the user switches focus between Code view and Design view or when the user changes between Code view, Design view, or Split view. This can be time-consuming because the enabler/checked/showif/value handlers are running often. It should be used only for buttons that need to have their enable state changed at special times, and handlers should be quick. In all these cases, Dreamweaver actually executes the handlers after the specified event occurs, when the application is in a quiescent state. It is not guaranteed that your handlers run after every edit or selection change; your handlers run soon after a batch of edits or selection changes occur. The handlers are guaranteed to run when the user clicks on a toolbar item. N OT E Example update="onViewChange" command="script" This attribute is required for all items except menu buttons. Specifies the JavaScript function to execute when the user performs one of the following actions: Clicks a button Selects an item from a pop-up menu or combo box Tabs out of, presses Return in, or clicks away from a text box or combo box Selects a color from a color picker The command attribute is equivalent to the receiveArguments() function in a toolbar command file. Item tag attributes 237 Example command="dw. toggleLiveDebug()" arguments="argument_list" Optional. This attribute specifies the comma-separated list of arguments to pass to the receiveArguments() function in a toolbar command file. If you do not specify the arguments attribute, Dreamweaver passes the ID of the toolbar item. In addition, pop-up menus, combo boxes, text boxes, and color pickers pass their current value as the first argument, before any arguments that the arguments attribute specifies, and before the item ID if no arguments are specified. Example On a toolbar that has Undo and Redo buttons, each button calls the menu command file, Edit_Clipboard. htm, and passes an argument that specifies the action, as shown in the following example: <button id="DW_Undo" image="Toolbars/images/MM/undo. gif" disabledImage="Toolbars/images/MM/undo_dis. gif" tooltip="Undo" file="Menus/MM/Edit_Clipboard. htm" arguments="'undo'" update="onEveryIdle"/> <button id="DW_Redo" image="Toolbars/images/MM/redo. gif" disabledImage="Toolbars/images/MM/redo_dis. gif" tooltip="Redo" file="Menus/MM/Edit_Clipboard. htm" arguments="'redo'" update="onEveryIdle"/> The toolbar command API In many cases where you specify a script for an attribute, you can also implement the attribute through a JavaScript function in a command file. This action is necessary when the functions need to take arguments, as in the command handler for a text box. The command file API for toolbar items is an extension of the menu command file API, so you can reuse menu command files directly as toolbar command files, perhaps with some additional functions that are specific to toolbars. 238 Toolbars canAcceptCommand() Availability Dreamweaver MX. Description Determines whether the toolbar item is enabled. The enabled state is the default condition for an item, so you should not define this function unless it returns a false value in at least one case. Arguments For pop-up menus, combo boxes, text boxes, and color pickers, the first argument is the current value within the control. The getDynamicContent() function can optionally attach individual IDs to items within a pop-up menu. If the selected item in the pop-up menu has an ID attached, Dreamweaver passes that ID to canAcceptCommand() instead of the value. For combo boxes, if the current contents of the text box do not match an entry in the pop-up menu, Dreamweaver passes the contents of the text box. [. . . ] Includes functions that determine if an object is a layer and determine if the cursor is inside a form. Contains functions that get a function for an event handler, add a function to an event handler, and delete a function for an event handler. Contains a handful of useful functions that replace encoding, unescape quotation marks ("), check whether a node is inside a selection range, and checks for duplicate object names. Contains the insertIntoDocument() function, which inserts a text string into a document at the insertion point. [. . . ]