Adobe Extending Dreamweaver CS4 - Manual (Page 175)

169 EXTENDING DREAMWEAVER CS4
Toolbars
A simple toolbar command file
This simple example implements a Title text box item as seen on the Dreamweaver Document toolbar. The text box
item lets the user enter a name for the current Dreamweaver document. You can implement this toolbar example by
performing the following steps:
Create the text box
To add a toolbar to Dreamweaver, you place an XML file that contains the toolbar definition in the Toolbars folder
inside the Dreamweaver Configuration folder.
The following figure shows the Title text box:
The following toolbar editcontrol item defines a text box that is labeled Title :
label="Title: "
tooltip="Document Title"
width="150"
file="Toolbars/MM/EditTitle.htm"/>
The tooltip attribute causes Dreamweaver to display Document Title in a tooltip box when the user places the mouse
pointer over the text box. The width attribute specifies the size of the field in pixels. The file attribute specifies that
the EditTitle.htm file contains the JavaScript functions that operate on the text box. To see the full definition of the
Dreamweaver Document toolbar, see the main toolbar (
id="DW_Toolbar_Main" ) in the toolbars.xml file.
JavaScript code for the text box
When the user interacts with the text box, it causes Dreamweaver to invoke the EditTitle.htm command file in the
Toolbars/MM folder. This file contains three JavaScript functions that operate on the Title text box. These functions
are
canAcceptCommand() , receiveArguments() , and getCurrentValue() .
canAcceptCommand(): enable the toolbar item
The canAcceptCommand() function consists of one line of code that checks to see whether there is a current
Document Object Model (DOM) and whether the document is parsed as HTML. The function returns the results of
those tests. If the conditions are
true , Dreamweaver enables the text box item on the toolbar. If the function returns
the value false , Dreamweaver disables the item.
The function is as follows:
function canAcceptCommand()
{
return (dw.getDocumentDOM() != null && dw.getDocumentDOM().getParseMode() == 'html');
}
receiveArguments(): set the title
Dreamweaver invokes the receiveArguments() function, shown in the following example, when the user enters a
value in the Title text box and presses the Enter key or moves the focus away from the control.
The function is as follows: