使用 JavaScript API



利用 Flash JavaScript API 可以编写在 Flash 创作环境中（即用户保持 Flash 程序打开期间）执行多个动作的脚本。此功能与 ActionScript 语言不同，利用 ActionScript 语言可以编写能够在 Flash Player 环境中（即播放 SWF 文件期间）执行动作的脚本。此功能与 JavaScript 命令也不同，JavaScript 命令可以在用 Web 浏览器显示的页面中使用。

利用 JavaScript API，您可以编写有助于简化创作过程的 Flash 应用程序脚本。例如，您可以编写脚本来自动执行重复性任务，或向“工具”面板添加自定义工具。

Flash JavaScript API 在设计上类似于 Adobe ® Dreamweaver® 和 Adobe® Fireworks® JavaScript API（它们基于 Netscape JavaScript API 而设计）。Flash JavaScript API 基于文档对象模型 (DOM)，该模型允许使用 JavaScript 对象访问 Flash 文档。Flash JavaScript API 包含 Netscape JavaScript API 及 Flash DOM 的所有元素。本文档将对这些新增的对象及其方法和属性进行说明。您可以在 Flash 脚本中使用本地 JavaScript 语言的任何元素，但只有在 Flash 文档上下文中有意义的元素才有效。

此外，JavaScript API 还包含一些方法，使您可组合使用 JavaScript 和自定义 C 代码来实现可扩展性。有关详细信息，请参阅 C 级可扩展性。

Flash 中的 JavaScript 解释程序采用的是 Mozilla SpiderMonkey 引擎 1.5 版，该版本可从网络中找到：www.mozilla.org/js/spidermonkey/。SpiderMonkey 是 Mozilla.org 开发的 JavaScript 语言的两种引用实现之一。它与嵌入 Mozilla 浏览器中的引擎相同。

SpiderMonkey 按照 ECMAScript (ECMA-262) 版本 3 语言规范中的定义，实现了核心 JavaScript 语言，并完全符合该规范的要求。只有那些特定于浏览器的主机对象（未包含在 ECMA-262 规范中）不受支持。同样，许多 JavaScript 参考指南都区分核心 JavaScript 和客户端（与浏览器相关的）JavaScript。只有核心 JavaScript 才适用于 Flash JavaScript 解释程序。

    创建 JSFL 文件

    可以使用 Adobe Flash CS4 Professional 或喜欢使用的文本编辑器来编写和编辑 Flash JavaScript (JSFL) 文件。如果使用 Flash，则这些文件的默认扩展名为 .jsfl。若要编写脚本，请选择“文件”>“新建”>“Flash JavaScript 文件”。

    另外，还可以在“历史记录”面板中选择命令，从而创建 JSFL 文件。然后，单击“历史记录”面板中的“保存”按钮，或在面板菜单中选择“另存为命令”。命令 (JSFL) 文件保存在 Commands 文件夹中（请参阅保存 JSFL 文件）。这样就可以像打开和编辑任何其它脚本文件一样处理该文件。

    “历史记录”面板还提供了其它一些有用的选项。可以将所选命令复制到剪贴板，并且可以查看在 Flash 中工作时生成的 JavaScript 命令。

    将命令从“历史记录”面板复制到剪贴板：

    1. 在“历史记录”面板中选择一个或多个命令。

    2. 请执行下列操作之一：

      • 单击“复制”按钮。

      • 从面板菜单中选择“复制步骤”。

    在“历史记录”面板中查看 JavaScript 命令：

    • 从面板菜单中选择“查看”>“在面板中显示 JavaScript”。

    保存 JSFL 文件

    您可以通过将 JSFL 脚本存储在 Configuration 文件夹内的多个文件夹之一中，使它们可用于 Flash 创作环境。默认情况下，Configuration 文件夹位于以下位置：

    • Windows® Vista™：

      引导驱动器\Users\用户名\Local Settings\Application Data\Adobe\Flash CS4\语言\Configuration\

    • Windows XP：

      引导驱动器\Documents and Settings\用户名\Local Settings\Application Data\Adobe\Flash CS4\语言\Configuration\

    • Mac OS® X：

      Macintosh HD/Users/用户名/Library/Application Support/Adobe/Flash CS4/语言/Configuration/

    若要确定 Configuration 文件夹的位置，请使用 fl.configDirectory 或 fl.configURI，如下面的示例所示： 

    // store directory to a variable  
var configDir = fl.configDirectory; 
// display directory in the Output panel 
fl.trace(fl.configDirectory);

    Configuration 文件夹中的以下文件夹可能包含您可在创作环境中访问的脚本：Behaviors（用于支持行为的用户界面）；Commands（用于在“命令”菜单上显示的脚本）；JavaScript（脚本助手用来填充用户界面控件的脚本）；Tools（用于“工具”面板中的可扩展工具）和 WindowSWF（用于 Windows 菜单中显示的面板）。本文档主要介绍用于命令和工具的脚本。

    如果编辑 Commands 文件夹中的脚本，新脚本随即便可用于 Flash。如果编辑用于可扩展工具的脚本，请关闭并重新启动 Flash，或者使用 fl.reloadTools() 命令。不过，如果您曾使用脚本向“工具”面板中添加可扩展工具，然后编辑脚本，请删除该工具，然后重新向“工具”面板中添加该工具，或者关闭并重新启动 Flash，以使修改后的工具可用。

    您可以将命令和工具文件存储在两个位置，以便在创作环境中访问这些文件。

    • 对于作为菜单项显示在“命令”菜单中的脚本，请将 JSFL 文件保存在以下位置的 Commands 文件夹中：

      操作系统

      位置

      Windows Vista

      引导驱动器\Users\用户名\Local Settings\Application Data\Adobe\Flash CS4\语言\Configuration\Commands

      Windows XP

      引导驱动器\Documents and Settings\用户\Local Settings\Application Data\Adobe\Flash CS4\语言\Configuration\Commands

      Mac OS X

      Macintosh HD/Users/用户名/Library/Application Support/Adobe/Flash CS4/语言/Configuration/Commands

    • 对于作为可扩展工具显示在“工具”面板中的脚本，请将 JSFL 文件保存在以下位置的 Tools 文件夹中：

      操作系统

      位置

      Windows Vista

      引导驱动器\Users\用户名\Local Settings\Application Data\Adobe\Flash CS4\语言\Configuration\Tools

      Windows XP

      引导驱动器\Documents and Settings\用户\Local Settings\Application Data\Adobe\Flash CS4\语言\Configuration\Tools

      Mac OS X

      Macintosh HD/Users/用户名/Library/Application Support/Adobe/Flash CS4/语言/Configuration/Tools

    如果 JSFL 文件附带了其它文件（如 XML 文件），请将这些文件与 JSFL 文件存储在同一目录中。

    运行脚本

    有多种方法可以运行脚本。本节介绍几种最常用的方法。

    运行您当前查看或编辑的脚本：

    • 右键单击（在 Macintosh 中按住 Command 单击），然后选择“运行脚本”。

    • 在“脚本”窗口工具栏中单击“运行脚本”图标。

    使用此选项可以在保存脚本之前运行脚本。即便没有打开任何 FLA 文件，也可利用此选项运行脚本。

    若要运行 Commands 文件夹中的脚本，请按以下方法之一操作：

    • 在创作环境中，选择“命令”>“脚本名称”。

    • 使用分配给脚本的快捷键。若要分配快捷键，请使用“编辑”>“快捷键”，然后从“命令”弹出菜单中选择“绘画菜单命令”。展开菜单树中的“命令”节点以查看可用脚本的列表。

    若要运行不在 Commands 文件夹中的命令脚本，请按以下方法之一操作：

    • 在创作环境中，选择“命令”>“运行命令”，然后选择要运行的脚本。

    • 在脚本中，使用 fl.runScript() 命令。

    • 在文件系统中，双击脚本文件。

    将在 JSFL 文件中实现的工具添加到“工具”面板中：

    1. 将该工具的 JSFL 文件和所有其它关联文件复制到 Tools 文件夹中（请参阅保存 JSFL 文件）。

    2. 选择“编辑”>“自定义工具面板”(Windows) 或“Flash”>“自定义工具面板”(Macintosh)。

    3. 将该工具添加到可用工具的列表中。

    4. 单击“确定”。

    您可以通过使用 MMExecute() 函数，将各个 JavaScript API 命令添加到 ActionScript 文件中，具体说明请参阅《ActionScript 3.0 语言和组件参考》。不过，MMExecute() 函数仅在自定义用户界面元素（如创作环境中的组件属性检查器或 SWF 面板）的上下文中使用时才有效。在 Flash Player 中或在创作环境外部，即使从 ActionScript 进行了调用，JavaScript API 命令也无效。

    从 ActionScript 脚本发出命令：

    • 使用以下语法（可以将多个命令连接成一个字符串）：

      MMExecute(Javascript command string);

      还可以从命令行运行脚本。

    从 Windows 命令行运行脚本：

    • 使用以下语法（根据需要添加路径信息）：

      "flash.exe" myTestFile.jsfl

    从 Macintosh 的“终端”应用程序中运行脚本：

    • 使用以下语法（根据需要添加路径信息）：

      osascript -e 'tell application "flash" to open alias "Mac OS X:Users:user:myTestFile.jsfl" '

      osascript 命令还可以运行文件中的 AppleScript。例如，可以在名为 myScript 的文件中放置以下文本：

      tell application "flash" 
open alias "Mac OS X:Users:user:myTestFile.jsfl" 
end tell

      以后在运行脚本时，可以使用下面的命令：

      osascript myScript