Module omix.api

Package omix.plugin

Interface DocumentExtensionFactory

public interface DocumentExtensionFactory

This interface has to be derived by a custom plugin class in order to implement a document extension.
A custom class implementing DocumentExtensionFactory can be registered at the Omix Plugin Manager:

<DocumentExtensionFactory>mypackage.MyDocumentExtensionFactory</DocumentExtensionFactory>

Since:

Omix 1.3.11

Author:

Dr. Peter Droste, Omix Visualization

Method Summary

Modifier and Type	Method	Description
DocumentExtensionInterface	newDocumentExtension(DocumentAccessManager documentAccessManager)	This method is called by the Plugin Manager when the plugin is activated on the document.

Method Details

newDocumentExtension

DocumentExtensionInterface newDocumentExtension(DocumentAccessManager documentAccessManager)

This method is called by the Plugin Manager when the plugin is activated on the document. The role of the method is to create the DocumentExtension.
The custom implementation of this method must instantiate an arbitrary subclass of DocumentExtensionInterface.

Parameters:

documentAccessManager - access to various features of the Omix Plugin Interface

Returns:

an instance of DocumentExtensionInterface