org.mdi.plugins

Class AbstractMDIPlugin<C>

java.lang.Object

org.mdi.plugins.AbstractPlugin

org.mdi.plugins.AbstractMDIPlugin<C>

Type Parameters:

C - the framework component class

All Implemented Interfaces:

CommandLineListener, MDIPlugin<C>, Plugin

Direct Known Subclasses:

AbstractJFXMDIPlugin, AbstractSwingMDIPlugin

public abstract class AbstractMDIPlugin<C>
extends AbstractPlugin
implements MDIPlugin<C>

This class provides a default implementation of the MDIPlugin interface, which does nothing, to minimize the effort required to implement this interface.

Field Summary

Fields inherited from class org.mdi.plugins.AbstractPlugin

appli, commandLineHandler

Constructor Summary

Constructors

Constructor and Description
AbstractMDIPlugin()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getDynamicMenuElements(java.lang.String key, FileProperties<C> prop) Return null by default
java.lang.Object	getStaticMenuElements(java.lang.String key) Return null by default
protected void	initializeUIImpl() Initialize the UI content of the Plugin.
boolean	isCompatibleWith(java.lang.String key, MetaData properties) Return false by default.

Methods inherited from class org.mdi.plugins.AbstractPlugin

getCommandLineHandler, getContextClassLoader, getPluginDesc, init, register, setCommandLineHandler, setupPluginDesc

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.mdi.plugins.MDIPlugin

initAfterGUI, initializeUI, updateMenus

Methods inherited from interface org.mdi.plugins.Plugin

dispose, executeCustomAction, getDefaultPluginProperty, getPluginBuildDate, getPluginConfiguration, getPluginDesc, getPluginDescription, getPluginName, getPluginProperty, getPluginVersion, getProperty, getPropertyType, hasProperty, init, loadResources, modifySettings, register, resetSettings, setProperty, supportCustomAction

Methods inherited from interface org.mdi.bootstrap.launcher.CommandLineListener

getCommandLineConfiguration, getCommandLineHandler, handleCommandLineArguments, handleCommandLineArguments, handleCommandLineException, setCommandLineHandler

Constructor Detail

AbstractMDIPlugin

public AbstractMDIPlugin()

Method Detail

getStaticMenuElements

public java.lang.Object getStaticMenuElements(java.lang.String key)

Return null by default

Specified by:

getStaticMenuElements in interface MDIPlugin<C>

Parameters:

key - the menu key

Returns:

null

getDynamicMenuElements

public java.lang.Object getDynamicMenuElements(java.lang.String key,
                                               FileProperties<C> prop)

Return null by default

Specified by:

getDynamicMenuElements in interface MDIPlugin<C>

Parameters:

key - the menu key

prop - the properties of the panel

Returns:

null

isCompatibleWith

public boolean isCompatibleWith(java.lang.String key,
                                MetaData properties)

Return false by default.

Specified by:

isCompatibleWith in interface MDIPlugin<C>

Parameters:

key - the key

properties - the properties

Returns:

true if the Plugin is compatible with the defined properties for a specified Key

initializeUIImpl

protected void initializeUIImpl()
                         throws java.lang.Exception

Initialize the UI content of the Plugin. Do nothing by default.

Throws:

java.lang.Exception - if an Exception is encountered during the initialization