Registering a window

Plugins may also register new windows so they may be opened. To do so, use the register() method of Plugin.window as outlined in the examples below.

Method 1 - Provide a relative path to a window manifest file

Assume there is a sub-folder in the plugin's folder named windows, and there is a window manifest there.

Plugin.window.register('windows/myPluginWindow.json');

Method 2 - Pass a window manifest directly

It is also possible to pass a window manifest in JSON format directly to the method.

Plugin.window.register({
    "name": "myPluginWindow",
    "path": "./views/some-new-window.html",
    "description": "",

    "width": 480,
    "height": 330,

    "modal": true,
    "frame": false,
    "resizable": false,
    "allowMultiple": false,
    "requiresTemplate": false
});

Now our plugin may open this window by sending a request-open-window event to the application:

Plugin.event.send('request-open-window', {windowName: 'myPluginWindow'});

Considerations

• This method may only register new windows. It will not override windows that are already registered with the app, so you cannot override app-windows like the Object Editor or Import Manager, nor can you override windows registered by other plugins.