CEP 5 HTML Extension Cookbook for CC 2014

Pedro Maltez edited this page May 1, 2016 · 14 revisions

This cookbook is a guide of tips and samples for creating CEP HTML/JavaScript Extensions for Creative Cloud 2014 applications.

CEP Extensions

CEP (formerly CSXS) Extensions extend the functionality of the host application that they run in. Extensions are loaded into applications through the PlugPlug Library architecture. Starting from CEP 4.0, HTML/JavaScript technology can be used to develop extensions.

Extension Types

Currently there are four types of CEP extensions that can be created - Panel, Modal Dialog, Modeless Dialog and invisible extension.

  • The Panel type of extension behaves like any other application panel. It can be docked, participates in workspaces, has fly-out menus, and is re-opened at start-up if open at shutdown. The corresponding type identifier in the extension manifest is Panel.
  • The Modal Dialog type opens a new window and forces the user to interact with the window before returning control to the host application. The corresponding type identifier in the extension manifest is ModalDialog.
  • The Modeless Dialog type opens a new window but doesn't force the user to interact with it. The corresponding type identifier in the extension manifest is Modeless.
  • The invisible extension is the one that remains hidden and never becomes visible during its whole life cycle. Read "Invisible HTML Extensions" for more details.

Extensions can be installed by clients using Extension Manager or Adobe Exchange.

Chromium Embedded Framework (CEF)

CEP is based on the Chromium Embedded Framework version 3 (CEF3). You can find more information about CEF on http://code.google.com/p/chromiumembedded/. We currently use CEF version: CEF 3, branch 1453, revision 1339

Browser Features supported by CEP

HTML5

CEP currently supports the following HTML5 features:

  • Video
  • Audio
  • Drag and Drop
  • Canvas
  • SVG
  • Web Workers
  • Web Storage
  • Web SQL Database
  • Application Cache
  • Server sent events
  • Form input types
  • Form elements
  • Form attributes
  • File API

HTTP Cookies

CEP supports two kinds of cookies:

  • Session Cookies - Temporary in-memory cookie which will expire and disappear when user closes extension
  • Persistent Cookies - No expiry date or validity interval, stored in the user's file system

Persistent Cookies location:
Windows: C:\Users\USERNAME\AppData\Local\Temp\cep_cache\
Mac: /Users/USERNAME/Library/Logs/CSXS/cep_cache/

Each persistent cookie is a file. File name is HostID_HostVersion_ExtensionName, such as PHXS_14.0.0_com.adobe.extension1.

Development and Debugging

Development Machine Setup

CEP HTML Extensions can be developed on both Windows and Mac platforms. The development machine needs to have the following applications in order to successfully develop CSXS extensions:

  • Adobe Creative Suite applications supporting CEP HTML extensions.
  • HTML Extension Builder.(Nice to have, but not mandatory). HTML Extension Builder is a tool set built on top of Eclipse and can be used for developing and debugging HTML extensions. Please download the Extension Builder 3 from http://labs.adobe.com/technologies/extensionbuilder3/
  • Adobe ExtendScript Tool Kit (This tool kit is installed with all Creative Suite applications).
  • Adobe Extension Manager

Signing Extensions

Before you sign the extensions, you need to get or create the certificate file. Configurator and Adobe Exchange Packer can create certificates. The developer can get all the required information from https://www.adobeexchange.com/resources/7#overview (please sign in so that you can see the content).

Three tools can be used to sign a HTML5 extension.

ccextensionswin64.exe -sign "d:\Adobe Layer Namer\Adobe Layer Namer\"(input extension path) d:\AdobeLayerNamer.zxp(output zxp path) d:\sign.p12(certificate path) 1(certificate password)

Debugging Unsigned Extensions

If you are in the midst of development and are not using HTML Extension Builder for debug workflows and want to bypass the need to sign your extensions, you can bypass the check for extension signature by editing the CSXS preference properties file, located at:
Win: regedit > HKEY_CURRENT_USER/Software/Adobe/CSXS.5, then add a new entry PlayerDebugMode of type "string" with the value of "1".
Mac: In the terminal, type: defaults write com.adobe.CSXS.5 PlayerDebugMode 1 (The plist is also located at /Users/USERNAME/Library/Preferences/com.adobe.CSXS.5.plist)

These entries will enable debug extensions to be displayed in the host applications.

Remote Debugging

CEP supports remote debugging for html extensions. Create and put a “.debug” file to the extension root directory such as Test_Extension.debug. The .debug file contains remote debug ports. Developers must create this file and use valid debug ports. ".debug" is a special file name for both Windows and Mac platform, it has to be created by command line.
On Windows, use "copy con .debug" and "Ctrl+Z" to create an empty file.
On Mac, use "touch .debug" to create an empty file.

The value of Port should be between 1024 and 65535 (not include 65535), otherwise remote debugging will not work. One extension bundle may have multiple extensions so the .debug file can specify debug ports for each extension. Here is an example file.

<?xml version="1.0" encoding="UTF-8"?>
<ExtensionList>
    <Extension Id="com.adobe.CEPHTMLTEST.Panel1">
        <HostList>
            <Host Name="PHXS" Port="8000"/>
            <Host Name="IDSN" Port="8001"/>
            <Host Name="AICY" Port="8002"/>
            <Host Name="ILST" Port="8003"/>
            <Host Name="PPRO" Port="8004"/>
            <Host Name="PRLD" Port="8005"/>
            <Host Name="FLPR" Port="8006"/>
        </HostList>
    </Extension>
    <Extension Id="com.adobe.CEPHTMLTEST.Panel2">
        <HostList>
            <Host Name="PHXS" Port="8100"/>
            <Host Name="IDSN" Port="8101"/>
            <Host Name="AICY" Port="8102"/>
            <Host Name="ILST" Port="8103"/>
            <Host Name="PPRO" Port="8104"/>
            <Host Name="PRLD" Port="8105"/>
            <Host Name="FLPR" Port="8106"/>
        </HostList>
    </Extension>
    <Extension Id="com.adobe.CEPHTMLTEST.ModalDialog">
        <HostList>
            <Host Name="PHXS" Port="8200"/>
            <Host Name="IDSN" Port="8201"/>
            <Host Name="AICY" Port="8202"/>
            <Host Name="ILST" Port="8203"/>
            <Host Name="PPRO" Port="8204"/>
            <Host Name="PRLD" Port="8205"/>
            <Host Name="FLPR" Port="8206"/>
        </HostList>
    </Extension>
    <Extension Id="com.adobe.CEPHTMLTEST.Modeless">
        <HostList>
            <Host Name="PHXS" Port="8300"/>
            <Host Name="IDSN" Port="8301"/>
            <Host Name="AICY" Port="8302"/>
            <Host Name="ILST" Port="8303"/>
            <Host Name="PPRO" Port="8304"/>
            <Host Name="PRLD" Port="8305"/>
            <Host Name="FLPR" Port="8306"/>
        </HostList>
    </Extension>
</ExtensionList>

If you load an extension whose debug port is 8088, open the port from the Chrome browser by using URL http://localhost:8088/.

Known Issues

  • If you attempt to launch an extension using the requestOpenExtension API and the extension invoking the API has the same debug port as the target extension, the target extension will not load.
  • Due to a bug (which should be fixed in Webkit inspector), in the dev tools, you cannot inspect the variables or open watches. please do the following steps to workaround this issue when it happens: Open the Developer tools from Chrome browser main menu by choosing View->Developer->Developer Tools Execute the following JS snippet in the Console:
TreeElement.prototype.isEventWithinDisclosureTriangle = function(event) {
  var computedLeftPadding = 10;
  if(window.getComputedStyle(this._listItemNode).getPropertyCSSValue) {
    computedLeftPadding = window.getComputedStyle(this._listItemNode).getPropertyCSSValue("padding-left").getFloatValue(CSSPrimitiveValue.CSS_PX);
  }
  var left = this._listItemNode.totalOffsetLeft() + computedLeftPadding;
  return event.pageX >= left && event.pageX <= left + this.arrowToggleWidth && this.hasChildren;
}

Where are the log files

PlugPlug Logs

Log files with useful debug information are created for each of the applications supporting CEP extensions. These files are generated with the naming convention as csxs-.log. For Illustrator, the log file is csxs5-ILST.log. The platform-specific locations for the log files are as follows:

Win: C:\Users\USERNAME\AppData\Local\Temp
Mac: /Users/USERNAME/Library/Logs/CSXS

Logging levels can be modified as per the following levels:

  • 0 - Off (No logs are generated)
  • 1 - Error (the default logging value)
  • 2 - Warn
  • 3 - Info
  • 4 - Debug
  • 5 - Trace
  • 6 - All The LogLevel key can be updated at the following location (The application should be restarted for the log level changes to take effect):
Win: regedit > HKEY_CURRENT_USER/Software/Adobe/CSXS.5
Mac: /Users/USERNAME/Library/Preferences/com.adobe.CSXS.5.plist

For example on Mac, in the terminal do:

defaults write com.adobe.CSXS.5 LogLevel <loglevel>

Where are the Extensions

To run an extension, copy it into the shared extensions folder on disk. System extension folder

Win: C:\Program Files (x86)\Common Files\Adobe\CEP\extensions
Mac: /Library/Application Support/Adobe/CEP/extensions

Per-user extension folder

Win: C:\<username>\AppData\Roaming\Adobe\CEP\extensions
Mac: ~/Library/Application Support/Adobe/CEP/extensions

Extension Manifest

The manifest.xml file is required for every extension and provides the necessary information to configure a CEP extension. ExtensionManifest is the root element of the manifest.xml file. Extensions, ExtensionList, and DispatchList are the three child elements of the ExtensionManifest root element.

Extension Manifest XSD

To check if the extension's manifest is in sync with the latest schema, perform the following steps:

Important Manifest Change for CEP 5.0 Extensions

Make sure correct point product versions are used. Here is an example.

<HostList>
    <Host Name="PHXS" Version="[15.0,15.9]"/>
    <Host Name="PHSP" Version="[15.0,15.9]"/>
</HostList>

This will support Photoshop version 15.0 up to, and including, 15.9. If you use the following syntax then you are supporting releases up to 15.9 but not including 15.9

<HostList>
    <Host Name="PHXS" Version="[15.0,15.9)"/>
    <Host Name="PHSP" Version="[15.0,15.9)"/>
</HostList>

Make sure correct CEP version is used.

<RequiredRuntimeList>
    <RequiredRuntime Name="CSXS" Version="5.0"/>
</RequiredRuntimeList>

Extension Size

You can specify extension size, max size and min size in extension manifest. Size is mandatory; max size and min size are optional. A modal or modeless dialog is resizable if there are max size and min size, otherwise it is un-resizable. When you move mouse pointer over dialog border, CEP shows different cursor for resizable and un-resizable dialogs.

<Geometry>
    <Size>
        <Height>580</Height>
        <Width>1000</Width>
    </Size>
    <MaxSize>
        <Height>800</Height>
        <Width>1200</Width>
    </MaxSize>
    <MinSize>
        <Height>400</Height>
        <Width>600</Width>
    </MinSize>
</Geometry>

High DPI Panel Icons

In high DPI display mode, panel extensions may want to use high DPI icons. You set these icons in extensions manifest.

<Icons>
 <Icon Type="Normal">./images/IconLight.png</Icon>
 <Icon Type="RollOver">./images/IconLight.png</Icon>
 <Icon Type="DarkNormal">./images/IconDark.png</Icon>
 <Icon Type="DarkRollOver">./images/IconDark.png</Icon>
</Icons>

You pack both normal icon files (IconLight.png and IconDark.png) and high DPI icon files (IconLight@2X.png and IconDark@2X.png) in your extension. Host applications will be able to find and use

@2X.ext is the industry standard. Please see more details on https://developer.apple.com/library/ios/qa/qa1686/_index.html.

Please note that Photoshop supports _x2.ext format.

Shortcut Keys for HTML Extensions

(Since 5.2) CEP 5.2 supports shortcut keys for html extensions. When focus is on HTML extensions, these shortcut keys are handled by extension.

Windows Keys Mac Keys Function
Ctrl + A Command + A Select All
Ctrl + C Command + C Copy
Ctrl + V Command + V Paste
Ctrl + X Command + X Cut

Other shortcut keys are handled by point products, such as pressing Ctrl + N to create a new document.

CEP JavaScript Programming

CEP JavaScript Libraries

CEP JavaScript Libraries provide JavaScript APIs to access application and CEP information.

  • CSInterface.js
  • Vulcan.js
  • AgoraLib.js

Get them from https://github.com/Adobe-CEP/CEP-Resources. To use them, please include these JavaScript files in your HTML extension.

API version

The CEP JavaScript APIs keep changing with each new CEP release. The changes are guaranteed to be backward compatible. For newly added APIs, a version tag like "Since x.x.x" is added to its API comments indicating since which CEP version the APIs is available.

You will need to check the version tag against the version of CEP integrated by the Adobe Product you are using to make sure the API you want to use is available. To do so, use CSInterface.getCurrentApiVersion() to retrieve the version of CEP integrated by the Adobe Product. Please note this API itself is available only since 4.2.0. If you get an error saying getCurrentApiVersion is undefined, then you are running in CEP 4.0 or 4.1. Otherwise, the value returned will tell you the version of CEP integrated by the Adobe product.

CEP Events

CEP supports sending and receiving events within an extension, among extensions in application, and among extensions in different applications. Since both Flash and HTML extensions are based on the common communication layer with the same event data format, they could communicate with each other based on CEP event, and even they could communicate with native side as long as point products invoke PlugPlugAddEventListener/PlugPlugDispatchEvent accordingly to achieve this.

Like what we have for Flash extensions, there are dispatchEvent/addEventListener/removeEventListener APIs available in JavaScript world to dispatch and listen for events. Let's go through CEP event data format/structure, APIs to dispatch and listen event, and sample code snippet accordingly in JavaScript world.

CSEvent

In terms of CSEvent, it just means CEP Event here. The data structure of CSEvent (CEP Event) in JavaScript is just the same as the one defined in Flash extension, as below.

/**
 * Class CSEvent.
 * You can use it to dispatch a standard CEP event.
 *
 * @param type        Event type.
 * @param scope       The scope of event, can be "GLOBAL" or "APPLICATION".
 * @param appId       The unique identifier of the application that generated the event. Optional.
 * @param extensionId The unique identifier of the extension that generated the event. Optional.
 *
 * @return CSEvent object
 */
function CSEvent(type, scope, appId, extensionId)
{
    this.type = type;
    this.scope = scope;
    this.appId = appId;
    this.extensionId = extensionId;
};

You could create a CSEvent object and dispatch it by using CSInterface.dispatchEvent. Also you could access its property in your callback of CSInterface.addEventListener. Refer to the section addEventListener/dispatchEvent below for more details.

Listen for and Dispatch CSEvent

dispatchEvent/addEventListener/removeEventListener APIs are available in JavaScript world to dispatch and listen for CSEvent.

addEventListener

Here is the definition for addEventListener. Refer to CSInterface.js for more information.

/**
 * Registers an interest in a CEP event of a particular type, and
 * assigns an event handler.
 * The event infrastructure notifies your extension when events of this type occur,
 * passing the event object to the registered handler function.
 *
 * @param type     The name of the event type of interest.
 * @param listener The JavaScript handler function or method.
 * @param obj      Optional, the object containing the handler method, if any.
 *         Default is null.
 */
CSInterface.prototype.addEventListener = function(type, listener, obj)

One thing needs to be mentioned here is both named and anonymous callback functions are supported in CSInterface.addEventListener. Here is an example of how to use named callback function in CSInterface.addEventListener:

function callback(event)
{
  console.log(“type=” + event.type + “, data=” + event.data);
}

var csInterface = new CSInterface();
csInterface.addEventListener(“com.adobe.cep.test”, callback); //invoke the function

Here is an example of how to use anonymous callback function in CSInterface.addEventListener.

    var csInterface = new CSInterface();
    csInterface.addEventListener(“com.adobe.cep.test”, function (event)
        {
           console.log(“type=” + event.type + “, data=” + event.data);
        }
    ); // Anonymous function is the second parameter

Besides, like flash world, event.data could even be an object, i.e. you could use an object as event.data. If you use a JSON object as event data, there is a known issue that the data order will be messed up sometimes. A work around for this issue is using JSON.stringify() to convert this JSON object to a string first, and then add any prefix to this string like “Your JSON string”. Here is an example on how to use it.

    var csInterface = new CSInterface();
    csInterface.addEventListener(“com.adobe.cep.test”, function (event)
        {
           var obj = event.data;
           console.log(“type=” + event.type + “, data.property1=” + obj.property1 + “, data.property2=” + obj.property2);
        }
    ); // Anonymous function is the second parameter

dispatchEvent

Here is the definition for CSInterface.dispatchEvent. Refer to CSInterface.js for more details.

/**
 * Triggers a CEP event programmatically. Yoy can use it to dispatch
 * an event of a predefined type, or of a type you have defined.
 *
 * @param event A \c CSEvent object.
 */
CSInterface.prototype.dispatchEvent = function(event)

Here are three samples to demonstrate how to dispatch event in JavaScript. Firstly an example of how to dispatch event in JavaScript.

    var csInterface = new CSInterface();
    var event = new CSEvent("com.adobe.cep.test", "APPLICATION");
    event.data = "This is a test!";
    cSInterface.dispatchEvent(event);

Another example of creating event object and setting property, then dispatch it.

    var csInterface = new CSInterface();
    var event = new CSEvent();
    event.type = "com.adobe.cep.test";
    event.scope = "APPLICATION";
    event.data = "This is a test!";
    cSInterface.dispatchEvent(event);

An example of dispatching an event whose data is an object.

    var event = new CSEvent("com.adobe.cep.test", "APPLICATION");
    var obj = new Object();
    obj.a = "a";
    obj.b = "b";
    event.data = obj;
    cSInterface.dispatchEvent(event);

Communication between Flash and Html extensions

CEP event based communication between Flash and Html extensions is simple, as long as the event data is string. You could simply use API of dispatching and listening event accordingly.

If you dispatch an event whose data is an object in Javascript and handle it in Flash side, then you need a little bit conversion work to do in Flash extension. Since in JavaScript the object is serialized as JSON string, you need to deserialize it to be an XML-based object in Flash side. Vice versa, if you dispatch an event whose data is an object in Flash and handle it in JavaScript side, you need to deserialize it from XML to be JSON-based object in JavaScript side. Anyway, considering that usage of Flash extension is down, therefore the communication between Flash and Html extension is limited, and object-based event data is very limited.

Handling Window State Change Events - Extensions

Unlike Flash extension, Html extension does not support Window State Change Events.

Standard Events in Point Products

The following table lists the standard events currently supported by Point Products:

Event Type Description Event Parameter PHXS IDSN ILST FLPR PPRO PRLD
documentAfterActivate Event fired when a document has been activated (after new/open document;after document has retrieved focus). URL to the active document. If the doc was not save, the NAME will be set instead of the URL. :white_check_mark: :white_check_mark:
documentAfterDeactivate Event fired when the active document has been de-activated. (after document loses focus) URL to the active document. If the doc was not save, the name will be set instead of the URL. :white_check_mark: :white_check_mark: :white_check_mark:
applicationBeforeQuit Event fired when the application got the signal to start to terminate. none :white_check_mark:
applicationActivate Event fired when the Application got an "activation" event from the OS. none :white_check_mark: :white_check_mark: :white_check_mark: :white_check_mark: (on Mac) :white_check_mark: (on Mac)
documentAfterSave Event fired after the document has been saved URL to the saved document. :white_check_mark: :white_check_mark:

Specific Events in Products

Photoshop

In Photoshop, the following specific events are defined:

  • com.adobe.PhotoshopPersistent
  • com.adobe.PhotoshopUnPersistent
  • com.adobe.PhotoshopCallback
  • com.adobe.PhotoshopWorkspaceSet
  • com.adobe.PhotoshopWorkspaceGet
  • com.adobe.PhotoshopWorkspaceAware
  • com.adobe.PhotoshopWorkspaceData
  • com.adobe.PhotoshopWorkspaceRequest
  • com.adobe.PhotoshopRegisterEvent
  • com.adobe.PhotoshopUnRegisterEvent
  • com.adobe.PhotoshopLoseFocus
  • com.adobe.PhotoshopQueryDockingState

For example, Html extension yields the mouse focus back to Photoshop by sending out com.adobe.PhotoshopLoseFocus event, like below

var csInterface = new CSInterface();
var event = new CSEvent("com.adobe.PhotoshopLoseFocus", "APPLICATION");
event.extensionId = csInterface.getExtensionID();
csInterface.dispatchEvent(event);

Invoke point product's scripts from html extension

First, define a callback function in html extension:

function evalScriptCallback(result)
{
   // process the result string here.
}

And then call CSInterface.evalScript with the script you want to call and the callback function:

var script = "app.documents.add";  //Demo script
CSInterface.evalScript(script, evalScriptCallback);

Access Application DOM from Html Extension

There are two separate JavaScript engines here.

  • JavaScript engine of host application - Application DOM/Extend script DOM
  • JavaScript engine of CEP Html runtime - Html DOM

Application DOM is not available in Html extension's engine and Html DOM is not available in host application's engine.

To access Application DOM from Html extensions, CEP JavaScript library provides a API CSInterface.evalScript to execute extend script as so to access application's DOM. Here is the sample JavaScript code snippet in Html extension.

var csInterface = new CSInterface();
csInterface.evalScript('app.documents.add();', function(result) {
  alert(result);
});

Access HTML DOM from extend script

There is no way to access HTML extension's JavaScript DOM directly from Application's ExtendScript. If you need to access it, CEP event based communication can be used as a substitution.

CEP creates a library which uses External Object mechanism of ExtendScript to send CSXS events. The external object provides an ExtendScript class CSXSEvent for creating and dispatching application-level CSXS events. On HTML extension side, event listeners can be registered via the addEventListener API in CSInterface.js to listen to the events.

Some CC applications (Photoshop, Illustrator, Premiere Pro) integrate PlugPlugExternalObject library and have started to support this functionality in CC 2014 release.

Sample Code

ExtendScript developers need to create external object instance first.

var externalObjectName = "PlugPlugExternalObject";
var mylib = new ExternalObject( "lib:" + externalObjectName );

And then create the CSXSEvent instance.

var eventObj = new CSXSEvent();
eventObj.type="documentCreated"; 
eventObj.data="blahblah"; 

At last use this instance to dispatch event:

eventObj.dispatch();

Below is the sample code of ExtendScript.

...
var cs = new CSInterface();

cs.addEventListener("documentCreated", function(event) {
    alert('Cool!' + event.data);
});

var extendScript = 'var externalObjectName = "PlugPlugExternalObject"; var mylib = new ExternalObject( "lib:" + externalObjectName ); app.document.add(); var eventObj = new CSXSEvent(); eventObj.type="documentCreated"; eventObj.data="blahblah"; eventObj.dispatch();'
cs.evalScript(extendScript);

Fly out menu

Creating a fly out menu on the native panel of HTML extension is now supported by using the setPanelFlyoutMenu and updatePanelMenuItem APIs in CSInterface.

The "menu" parameter for "setPanelFlyoutMenu" is a XML string. Below is an example:

<Menu>
  <MenuItem Id="menuItemId1" Label="TestExample1" Enabled="true" Checked="false"/>
  <MenuItem Label="TestExample2">
     <MenuItem Label="TestExample2-1" >
        <MenuItem Label="TestExample2-1-1" Enabled="false" Checked="true"/>
     </MenuItem>
     <MenuItem Label="TestExample2-2" Enabled="true" Checked="true"/>
  </MenuItem>
  <MenuItem Label="---" />
  <MenuItem Label="TestExample3" Enabled="false" Checked="false"/>
</Menu>

If you want to be notified of menu item clicks, register "com.adobe.csxs.events.flyoutMenuClicked" Event by calling AddEventListener. When an menu item is clicked, the event callback function will be called. The "data" attribute of the event is an object which contains "menuId" and "menuName" attributes.

Customize Context Menu

Set and Update Context Menu

There are APIs in CSInterface for developers to set and update the customized context menu.

CSInterface.prototype.setContextMenu
CSInterface.prototype.updateContextMenuItem

The "menu" parameter for "setContextMenu" is a XML string.

  • Id - Menu item ID. It should be plain text.
  • Label - Menu item label. It supports localized languages.
  • Enabled - Whether the item is enabled or disabled. Default value is true.
  • Checkable - Whether the item can be checked/unchecked. Default value is false.
  • Checked - Whether the item is checked or unchecked. Default value is false.

Here is an example.

<Menu>
   <MenuItem Id="menuItemId1" Label="TestExample1" Enabled="true" Checked="false"/>
   <MenuItem Id="menuItemId2" Label="TestExample2">
     <MenuItem Id="menuItemId2-1" Label="TestExample2-1" >
       <MenuItem Id="menuItemId2-1-1" Label="TestExample2-1-1" Enabled="false" Checkable="true" Checked="true"/>
     </MenuItem>
     <MenuItem Id="menuItemId2-2" Label="TestExample2-2" Enabled="true" Checkable="true" Checked="true"/>
   </MenuItem>
   <MenuItem Label="---" />
   <MenuItem Id="menuItemId3" Label="TestExample3" Enabled="false" Checked="false"/>
</Menu>

The "callback" parameter is the callback function which is called when user clicks a menu item. The only parameter is the ID of clicked menu item.

If developers do not set context menu, CEP shows default items (Back, Forward, View Source, etc.). This is compatible with previous releases. If developers set context menu, CEP removes all default items and shows customized items only.

Disable Context Menu

To disable the context menu, you can call setContextMenu with null.

Another way is to add oncontextmenu="return false;" to the HTML tag. For example,

<body oncontextmenu="return false;">

Other Implementation of Context Menu

Please refer to http://www.javascripttoolbox.com/lib/contextmenu/ for examples.

HI-DPI display

CEP JavaScript library provides APIs for detecting the availability of HI-DPI display on the Mac platform. CSInterface.getScaleFactor(). Use this function to retrieve the scale factor of the display on which the calling extension window is located.

var scaleFactor = CSLibrary.getScaleFactor();
CSInterface.setScaleFactorChangedHandler()

Use this function to add a event handler that will be called when calling extension window is moved between HI-DPI and non-HI-DPI displays.

    window.scaleFactorHandler = function() {
        var scaleFactor = CSLibrary.getScaleFactor();
        if (2 == scaleFactor) {
                imgSrc = "../img/PS_AppIcon_r.png"
        } else {
            imgSrc = "../img/PS_AppIcon.png"
        }
        document.getElementById("image").src = imgSrc;
     }

    CSLibrary.setScaleFactorChangedHandler(window.scaleFactorHandler);

CEP 5.2 supports HiDPI on Windows.

Other JavaScript APIs

The JavaScript engine in CEPHTMLEngine had been extended to provide some APIs, including:

  • local file access
  • native process
  • others

These APIs are in the JavaScript DOM and can be used as other built-in JavaScript APIs. You do NOT need to include any JavaScript files. API reference is as below.

Create a folder.

var path = "/tmp/test";
var result = window.cep.fs.makedir(path);
if (0 == result.err) {
     ...// success
}
else {
     ...// fail
} 

Write a file.

var data = "This is a test.";
var path = "/tmp/test";
var result = window.cep.fs.writeFile(path, data);
if (0 == result.err) {
     ...// success
}
else {
     ...// fail
}

Write file with base64 encoding mode

You need to convert the input string to a base64-encoded string before calling writeFile(). The following is an example.

var data = "This is a test.";
var path = "/tmp/test";
data = cep.encoding.convertion.utf8_to_b64(data);

var result = window.cep.fs.writeFile(fileName, data, cep.encoding.Base64);
if (0 == result.err) {
     ...// success
}
else {
     ...// fail
}

Read a file

var path = "/tmp/test";
var result = window.cep.fs.readFile(path);
if (0 == result.err) {
      //success
     alert(result.data); //result.data is file content
}
else {
     ...// fail
}

Read file with base64 encoding mode

The read data after readFile is called is converted to a base-encoded string. You need to decode this string to any format you want. The following is an example

var path = "/tmp/test";
result = window.cep.fs.readFile(path, cep.encoding.Base64);
if (0 == result.err) {
     //success
     var base64Data = result.data;
     var data = cep.encoding.convertion.b64_to_utf8(base64Data);
}
else {
     ...// fail
}

Create a process and check if it's running

var result = window.cep.process.createProcess("usr/X11/bin/xterm");
        if (0 == result.err) {
            var pid = result.data;
            result = window.cep.process.isRunning(pid);
            if (true == result.data) {
               // running                 
            }
        }

You could use other APIs like delete folder, rename folder, set file permission, delete file, show file open dialog, quit process, etc.

Localization

In order to support localization, both the extension and the host application must provide locale information. There are two distinct types of locale information.

  • The License Locale (returned as the applicationLocale by the AMT library)
  • The Effective/Language/UI Locale (which is controlled by the user in the OS settings).

The extension must provide the list of supported locales for both the License Locale and the Language Locale via the HostEnvironment. This is particularly important in cases where the extension has features for a specific locale. PlugPlug library expects the host application to provide the locale information as part of the environmental data. JavaScript API HostEnvironment has the appLocale property in place.

License Locale and locales supported by extension

CEP checks the License Locale of host application against supported locales declared in extensions locale list to determine if the extension is loadable for the host application.

Locale folder structure

The locale folder structure in HTML extensions is similar as Flash extensions. Each property file should be placed in its corresponding locale folder. For example, the en_US property file should be <YourExtension>/locale/en_US/messages.properties. Users can define a default property file (<YourExtension>/locale/message.properties), which will be used when the corresponding locale file is not defined.

YourExtension/
     |-csxs/
     |-locale/                      <-- Directory for localized resources
         |-- message.properties     <-- The one to fallback to if no localized resources is provided for a locale
         |-- en_US/
         |        |- messages.properties
         |-- zh_CN/
                  |- messages.properties

Locale file format is similar to Flash extension. It contains multiple lines of =.

key1=value1
key2=value2
key3.value=value3
key4.innerHTML=value4

CEP provides a JS interface named initResourceBundle to initialize the locale resources. This should be called during the loading of the extension. CEP initializes the resource bundle for the extension with property values for the current application and UI locale. Then users can access the resource bundle (object) to get the localized strings.

var csInterface = new CSInterface();
csInterface .initResourceBundle();

Localized menu

In manifest, it supports to use locale string as menu. For example, in the following manifest, it is using %UI_my_menu_name. UI_my_menu_name is defined as "UI_my_menu_name=xxx" in messages.properties.

<UI>
    <Type>ModalDialog</Type>
    <Menu>%UI_my_menu_name</Menu>
    ...
</UI>

Examples

Example 1

var cs = new CSInterface();
// Get properties according to current locale of host application.
var resourceBundle = cs.initResourceBundle();
// Use the localized strings.
<script type="text/javascript">document.write(resourceBundle.key1);</script>

Example 2

data-locale is the custom HTML element attribute and you can add to each HTML element that you want to localize.

In this example, there is "key3.value=value3" in the property file. In the HTML file, the input widget has attribute "data-locale" with "key3", then its value is set to "value3".

In this example, there is "key4.innerHTML=value4" in the property file. In the HTML file, the text area widget has attribute "data-locale" with "key4", then its innerHTML is set to "value4".

<script type="text/javascript">
  var cs = new CSInterface();
  // Get properties according to current locale of host application.
  var resourceBundle = cs.initResourceBundle();
  // Use the localized strings.
  document.write(resourceBundle.key1);
  document.write(resourceBundle.key2);
</script>

<input type="submit" value="" data-locale="key3"/>
<textarea rows="10" cols="80" data-locale="key4"></textarea>

Example 3

Use parameters ($1, $2, ...) in localized strings.

var localize = function(key)
{
  var cs = new CSInterface();
  var resourceBundle = cs.initResourceBundle();
  var localizedStr = resourceBundle[key];
  if (localizedStr)
  {
    var index = 1;
    while (localizedStr.indexOf("$" + index) !== -1)
    {
      localizedStr = localizedStr.replace("$" + index, arguments[index]);
      index++;
    }
    return localizedStr;
  }
  else
  {
    return '';
  }
};

Supporting MENA locales

MENA stands for "Middle East and North Africa". Support needs to be provided for Arabic, Hebrew, and NA French languages. Products supporting these languages are: ID, PS, AI, DW and Acrobat.

Language ISO Code
Arabic (Middle East Enabled English Arabic) en_AE
Hebrew (Middle East Enabled English Hebrew) en_IL
NA French fr_MA

If an extension needs to be loaded in host applications in MENA locales, MENA locales must be added to the supported locale list of the extension manifest file. For example:

<LocaleList>
    ...
    <Locale Code="en_AE"/>
    <Locale Code="en_IL"/>
    <Locale Code="fr_MA"/>
    ...
</LocaleList>

Extension localization for MENA locales

Suppose your extension has this directory layout

Extension/
         |-xxx.swf
         |-csxs/
         |-locale/                                <-- Directory for localized resources
                 |-- message.properties           <-- The one to fallback to if no localized resources is provided for a locale
                 |-- fr_FR/
                 |        |- messages.properties
                 |-- en_GB/
                          |- messages.properties

When CSInterface.initResourceBundle() is called, CEP uses the app UI locale (not app locale) reported by PP to load localized resources. If there is no localized resources for an app UI locale, for example fr_MA, then CEP will fallback to use message.properties located under the “locale” folder.

With MENA feature, PPs map en_AE/en_IL to en_US and fr_MA to fr_FR for app UI locale. In this case, for en_AE and en_IL build of PP, en_US resources will be used if provided and for fr_MA build of PP, fr_FR resources will be used if provided. What extension developers need to do in this case is to provide en_US version of resources for en_AE/en_IL and fr_FR version of resources for fr_MA.

Video/Audio Playback

CEP 5.0 supports playing video and audio encoded in below formats

Format MIME-Type Misc.
MP4 video/mp4 MPEG 4 files with H.264 video codec and AAC audio codec
Ogg video/ogG Ogg files with Theora video codec and Vorbis audio codec
mp3 audio/mpeg

Here is an example of playing video in your extension

<video poster="http://www.html5rocks.com/en/tutorials/video/basics/star.png" controls>
    <source src="http://www.html5rocks.com/en/tutorials/video/basics/Chrome_ImF.mp4" type='video/mp4; codecs="avc1.42E01E, mp4a.40.2"'/>
</video>

One thing to note is that because HTML extensions are hosted in integrating application's windows, video cannot be played in full-screen mode.

WebRTC

WebRTC is targeting to serve stream audio, video capture, like online video conference. In detail, refer to http://www.webrtc.org/. WebRTC is not enabled by default. To enable it, the schema below needS to be added in the manifest file. In detail, refer to Customize CEF command parameters.

<CEFCommandLine>
    <Parameter>--enable-media-stream</Parameter>
</CEFCommandLine>

For WebRTC related development, CEP runtime just keeps the same experiences as the usage in Chrome. Below is a sample script to demonstrate how to use it in Html pages of extension.

<video id="basic-stream" autoplay></video>

<script>
function errorCallback(e) {
    if (e.code == 1) {
        alert('User denied access to their camera');
    } else {
        alert('getUserMedia() not supported in your browser.');
    }
}
var video = document.querySelector('#basic-stream');
var localMediaStream = null;
if (navigator.getUserMedia) {
    navigator.getUserMedia('video', function(stream) {
    video.src = stream;
    video.controls = true;
    localMediaStream = stream;
    }, errorCallback);
} else if (navigator.webkitGetUserMedia) {
    navigator.webkitGetUserMedia({video: true}, function(stream) {
                        video.src = window.URL.createObjectURL(stream);
                        video.controls = true;
                        localMediaStream = stream;
    }, errorCallback);
}
</script>

For more samples, refer to http://www.html5rocks.com/en/tutorials/getusermedia/intro/.

In addition, there are some limitations of WebRTC support in CEP 5.0 runtime due to known issues in CEF3 as below.

Issue. No Description Link Comments
1065 Add support for webrtc based screen sharing/capturing https://code.google.com/p/chromiumembedded/issues/detail?id=1065, http://www.magpcss.org/ceforum/viewtopic.php?f=6&t=10982
1139 cefclient w/OSR hangs on exit with the WebRTC Reference App https://code.google.com/p/chromiumembedded/issues/detail?id=1139&q=WebRTC
1144 CEF3 does not support RTCPeerConnection https://code.google.com/p/chromiumembedded/issues/detail?id=1144 Created by CEP. This is a bug on 1453 branch, has been fixed on 1547 and later.
1151 CEF3: Mac: Process is blocked to quit when iframe is using WebRTC https://code.google.com/p/chromiumembedded/issues/detail?id=1151&start=100 Created by CEP.
1153 CEF3: Win: Can not show https://apprtc.appspot.com https://code.google.com/p/chromiumembedded/issues/detail?id=1153&start=100 Created by CEP.

Scroll bar tips

On Mac, scroll bars of panel are smartly hidden by OS (since Lion by design). It can be always shown by settings as below. 1. Click the Apple menu at the top-left of the screen, then select System Preferences. 2. Next, select the General preferences pane; it’s the very first one, up at the top. 3. Under the “Show scroll bars” heading, you’ll find three options: “Automatically based on input device,” “When scrolling,” and “Always.” Chose "Always."

Invisible HTML Extensions

An HTML extension can be invisible during its whole life cycle. This means

  • It always runs invisibly in the background
  • It is never visible

To make an HTML extension invisible

  1. Set extension manifest version to "5.0" or higher.
  2. Specify its window type as 'Custom' in the manifest file.
  3. Set <AutoVisible> to false in the manifest file.
  4. If you do not want the extension to appear in the Window->Extensions menu, do not add the <Menu> tag.
  5. If you want the extension to start on specific types of events, specify those events using <StartOn> tag.

Here is an example:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<ExtensionManifest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ExtensionBundleId="IamInvisible" ExtensionBundleVersion="1.0" Version="5.0">
    <ExtensionList>
        <Extension Id="IamInvisible" Version="1.0"/>
    </ExtensionList>
    <ExecutionEnvironment>
        <HostList>
            <Host Name="PHXS" Version="13.0"/>
        </HostList>
        <LocaleList>
            <Locale Code="All"/>
        </LocaleList>
        <RequiredRuntimeList>
            <RequiredRuntime Name="CSXS" Version="5.0"/>
        </RequiredRuntimeList>
    </ExecutionEnvironment>
    <DispatchInfoList>
        <Extension Id="IamInvisible">
            <DispatchInfo>
                <Resources>
                    <MainPath>./html/index.html</MainPath>
                </Resources>
                <Lifecycle>
                    <AutoVisible>false</AutoVisible>
                    <StartOn>
                        <!-- Photoshop dispatches this event on startup -->
                        <Event>applicationActivate</Event>
                        <!-- Premiere Pro dispatches this event on startup -->
                        <Event>com.adobe.csxs.events.ApplicationActivate</Event>
                        <!-- You can add more events -->
                        <Event>another_event</Event>
                    </StartOn>
                </Lifecycle>
                <UI>
                    <Type>Custom</Type>
                    <Geometry>
                        <Size>
                            <Height>1</Height>
                            <Width>1</Width>
                        </Size>
                    </Geometry>
                </UI>
            </DispatchInfo>
        </Extension>
    </DispatchInfoList>
</ExtensionManifest>

One important thing to note is that not all host applications support Invisible HTML Extension. See table below for more information:

PP Supports Invisible Extension Misc.
Photoshop :white_check_mark:
Premiere Pro :white_check_mark:
Prelude :white_check_mark:
Flash Pro :white_check_mark:
InDesign Doesn't work at all because InDesign doesn't support 'Custom' window type.
InCopy Doesn't work at all because InCopy doesn't support 'Custom' window type.
Illustrator The invisible extension is shown as a visible panel. Possibly that Illustrator treated the 'Custom' window type as 'Panel'. One possible workaround is to use the 'Modeless' window type instead of 'Custom'. However, under certain situations (someone calls PlugPlugLoadExtension for example), the extension will become visible.

Customize CEF Command Line Parameters

Chromium/CEF command line parameters can be passed to CEPHtmlEngine, like --enable-media-stream.

Available Chromium command line parameters can be found on http://peter.sh/experiments/chromium-command-line-switches/. Not all parameters are supported in CEPHtmlEngine due to limitation of its based library CEF3. But most should apply.

To use CEF command line parameters 1. Set manifest version to 5.0. 2. Add <CEFCommandLine><Parameter>--param1<Parameter/> ... </CEFCommandLine> in manifest. 3. For key=value parameter, add <CEFCommandLine><Parameter>--param1=value1<Parameter/> ... </CEFCommandLine> in manifest.

Here is an example.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<ExtensionManifest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ExtensionBundleId="xx.yy.zz" ExtensionBundleVersion="1.0" Version="5.0">
    <ExtensionList>
        <Extension Id="xx.yy.zz" Version="1.0"/>
    </ExtensionList>
    <ExecutionEnvironment>
        <HostList>
            <Host Name="PHXS" Version="13.0"/>
            <Host Name="PPRO" Version="6.0"/>
        </HostList>
        <LocaleList>
            <Locale Code="All"/>
        </LocaleList>
        <RequiredRuntimeList>
            <RequiredRuntime Name="CSXS" Version="5.0"/>
        </RequiredRuntimeList>
    </ExecutionEnvironment> 
    <DispatchInfoList>
        <Extension Id="xx.yy.zz">
            <DispatchInfo>
                <Resources>
                    <MainPath>./html/index.html</MainPath>
                    <CEFCommandLine>
                        <Parameter>--enable-media-stream</Parameter>
                    </CEFCommandLine>
                </Resources>
                ...
            </DispatchInfo>
        </Extension>
    </DispatchInfoList>
</ExtensionManifest>

Commonly used CEF command parameters:

Parameters Notes
--enable-media-stream Enable media (WebRTC audio/video) streaming.
--enable-speech-input Enable speech input (x-webkit-speech).
--ignore-certificate-errors Ignore SSL certificate errors
--persist-session-cookies Persist session cookies.
--disable-image-loading Disable loading of images from the network. A cached image will still be rendered if requested.
--disable-javascript-open-windows Disable opening of windows via JavaScript.
--disable-javascript-close-windows Disable closing of windows via JavaScript.
--disable-javascript-access-clipboard Disable clipboard access via JavaScript.
--enable-caret-browsing Enable caret browsing.
--proxy-auto-detect This tells Chrome to try and automatically detect your proxy configuration. See more info on http://www.chromium.org/developers/design-documents/network-settings. If you use this parameter in extension, you might not be able to use Charles Proxy (http://www.charlesproxy.com) to capture network traffic on Mac platform, or you might need to configure Charles Proxy properly. Windows platform is not affected.
--user-agent A string used to override the default user agent with a custom one.
--disable-application-cache Disable the ApplicationCache.
--nodejs-disabled Disable NodeJS

Html Extension Persistent

The purpose of persistent is to prevent reloading of the Html extension when it is closed or hidden. Photoshop has provided persistent since the version of 14.2.

To make a Html extension persistent in Photoshop 1. Upgrade Photoshop version to 14.2 or later 2. Dispatch the event com.adobe.PhotoshopPersistent from Html extension to Photoshop to request persistent

The sample code in extension is like below

function Persistent(inOn) {
    if (inOn) {
        var event = new CSEvent("com.adobe.PhotoshopPersistent", "APPLICATION");
    } else {
        var event = new CSEvent("com.adobe.PhotoshopUnPersistent", "APPLICATION");
    }
    event.extensionId = gExtensionId;
    csInterface.dispatchEvent(event);
 }

Persistent(true); //persistent to prevent extension from unloading
…
Persistent(false); //unpersistent

FullScreen API in HtmlExtension

CEP Html extension runtime has not supported fullscreen API yet. The reason is its based library CEF3 does not support fullscreen API, according to https://code.google.com/p/chromiumembedded/issues/detail?id=562

Open URL link in default browser

In Html extension, URL link could be opened in the default browser by calling window.cep.util.openURLInDefaultBrowser(‘http://example.com'), like

<li><button onclick="window.cep.util.openURLInDefaultBrowser('http://www.adobe.com')">Open browser</button></li>

Interaction between extension and PP during extension unload

When an extension is about to be unloaded, the communication channel between extension and PP has been teared down, so there's no easy way for PP to get the extension-related information such as the extension's status.

To fulfill this functionality, the cooperation between extension and PP is needed.

For extension's side, a JavaScript function registerExtensionUnloadCallback is provided to register its callback function. The definition can be found in CEPEngine_extensions.js. There're some limitations as below:

  • If registerExtensionUnloadCallback is called more than once, the last callback function that's successfully registered will be used.
  • The callback function must be context-independent and it is executed in the mainframe's context.
  • The callback function must not use APIs defined in the JS Libraries, whereas local fs APIs are allowed. Example
    window.cep.util.registerExtensionUnloadCallback(function(){
        window.cep.fs.writeFile("D:\\1.txt", "Hello");
    });

For PP's side, csxs::event::EVENT_TYPE_CSXS_EXTENSION_UNLOADED ( ("com.adobe.csxs.events.ExtensionUnloaded") is dispatched. When PP receives the event, it can read the file written by extension to get the extension-related information.

Use Node.js APIs

Node.js Support

One of the most prominent feature in CEP 5.0 is allowing Node.js APIs to be used in HTML extension. Most of the built-in APIs in Node.js version 0.8.22 are available to HTML extensions, with below exceptions:

  • Cluster APIs are not supported.
  • Console APIs are not supported on Windows.

CEP injects following symbols into the root HTML DOM:

  • global, GLOBAL, root - same with the window object
  • Buffer - node's Buffer class
  • process - node's process class
  • require - the magic function that bring you node API
  • module - in node the main script is a special module, this is for the compatibility

Conflicts with Web-Based Require Function

If your app uses libraries like RequireJS that inserts a require function into DOM, you should consider renaming CEP's require function to something else before migrating.

    <script type="text/javascript">window.nodeRequire=window.require && window.require=undefined</script>
    <script type="text/javascript" src="your/require/js/file.js"></script>

Conflicts with Web-Based module Function

If your app uses JQuery that is trying to register itself as nodejs plugin, then you will have to add the script below inside script tag to define window.module as undefined.

<script type="text/javascript">window.module = undefined</script> 

Disable Node.js APIs in iframe

Because of security considerations, CEP provides an option to disable Node.js APIs in iframe. To do so, add a nodejs-disabled="true" attribute to iframe tag. For example:

<iframe id="xxx" class="xxxxx" nodejs-disabled="true">

Forcing the environment implementation.

If you are using RequireJS, and the text plugin tries to detect what environment it is available for loading text resources, Node, XMLHttpRequest (XHR) or Rhino, but sometimes the Node or Rhino environment may have loaded a library that introduces an XHR implementation. You can force the environment implementation to use by passing an "env" module config to the plugin:

    requirejs.config({
        config: {
            text: {
                //Valid values are 'node', 'xhr', or 'rhino'
                env: 'rhino'
            }
        }
    });

Node.js Modules

JavaScript Modules

All third-party node JavaScript modules are supported. The root search path of third-party modules is the directory which contains your html file. For example, when you do require in file:///your_extension/index.html, CEP will lookup modules under file:///your_extension/node_modules, this rule is exactly the same with upstream node.

Native Modules

Node.js native modules are not directly support since CEP is using a different V8 version from the official node.

Samples

Use Environment Variables

process.env.ENV_VARIABLE // ENV_VARIABLE is the name of the variable you want to access.

Use Node.js to download files

http://www.hacksparrow.com/using-node-js-to-download-files.html

Limitation of cep.process.stdout/stderr

There is an known limitation of cep.process.stdout/stderr which is targeting to capture one time of stdout/stderr output. For applications that have not integrated CEP 5, there are two workarounds suggested as follows: 1. Embed cep.process.stdout/stderr, like below

function getSTDOutput()
    {
        console.log("getSTDOutput");
        window.cep.process.stdout(pid, function(output) {
                                    console.log(output);
    //your code is here
                                  });
        var result = window.cep.process.isRunning(pid);
        if (result.data == true)
        {
            setTimeout(getSTDOutput, 1000);
        }
    }
  1. Join all stdout output as one, like below
var str1 = 'abcdef';
var str2 = '12345';
var str3 = 'gghhtt';
console.log(str1 + str2 + str3);

An example on how to get curl downloading progress through stderr:

<script>
        var downloadPid = -1;
        function getStdErrOutput()
        {
            window.cep.process.stderr(downloadPid, function(progress) {
                                      var keys = progress.split(new RegExp('[# ]', 'g'));
                                      for(i=0; i<keys.length; i++){
                                        if (keys[i] != '') {
                                         console.log(keys[i]);
                                        }
                                      }
                                    });
            var result = window.cep.process.isRunning(downloadPid);
            if (result.data == true)
            {
                setTimeout(getStdErrOutput, 100);
            }
        }
        var doDownload = function() {
            var qURL = 'http://code.jquery.com/jquery-1.11.0.min.js';
            var dest = '/tmp/test.js';
            console.log("ext download (curl) " + qURL + " " + dest);
            var result = window.cep.process.createProcess('/usr/bin/curl', qURL, '-#', '-o', dest);
            downloadPid = result.data;
            console.log("download pid is " + downloadPid);
            getStdErrOutput();
        };

        doDownload();
</script>

Since CEP5, NodeJS is integrated into CEP runtime and users could invoke the standard APIs of NodeJS in extension directly. For applications that have integrated CEP 5, refer to http://nodejs.org/api/process.html for how to use the global process object in NodeJS.

Drag and Drop

Use Drag and Drop

CEP 5.2 support HTML 5 Drag and Drop. There are four types.

  • Drag and drop inside a html extension.
  • Drag and drop between two html extensions
  • Drag and drop between html extension and its host application.
  • Drag and drop between html extension and operating system (e.g. Desktop or Browser).

To learn about HTML 5 Drag and Drop and how to use it by JavaScript, please refer to http://www.w3.org/TR/html5/editing.html#dnd. Here are some demos:

Disable Drag and Drop

Extension developers can disable the default behavior of DnD by JavaScript.

Method 1

<body ondragover="return false" ondrop="return false">

Method 2 (using jQuery)

$(document.body).on('dragover drop', function(e) {
  e.preventDefault();
});

Please read HTML 5 standard for more details. http://www.w3.org/TR/html5/editing.html#event-dragenter

Host Application Support

As far as CEP is concerned, there are four types of Drag and Drop.

  • Drag and Drop inside HTML extension.
  • Drag and Drop between HTML extension.
  • Drag and Drop between HTML extension and operating system (e.g. Desktop or Browser).
  • Drag and Drop between HTML extension and its host application.

For the first three types of Drag and Drop, they do not need the involvement of the host application. This is the current support status:

Drag and Drop Result Comments
Inside one HTML extension :white_check_mark:
From HTML extension to operating system :white_check_mark:
Between two HTML extensions :white_check_mark:

Extending the D&D capabilities requires involvement of the host application. Below is the current support status for extending D&D features to support the following drag types in JavaScript:

Host Application text/plain text/uri-list text/html
After Effects :x: :x: :x:
Dreamweaver :white_check_mark: :x: :x:
Flash :white_check_mark: :x: :x:
Illustrator :white_check_mark: :x: :x:
InCopy :white_check_mark: :x: :x:
InDesign :white_check_mark: :x: :x:
Photoshop :x: :x: :x:
Prelude :x: :x: :x:
Premiere Pro :x: :x: :x:

External JavaScript Libraries

CEPHTMLEngine does not restrict using any extension JavaScript libraries. As long as a library can be used in CEF Client or Chrome browser, it should be usable in CEPHTMLEngine.

Here are some JavaScript which has been used successfully:

NPAPI plug-ins

The support for NPAPI plug-ins had been dropped since CEP 4.2. Don't embed Flash or Java Applet in your extension as they all depend on NPAPI plug-ins.

Increase/Decrease font size in Html Panel

There are couples of JavaScript ways to increase or decrease font size in Html panels either by plain JavaScript or JQuery. The following are the two pieces of a sample snippet to achieve this. One is in plain JavaScript and the other uses JQuery library.

Plain JavaScript

Use document.body.style.fontSize to change font size in page.

   <script type="text/javascript" language="javascript">
        window.onload = function() {
            var fontchange = document.createElement("div");
            var fontchangelink = function(fontsize, desc) {
                var a = document.createElement('a');
                a.href="#";
                a.style.margin = "5px";
                a.onclick = function() {
                    document.body.style.fontSize = fontsize + 'pt';
                };
                a.innerHTML = desc;
                return a;
            };

            fontchange.appendChild(document.createTextNode("Change font size:"));
            fontchange.appendChild(fontchangelink(9, "1"));
            fontchange.appendChild(fontchangelink(11, "2"));
            fontchange.appendChild(fontchangelink(13, "3"));

            document.body.insertBefore(fontchange, document.body.childNodes[0]);
        };
    </script>

For the full example, please refer to the html file - ResizeFont_plain_js.html

JQuery

Use $('html').css('font-size', size) to change font size in page.

    <script type="text/javascript" language="javascript">
            $(document).ready(function(){
                  // Reset Font Size
                  var originalFontSize = $('html').css('font-size');
                  $(".resetFont").click(function(){
                    $('html').css('font-size', originalFontSize);
                  });

                  // Increase Font Size
                  $(".increaseFont").click(function(){
                     var currentFontSize = $('html').css('font-size');
                     var currentFontSizeNum = parseFloat(currentFontSize, 10);
                     var newFontSize = currentFontSizeNum*1.2;
                     $('html').css('font-size', newFontSize);
                     return false;
                  });

                  // Decrease Font Size
                  $(".decreaseFont").click(function(){
                     var currentFontSize = $('html').css('font-size');
                     var currentFontSizeNum = parseFloat(currentFontSize, 10);
                     var newFontSize = currentFontSizeNum*0.8;
                     $('html').css('font-size', newFontSize);
                     return false;
                  });
             });
    </script>

For the full example, please refer to the html file - ResizeFont_JQuery.html

The ways above are the common used solution for JavaScript developers to increase or decrease fonts.

Obfuscate Html Extension

You could choose to obfuscate it in term of hiding internal Html extensions. But please keep in mind that there is no final/reliable way to obfuscate HTML/JavaScript staff, because it is not so hard to revert it back to plain text. Even if the extension is signed, users still could add entry "PlayerDebugMode=1" in registry/plist to load the modified extension. Even in flash world, there still might be ways to decompile swf to get your IMS client-secret.

So there is no reliable way to prevent user finding your client-secret if IMS APIs are invoked in HTML extension. Alternatively, you could choose to call IMS API in native side, and communicate HTML extensions by CSXS event/Extend Script.

Check Internet Connection

if (navigator.onLine === true)
{
  //system is online
}
else
{
  //system is offline
}

Set Mouse Cursor

Please refer to http://jsfiddle.net/BfLAh/1390/

$(document).mousemove(function(e){
    $("#image").css({left:e.pageX, top:e.pageY});
});

De-obfuscate JavaScript

Please refer to http://jsbeautifier.org/

iframe

Due to the X-Frame-Options header a number of HTTPS websites are unavailable to host in an iframe. An alternative to displaying HTTPS content is to use the window.location.href e.g. iFrame alternative for HTTPS content

// html
<body onLoad="onLoaded()">
<!--iframe src="https://www.trello.com"></iframe--> <!-- this line can be deleted as HTTPS blocks content being displayed in an iframe -->
</body>

// javascript
function onLoaded() {
  window.location.href = "https://www.trello.com";
}

Tooltip

CEP 5.2 supports HTML title attribute to show the tooltip on Windows. However, it's not supported on Mac due to off-screen rendering. The alternative is use JavaScript instead, please refer to http://www.a2zwebhelp.com/bootstrap-tooltips for good examples.

"onchange" event is not triggered when inputting non-English language on Mac.

If user inputs non-English characters on Mac, the "onchange" event of the html element is not triggered, due to a design limitation.