org.mdi.plugins

Interface MDIPlugin<C>

Type Parameters:

C - the framework component class

All Superinterfaces:

CommandLineListener, Plugin

All Known Subinterfaces:

SwingMDIPlugin

All Known Implementing Classes:

AbstractJFXMDIPlugin, AbstractMDIPlugin, AbstractSwingMDIPlugin

public interface MDIPlugin<C>
extends Plugin

A Plugin which can manage a GUI. MDIPlugins can have static menu items, that are available regardless of the type of the selected tab, and dynamic menu items, that depends on the type (ie MetaData) of the selected tab.

• Static menus: These menus are always presented, regardless of the properties of the selected tab
• Dynamic menus: These menus are presented depending on the properties of the selected tab

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getDynamicMenuElements(java.lang.String menuKey, FileProperties<C> prop) This method is responsible for retrieving all the dynamic GUI interfaces of the plugin that must be integrated in the general application interface.
default java.lang.Object	getSettingsMenuElements(java.lang.String configName) This method is responsible for retrieving all the static GUI interfaces of the plugin that must be integrated in the general application interface.
java.lang.Object	getStaticMenuElements(java.lang.String key) This method is responsible for retrieving all the static GUI interfaces of the plugin that must be integrated in the general application interface.
default java.lang.Object	getStaticMenuElements(java.lang.String key, java.lang.String param) This method is responsible for retrieving all the static GUI interfaces of the plugin that must be integrated in the general application interface, with an associated parameter.
default void	initAfterGUI(MDIApplication app) Called after the application GUI has been initialized.
default void	initializeUI(boolean wait) Initialize the UI of the Plugin, taking care of doing the initialization in the EDT or the Platform Thread.
boolean	isCompatibleWith(java.lang.String key, MetaData properties) Return true if the Plugin is compatible with the defined properties for a specified Key.
default void	updateMenus() This method is used to tell to the Plugin that its menus may been modified.

Methods inherited from interface org.mdi.plugins.Plugin

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

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

getCommandLineConfiguration, getCommandLineHandler, handleCommandLineArguments, handleCommandLineArguments, handleCommandLineException, preventOpeningApplication, setCommandLineHandler

Method Detail

getStaticMenuElements

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

This method is responsible for retrieving all the static GUI interfaces of the plugin that must be integrated in the general application interface. Return null by default.

Parameters:

key - the PluginElementTypes type to retrieve

Returns:

the GUI interface

getSettingsMenuElements

default java.lang.Object getSettingsMenuElements(java.lang.String configName)

This method is responsible for retrieving all the static GUI interfaces of the plugin that must be integrated in the general application interface. Defer to getStaticMenuElements(java.lang.String) for PluginElementTypes.SETTINGS by default.

Parameters:

configName - the configuration name

Returns:

the GUI interfaces

getStaticMenuElements

default java.lang.Object getStaticMenuElements(java.lang.String key,
                                               java.lang.String param)

This method is responsible for retrieving all the static GUI interfaces of the plugin that must be integrated in the general application interface, with an associated parameter. Return null by default.

Parameters:

key - the PluginElementTypes type to retrieve

param - the associated parameter

Returns:

the GUI interfaces

getDynamicMenuElements

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

This method is responsible for retrieving all the dynamic GUI interfaces of the plugin that must be integrated in the general application interface.

Parameters:

menuKey - the menu key

prop - the properties of the panel

Returns:

the dynamic menus elements (can be a List of a Vector

isCompatibleWith

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

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

Parameters:

key - the key

properties - the properties

Returns:

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

initAfterGUI

default void initAfterGUI(MDIApplication app)

Called after the application GUI has been initialized. Call by default initializeUI(boolean) without waiting.

Parameters:

app - the application

initializeUI

default void initializeUI(boolean wait)

Initialize the UI of the Plugin, taking care of doing the initialization in the EDT or the Platform Thread. Do nothing by default.

Parameters:

wait - true if the initialisation must be blocking

updateMenus

default void updateMenus()

This method is used to tell to the Plugin that its menus may been modified. Do nothing by default.