org.mdi.plugins.swing

Class AbstractSwingMDIPlugin

java.lang.Object

org.mdi.plugins.AbstractPlugin

org.mdi.plugins.AbstractMDIPlugin<javax.swing.JComponent>

org.mdi.plugins.swing.AbstractSwingMDIPlugin

All Implemented Interfaces:

CommandLineListener, MDIPlugin<javax.swing.JComponent>, Plugin, SwingMDIPlugin

public abstract class AbstractSwingMDIPlugin
extends AbstractMDIPlugin<javax.swing.JComponent>
implements SwingMDIPlugin

An AbstractSwingMDIPlugin which has some additional methods for easing their implementation on Swing.

Field Summary

Fields inherited from class org.mdi.plugins.AbstractPlugin

appli, commandLineHandler

Constructor Summary

Constructors

Constructor and Description
AbstractSwingMDIPlugin()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getDynamicMenuElements(java.lang.String menuKey, FileProperties<javax.swing.JComponent> prop) This method is responsible for retrieving all the dynamic GUI interfaces of the plugin that must be integrated in the general application interface.
java.lang.Object	getDynamicMenuElements(java.lang.String menuKey, SwingFileProperties prop) This method is responsible for retrieving all the dynamic GUI interfaces of the plugin that must be integrated in the general application interface.
void	initializeUI(boolean wait) Initialize the Swing UI of the Plugin, taking care of doing the initialization in the EDT.
protected void	initializeUIImpl() Initialize the UI content of the Swing Plugin.

Methods inherited from class org.mdi.plugins.AbstractMDIPlugin

getStaticMenuElements, isCompatibleWith

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.swing.SwingMDIPlugin

updateUI

Methods inherited from interface org.mdi.plugins.MDIPlugin

getStaticMenuElements, initAfterGUI, isCompatibleWith, 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, preventOpeningApplication, setCommandLineHandler

Constructor Detail

AbstractSwingMDIPlugin

public AbstractSwingMDIPlugin()

Method Detail

initializeUI

public final void initializeUI(boolean wait)

Initialize the Swing UI of the Plugin, taking care of doing the initialization in the EDT.

Specified by:

initializeUI in interface MDIPlugin<javax.swing.JComponent>

Parameters:

wait - true if the initialisation must be blocking

getDynamicMenuElements

public java.lang.Object getDynamicMenuElements(java.lang.String menuKey,
                                               FileProperties<javax.swing.JComponent> prop)

This method is responsible for retrieving all the dynamic GUI interfaces of the plugin that must be integrated in the general application interface. Defer to getDynamicMenuElements(java.lang.String, org.mdi.bootstrap.swing.SwingFileProperties) by default.

Specified by:

getDynamicMenuElements in interface MDIPlugin<javax.swing.JComponent>

Overrides:

getDynamicMenuElements in class AbstractMDIPlugin<javax.swing.JComponent>

Parameters:

menuKey - the menu key

prop - the properties of the panel

Returns:

the dynamic menus elements

getDynamicMenuElements

public java.lang.Object getDynamicMenuElements(java.lang.String menuKey,
                                               SwingFileProperties prop)

This method is responsible for retrieving all the dynamic GUI interfaces of the plugin that must be integrated in the general application interface. Return null by default. Plugins are allowed to return:

• a JMenuItem
• a JMenu
• a JButton
• an AbstractAction
• a List containing any number of the above elements

Parameters:

menuKey - the menu key

prop - the properties of the panel

Returns:

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

initializeUIImpl

protected void initializeUIImpl()
                         throws java.lang.Exception

Initialize the UI content of the Swing Plugin. Note that this method will be called by initializeUI(boolean) and as such does not need to be protected to be executed in the EDT. Do nothing by default.

Overrides:

initializeUIImpl in class AbstractMDIPlugin<javax.swing.JComponent>

Throws:

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