Document Plugin Extension

This type of plugin allows you to manage the current document.

The document plugin type can only be applied to an XML document. It can modify the current document that is received as a callback parameter.

The plugin is started by selecting the corresponding menu item from the Plugins submenu in the contextual menu of Text mode. It provides the following API:

  • DocumentPluginExtension interface - Receives the context object containing the current document. The process(GeneralPluginContext) method can return a DocumentPluginResult object containing a new document.
  • DocumentPluginContext object - Represents the context and provides three methods:
    • getDocument() - Returns a javax.swing.text.Document object that represents the current document.
    • getFrame() - Returns a java.awt.Frame object that represents the editing frame.
    • getPluginWorkspace() - Returns access to the workspace of Oxygen XML Developer.