Module omix.api
Package omix.plugin

Interface ApplicationExtensionInterface

All Known Implementing Classes:
AbstractApplicationExtension
public interface ApplicationExtensionInterface

This interface can be implemented in order to realize a global extension for Omix. This extension is loaded at Omix startup and during the plugin installation procedure, respectively.

The ApplicationExtensionFactory class must be derived and registered at the plugin manager. The method ApplicationExtensionFactory.newApplicationExtension(ApplicationAccessManager) must initialize the derived application extension class.

The application extension has access to features of the Omix Plugin Interface by an instance of ApplicationAccessManager.

Additionally, a subclass of ApplicationExtensionInterface can implement other factory interfaces which is noticed by the plugin manager:

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

  • Method Summary

    Modifier and Type Method Description
    default void clear()
    This method is called when the plugin is deinstalled or Omix terminates.
    default void currentDocumentChanged​(Document activeDocumentInfo)
    Is called when a document is activated.
    default void enabledStateChanged​(boolean enabled)
    Plugins can be disabled by the software user.

  • Method Details

    • clear

      default void clear()
      This method is called when the plugin is deinstalled or Omix terminates.

    • enabledStateChanged

      default void enabledStateChanged​(boolean enabled)
      Plugins can be disabled by the software user. When the enabled state changes, this method is called by the plugin manager.
      Parameters:
      enabled -

    • currentDocumentChanged

      default void currentDocumentChanged​(Document activeDocumentInfo)
      Is called when a document is activated. This happend when a new document is begone, a document is loaded or the user switches between several open document.
      Parameters:
      activeDocumentInfo - information about the active document
      null -- if no document is active ModelDocument -- if document is network model diagram (include diagram nested OVL code) OVLDocument -- if document is OVL code
      See Also:
      ApplicationAccessManager.currentDocument()