PatchPanel
From Adobe Labs
| Table of contents |
Introduction to the Adobe® PatchPanel Technology - Preview Release 2
Adobe is pleased to offer our third-party developers and the larger Adobe Flex® development community this preview of PatchPanel, a first glimpse at combining the dynamic control of ActionScript™ with the power of Adobe’s Creative Suite®. Similar to Adobe’s ExtendScript environment for the Creative Suite, PatchPanel provides developers deep access into controlling the Creative Suite through independently-created scripts. PatchPanel provides the necessary link between the Flex development environment and the Creative Suite’s internal controls, allowing existing ActionScript developers the ability to apply their skills toward enhancing the creative process, as well as inviting a new generation of creative minds to explore the flexibility and automation possible with ActionScript.
PatchPanel is a Flex library and set of services that make it possible for Shockwave® Flash® (SWF) files to work as Adobe Creative Suite CS3 and CS4 plug-ins. Flex developers can include this Flex library in their projects in order to create Flash plug-ins that access the ExtendScript Document Object Model (DOM) of Creative Suite applications through ActionScript objects.
Note: PatchPanel is the temporary internal name of this technology. The final name has not been determined.
Note: Your use of this site including software downloads, submission of comments, ideas, feature requests and techniques on this and other Adobe maintained forums, as well as Adobe’s rights to use such materials, is governed by the Terms of Use.
PatchPanel Software Development Kit (SDK) for Adobe Flex Developers
The library and software development kit (PatchPanel SDK) is available for Creative Suite 3 and for Creative Suite 4, with versions for Windows XP/Vista, and for Mac OSX. The structure of the SDK is the same for both Creative Suite 3 and Creative Suite 4, but the names of some files and folders contain either "cs3" or "cs4", depending on the version.
System and Software Requirements
The system requirements for the PatchPanel SDK are:
- Microsoft® Windows® XP with service pack 2 or greater
- Microsoft Windows Vista™ with service pack 1 or greater
- Mac OS X 10.4
- Mac OS X 10.5
Other software required
- PatchPanel is used with Adobe Flex Builder™ 3, which is available from http://www.adobe.com/go/flex. This is a highly productive, open-source framework for building and maintaining expressive web applications that deploy consistently on all major browsers, desktops, and operating systems.
- In addition to Flex Builder, you must have at least one of the following Creative Suite 3 or 4 products installed:
Installing the PatchPanel SDK
- Windows XP and Vista:
- Download the PatchPanel ZIP file based on the version of the Creative Suite products you are using:
- PatchPanel for use on Windows with Creative Suite 3 products.
- PatchPanel for use on Windows with Creative Suite 4 products.
- Unzip the package.
- Mac OSX:
- Download the PatchPanel DMG file based on the version of the Creative Suite products you are using:
- PatchPanel for use on Mac OSX with Creative Suite 3 products.
- PatchPanel for use on Mac OSX with Creative Suite 4 products.
- Double-click the DMG file to mount the installer virtual disk.
Getting Started
Once you have installed the PatchPanel SDK, see the Getting Started with Adobe PatchPanel document included in the SDK.
Known Issues
- CS3 products display empty SWFs on Mac OSX 10.5
- In CS3 products, only first frames of SWFs are displayed in Mac OSX 10.5. The result is an empty frame without any controls. This problem is fixed in CS4 products. InDesign 5.0.4 provides a fix for the problem in CS3.
- InDesign CS3 crashes on quit after using a Flash plug-in
- InDesign CS3 crashes on quit after using a panel that runs a SWF. This problem is fixed in CS4 products. InDesign 5.0.4 provides a fix for the problem in CS3.
- Tracing is not supported
- The trace() statement is currently not supported when debugging SWFs in host applications with Flex Builder's debugger.
- SWFs launched from Windows > Extensions in CS4 do not support callbacks
- In CS4, you can launch your PatchPanel SWF using File > Scripts or Windows > Extensions. If you launch from Windows > Extensions, PatchPanel takes advantage of a technology called CSXS, which is being introduced with CS4 products. Because of limitations in the architecture of CSXS, PatchPanel is not able to register callbacks with the host application. The Callback example will therefore not work properly when executed through Windows > Extensions.
- Running the install script in ExtendScript Toolkit CS3 fails on Vista when UAC is enabled
- Every sample application comes with a small install script called Install.jsx that allows you to conveniently install your sample. When you double click the Install.jsx file, the operating system launches either ExtendScript Toolkit 2.0 or ExtendScript Toolkit CS4, depending on whether you have installed CS3 or CS4. If you only have CS3 installed and you run the script within ExtendScript Toolkit 2.0 on Vista, while User Access Control (UAC) is enabled, the installation fails, because Vista prevents write access to system folders. The script shows an alert if the error occurs.
- As a workaround, either manually create the folders and copy the files, or turn off UAC temporarily while running Install.jsx.
- Adobe Illustrator CS4 does not register PatchPanel SWFs under Windows > Extensions
- SWFs that are copied into Adobe Illustrator CS4’s Plug-ins/Panels folder are not automatically registered under Windows > Extensions.
- As a workaround, copy your project.js script into Preset/Scripts and launch your SWF using File > Scripts.
- Adobe InDesign CS3 and CS4 incorrectly report their status
- PatchPanel clients can check the status of a CS application by using the BridgeTalk.ping() method as follows:
- BridgeTalk.ping( <target>, "STATUS" );
- CS applications usually return "BUSY" if a modal dialog is currently open, and otherwise "IDLE". This method cannot be used for InDesign CS3 and CS4. Future versions of InDesign will provide a fix for this problem.
- PatchPanel emulates Point and Rect in Adobe Illustrator CS3 and CS4
- The Illustrator Scripting Reference mentions two classes, Point and Rect, that are not supported by Illustrator’s scripting Document Object Model (DOM). PatchPanel compensates for the difference between documentation and implementation by providing Point and Rect implementations for Illustrator CS3 and CS4.
Release Notes
- Preview Release 2
- Adobe PatchPanel 0.62 was released on 12/16/2008.
- This version includes Adobe SwitchBoard 1.1.37
- Fixed: Photoshop CS4 crashes when launched with PatchPanel CS4 AdobeOwl.dll
- Fixed: Cannot retrieve Selection.Bounds in Photoshop
- Fixed: Missing constructor for ExtendScript's UnitValue
- Fixed: SwitchBoard.Client.init() always returns true
- Preview Release 1
- Adobe PatchPanel 0.61 was released on 11/18/2008.
- This version includes Adobe SwitchBoard 1.1.35
For more information
- PatchPanel provides access to ExtendScript DOMs (Document Object Models) for Creative Suite applications. For links to documents and other resources that provide details of the available DOMs and background information about ExtendScript programming, visit the Adobe Scripting Center.
- Discuss PatchPanel in the Labs discussion forums.
