• Create BookmarkCreate Bookmark
  • Create Note or TagCreate Note or Tag
  • PrintPrint
Share this Page URL
Help

Welcome

Welcome

Welcome to the Adobe® Bridge Official JavaScript Reference for Windows and Macintosh. This book describes how to use JavaScript to manipulate and extend Adobe® Bridge for Adobe Creative Suite 2.

About This Book

The Adobe® Bridge Official JavaScript Reference for Windows and Macintosh describes how to use the scripting API to extend and manipulate Adobe Bridge, but it is not a user’s guide for the Bridge application and its user interface.

This book provides complete reference information for the JavaScript objects, properties, and functions defined by Adobe Bridge, and for various utilities and tools that are part of ExtendScript, the Adobe extended implementation of JavaScript.

This book also describes how to use the interapplication communication framework that is defined by Adobe Bridge and included in each Adobe Creative Suite 2 application. You can use this framework to write scripts that call on functionality from different applications, or to send scripts and data from one application to another. A set of Sample Workflow Automation Scripts (page 217) is provided with Adobe Creative Suite 2, which demonstrates how scripts can be used to create a workflow that takes advantage of functionality in different applications.

Advisory of previous publication

The material in this book is available in its entirety on the product CD for Adobe Creative Suite 2. If you have the product CD, you already have access to a PDF version of this material.

Who should read this book

This book is for developers who want to extend the capabilities of Adobe Bridge using JavaScript, call Bridge functionality from scripts, and use scripts to communicate between Adobe Creative Suite 2 applications. It assumes a general familiarity with the following:

  • JavaScript

  • C and C++ programming

  • Adobe Bridge

  • Any other Adobe Creative Suite 2 applications you are using, such as Illustrator® CS2, Photoshop® CS2, or InDesign® CS2. The scripting API details for each application are included with the scripting documentation for that product.

What is in this book

This book provides conceptual information about the scripting Adobe Bridge and detailed reference information about the JavaScript objects that Adobe Bridge provides. It also provides both usage and reference information for the tools, utilities, and objects that are part of ExtendScript, the Adobe extended implementation of JavaScript.

This book contains the following chapters:

  • Chapter 1, “Scripting Bridge,” on page 5 introduces some important concepts in Adobe Bridge scripting and describes the Bridge JavaScript document object model (DOM).

  • Chapter 2, “Event Handling and Script-Defined Browse Schemes,” on page 17 describes how Adobe Bridge generates user-interaction events, and how you can respond to these events by defining handlers in your scripts. In addition, it describes how to define browse schemes that allow you to extend or modify what is shown in the Bridge Favorites pane.

  • Chapter 3, “Creating a User Interface,” on page 27 describes the various options available to scripts for interaction with Bridge users, such as dialog boxes and navigation bars.

  • Chapter 4, “Using File and Folder Objects,” on page 51 describes how to use the ExtendScript objects that provide platform-independent access to the underlying file system.

  • Chapter 5, “Using ScriptUI,” on page 57 describes how to use the ExtendScript user-interface module, a set of objects which provide windows and user-interface controls for the scripting environment.

  • Chapter 6, “Bridge DOM Object Reference,” on page 97 provides a complete API reference for the objects, properties, and functions defined in the Bridge domain object model.

  • Chapter 7, “File and Folder Object Reference,” on page 139 provides a complete API reference for the ExtendScript file-system access objects, properties, and functions.

  • Chapter 8, “ScriptUI Object Reference,” on page 157 provides a complete API reference for the ExtendScript user-interface objects, properties, and functions.

  • Chapter 9, “Interapplication Communication with Scripts,” on page 193 describes how to use the interapplication communication framework, and provides a complete API reference for the Cross-DOM and for the messaging framework.

  • Chapter 10, “ExtendScript Tools and Features,” on page 219 describes the ExtendScript Toolkit debugging environment, and provides a complete API reference for the ExtendScript utilities and features that are available to all Adobe Creative Suite 2 applications.

Document conventions

Typographical conventions

Monospaced fontLiteral values and code, such as JavaScript code, HTML code, filenames, and pathnames.
ItalicsVariables or placeholders in code. For example, in name="myName", the text myName represents a value you are expected to supply, such as name="Fred". Also indicates the first occurrence of a new term.
Sans-serif bold fontThe names of Bridge UI elements (menus, menu items, and buttons). The > symbol is used as shorthand notation for navigating to menu items. For example, Edit > Cut refers to the Cut item in the Edit menu.


Note

Notes highlight important points that deserve extra attention.


JavaScript conventions

This reference does not list properties and methods provided by the JavaScript language itself. For example, it is common for JavaScript objects to provide a toString method, and many of the objects the SDK supplies implement this method. However, this book does not describe such methods unless they differ from the standard JavaScript implementation.

Similarly, because most objects provided by the SDK have a name property, the reference does not list name properties explicitly.

When a JavaScript function returns a value, it is listed. When there is no return value listed, the function does not return a value.

Where to go for more information

This book does not describe the JavaScript language. For documentation of the JavaScript language or descriptions of how to use it, see any of numerous works on this subject, including the following:

JavaScript: The Definitive Guide, 4th Edition; Flanagan, D.; O’Reilly 2001; ISBN 0-596-00048-0

JavaScript Programmer’s Reference; Wootton, C.; Wrox 2001; ISBN 1-861004-59-1

JavaScript Bible. 5th Edition; Goodman, D. and Morrison, M.; John Wiley and Sons1998; ISBN 0-7645-57432

JavaScript for the World Wide Web, Fifth Edition: Visual QuickStart Guide; Negrino, Tom and Smith, Dori; Peachpit 2003; ISBN 0-321-19439-X

  • Creative Edge
  • Create BookmarkCreate Bookmark
  • Create Note or TagCreate Note or Tag
  • PrintPrint