oXygen XML Web Author Component API Documentation

The main access point to the API is the workspace variable available in global scope whose type is sync.api.Workspace.

In order to customize the XML Editor, one must listen for the events that are triggered when the editor is about to be opened sync.api.Workspace.EventType.BEFORE_EDITOR_LOADED and the editor is opened sync.api.Workspace.EventType.EDITOR_LOADED.

The events triggered by the Web Author are Google Closure style events.

This API is available to both oXygen Framewoks and oXygen Plugins. In order to use it from a framework, your JS code must be placed in the web/framework.js file inside the framework's folder. In order to use it from a plugin, the code must be placed inside the app/plugin.js file.