Adobe 38040334 API Reference - Page 47

DREAMWEAVER CS3

API Reference

42

file that is already installed in the Configuration/Objects/FlashElements folder or one of its subfolders to the

Insert bar or Insert menu). Extension developers can use the JavaScript function

“dom.insertFlashElement()” on

page 127

in the object definition file to add available Flash elements to a document. When the user selects the Flash

element object, Dreamweaver unpacks the SWC file, which contains Flash content (SWF file) and a file that details

the parameters the user can edit. Dreamweaver then inserts the SWF file into the user’s document.

Adding a Flash element to the Insert Bar

As with other objects, you add a Flash element to the Insert Bar using the

button

tag. However, a

button

tag for a

Flash element must have both

file

and

command

attributes to add the element successfully to the document (see the

button tag details in “Insert Bar Objects” in

Extending Dreamweaver

). Use the

file

attribute to tell Dreamweaver

where the source file for the element resides relative to the Objects folder. Then, use the

command

attribute to tell

Dreamweaver to use the

dom.insertFlashElement()

function when the user clicks the button on the Insert bar.

The following example shows the code to place in the inserbar.xml file (either as a child of the appropriate

category

or

menubutton

tag, depending on where you want the Flash element button to appear):

<button id="FlashElement

_

Nav"

name="Navigation"

file="FlashElements\nav.swc"

command="dw.getDocumentDOM().insertFlashElement('nav.swc')" />

Note:

The image on the Insert bar for the Flash element is determined within the SWC file. Also, the

button

tag for a

Flash element object must have a file attribute defined.

Adding a Flash Element to a menu

A Flash element can also reside on the Insert menu, or on other menus, in Dreamweaver. Use the JavaScript function

“dom.insertFlashElement()” on page 127

with the menus.xml file format (see “Menus and Menu Commands” in

Extending Dreamweaver

) to specify the Flash element menu item location. The following example shows how code

within the menus.xml file makes a Navigation Flash element available on the Insert > Flash Element menu:

<menuitem name="Navigation"

key=""command="dw.getDocumentDOM().insertFlashElement('nav.swc')"

enabled="(dw.getFocus() != 'browser') && (dw.getDocumentDOM() != null && ¬

dw.getDocumentDOM().getParseMode() == 'html')"

id="DWMenu_Insert_FlashElement_Nav" />

The Flash Objects API

The Flash Objects API lets extension developers build objects that create simple Flash content through Flash

Generator. This API provides a way to set parameters in a Flash Generator template and output a SWF or image file.

The API lets you create new Flash objects as well as read and manipulate existing Flash objects. The Flash button and

Flash text features are built using this API.

The SWT file is a Flash Generator Template file, which contains all the information you need to construct a Flash

Object file. These API functions let you create a new SWF file (or image file) from a SWT file by replacing the param-

eters of the SWT file with real values. For more information on Flash, see the Flash documentation. The following

functions are methods of the

SWFFile

object.

Section	Page
Contents	3
Chapter 1: Introduction	6
Background	7
Extending Dreamweaver	7
Additional resources for extension writers	7
New functions in Dreamweaver CS3	7
Removed functions	9
Errata	10
Conventions used in this guide	10
Chapter 2: The file I/O API	11
Accessing configuration folders	11
The file I/O API	11
Chapter 3: The HTTP API	20
How the HTTP API works	20
The HTTP API	21
Chapter 4: The Design Notes API	27
How Design Notes work	27
The Design Notes JavaScript API	28
The Design Notes C API	32
Chapter 5: Fireworks integration	39
The FWLaunch API	39
Chapter 6: Flash integration	46
How Flash elements work	46
Inserting Flash elements	46
The Flash Objects API	47
Chapter 7: The database API	51
How database API functions work	51
Database connection functions	52
Database access functions	64
Chapter 8: The database connectivity API	76
How to develop a new connection type	76
The Connection API	78
The generated include file	80
The definition file for your connection type	82
Chapter 9: The JavaBeans API	84
The JavaBeans API	84
Chapter 10: The source control integration API	89
How source control integration with Dreamweaver works	90
Adding source control system functionality	90
The source control integration API required functions	90
The source control integration API optional functions	96
Enablers	104
Chapter 11: Application	109
External application functions	109
Global application functions	117
Bridge communication functions	122
Chapter 12: Workspace	124
History functions	124
Insert object functions	132
Keyboard functions	135
Menu functions	141
Results window functions	143
Toggle functions	154
Toolbar functions	173
Window functions	178
Code collapse functions	188
Code view toolbar functions	194
Chapter 13: Site	198
Report functions	198
Site functions	199
Chapter 14: Document	232
Conversion functions	232
Command functions	233
File manipulation functions	235
Global document functions	249
Path functions	258
Selection functions	260
String manipulation functions	267
Translation functions	270
XSLT functions	272
Chapter 15: Page content	275
Assets panel functions	275
Behavior functions	285
Clipboard functions	293
Library and template functions	298
Snippets panel functions	303
Spry widget editing functions	306
Inserting Spry widgets functions	308
Browser compatibility check functions	311
Chapter 16: Dynamic documents	319
Server components functions	319
Data source functions	320
Extension Data Manager functions	321
Live data functions	324
Server behavior functions	328
Server model functions	330
Chapter 17: Design	337
CSS layout functions	337
Frame and frameset functions	356
Layer and image map functions	358
Layout environment functions	360
Layout view functions	365
Zoom functions	374
Guide functions and properties	377
Table editing functions	384
Chapter 18: Code	393
Code functions	393
Find and replace functions	397
General editing functions	402
Print function	417
Quick Tag Editor functions	418
Code view functions	420
Tag editor and tag library functions	436
Chapter 19: Enablers	440
Enabler functions	440

Adobe 38040334 API Reference - Page 47

The Flash Objects API, Adding a Flash element to the Insert Bar

Page 47 highlights