Chapter 5: Fireworks Javascript Api; Using Fireworks Api Functions - MACROMEDIA FIREWORKS MX 2004-EXTENDING FIREWORKS Manual

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. The following rules apply to all functions.
Zero-based indexes
Some functions take an
means a value of
For example, the following command deletes the second layer of the active Fireworks document:
fw.getDocumentDOM().deleteLayer2;
Functions that take a
frame. Similarly, functions that take a
current layer.
Passing null values
In general, passing a
do allow as an argument; such cases are noted in the function descriptions.
null
Working with selected elements
Many API functions in this chapter refer to a "selection" or to "selected items." These terms refer
to Fireworks elements, such as text boxes or images, that are currently selected. In most cases, the
functions work even if only one item is selected. If a function requires more than one selected
item, this is noted in the description of the function.
argument which is a zero-based, one-dimensional array. That
index
represents the first item in the array,
0
argument can be passed
frameIndex
layerIndex
value to a function causes an exception to be thrown. A few functions
null
Fireworks JavaScript API
represents the second item, and so on.
1
to indicate the current
–1
argument may be passed
CHAPTER 5
to indicate the
–1
103