Module omix.api
Package omix.plugin

Interface DocumentExtensionInterface

All Known Implementing Classes:
AbstractDocumentExtension
public interface DocumentExtensionInterface

This interface can be implemented in order to realize a document dependend extension for Omix. This extension object is created and initialized (#initialize()) when the user activated a plugin. At deactivating the plugin #clear() is invoked.

The DocumentExtensionFactory class must be derived and registered at the plugin manager. The method DocumentExtensionFactory.newDocumentExtension(DocumentAccessManager) must initialize the derived document extension class.

The document extension has access to features of the Omix Plugin Interface by an instance of DocumentAccessManager submitted in DocumentExtensionFactory.newDocumentExtension(DocumentAccessManager).

Since:
Omix 1.4.1
Author:
Dr. Peter Droste, Omix Visualization

  • Method Summary

    Modifier and Type Method Description
    default void activate()
    This method is invoked when the document is activated in the multi document area.
    default void clear​(boolean interactive)
    This method is invoked when the plugin is deactivated.
    This additionally applies when the deactivation process is undone and redone again.
    default void deactivate()
    This method is invoked when the document is deactivated in the multi document area.
    default void initialize​(boolean interactive)
    This method is invoked when the plugin is first activated on the document and when the activation process is undone and redone again.

  • Method Details

    • initialize

      default void initialize​(boolean interactive)
      This method is invoked when the plugin is first activated on the document and when the activation process is undone and redone again.
      Parameters:
      interactive - true if plug-in was activated interactively

    • clear

      default void clear​(boolean interactive)
      This method is invoked when the plugin is deactivated.
      This additionally applies when the deactivation process is undone and redone again.
      Parameters:
      interactive - true if plug-in was deactivated interactively

    • activate

      default void activate()
      This method is invoked when the document is activated in the multi document area.

    • deactivate

      default void deactivate()
      This method is invoked when the document is deactivated in the multi document area.