Module omix.api

Package omix.plugin

Interface ApplicationAccessManager

All Superinterfaces:

AbstractAccessManager

public interface ApplicationAccessManager
extends AbstractAccessManager

This interface allows to access features of the Omix Plugin Interface. An instance of ApplicationAccessManager is submitted to ApplicationExtensionInterface.

Since:

Omix 1.3.11

Author:

Dr. Peter Droste, Omix Visualization

Method Summary

Modifier and Type	Method	Description
Document	currentDocument()	Returns the current document.
boolean	hasInvalidLicense()	Returns true when the plugin requires a license key which is not available at the moment.
boolean	hasMalfunctions()	Determines whether the plugin was successfully loaded or loaded with malfunctions.
boolean	hasUnresolvedDependencies()	Returns true if plugin depends on other plugins that are not installed yet.
boolean	isEnabled()	Returns the enabled state of the plugin.
void	openDocumentFromData(byte[] data, String format)	Opening a network as new document.
void	requestOpenDocumentProcedure(ModelReader modelReader)	Opening a network as new document.

Methods inherited from interface omix.plugin.AbstractAccessManager

addDockWidget, addDockWidget, addMenu, addMenuItem, addMenuItem, addToolBar, addToolBar, addToolBarAction, addToolBarAction, authenticator, editValue, getPluginLicense, getPublicIdentifierManager, httpProxy, message, newOVLCompiler, parentWidget, removeDockWidget, removeMenu, removeMenuItem, removeToolBar, removeToolBarAction, requestExportImageProcedure, settings, vodObjectFactory

Method Details

isEnabled

boolean isEnabled()

Returns the enabled state of the plugin.

Returns:

enabled?

hasMalfunctions

boolean hasMalfunctions()

Determines whether the plugin was successfully loaded or loaded with malfunctions.

Returns:

true if has malfunctions

hasInvalidLicense

boolean hasInvalidLicense()

Returns true when the plugin requires a license key which is not available at the moment.

Returns:

true if plugin is not licensed

hasUnresolvedDependencies

boolean hasUnresolvedDependencies()

Returns true if plugin depends on other plugins that are not installed yet.

Returns:

unresolved dependencies

currentDocument

Document currentDocument()

Returns the current document.

Returns:

current document

requestOpenDocumentProcedure

void requestOpenDocumentProcedure(ModelReader modelReader)

Opening a network as new document. After calling this method, the access manager calls ModelReader.readModel(omix.plugin.model.writable.Model, omix.plugin.io.util.InputUtilities). The plugin can implement this interface to perform a certain model read and composition procedure. Finally, the new model is loaded as new network model document.

Parameters:

modelReader - the model reader.

Since:

Omix 1.4.20

openDocumentFromData

void openDocumentFromData(byte[] data, String format)

Opening a network as new document. The plug-in can use all installed model export filters even of other plug-ins. Finally, the new model is loaded as new network model document.

Parameters:

data - the model data.

format - the file format of the data.

Since:

Omix 1.5.11