MDIApplication (MDIFramework API)

All Known Subinterfaces:

GUIApplication, TabbedApplication

All Known Implementing Classes:

AbstractApplication, AbstractJFXApplication, AbstractMDIApplication
```
public interface MDIApplication
```
Interface for the MDIApplication.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`disposeApplication()` Dispose of the Application, calling all necessary code before effectively calling `System.exit(0)`.
`void`	`endAction(MDIAction action)` Ends a generic action.
`default void`	`executeAction(MDIAction action)` Execute a generic Action.
`default void`	`executeAction(MDIAction action, java.lang.ClassLoader loader)` Execute a generic Action, using a specific Classloader.
`void`	`executeAction(MDIAction action, short blockingType)` Execute a generic Action.
`void`	`executeAction(MDIAction action, short blockingType, java.lang.ClassLoader loader)` Execute a generic Action, using a specific Classloader.
`java.util.Map<java.lang.String,AppliManifestType>`	`getAdditionalPluginTypes()` Return the optional additional Plugin Types.
`java.util.Map<java.lang.String,java.lang.Boolean>`	`getAllowedPluginTypes()` Return the allowed Plugin Types.
`default ApplicationDesc`	`getApplicationDesc()` Return the Application description.
`default java.lang.String`	`getApplicationID()` Return the ApplicationID.
`default java.util.Map<java.lang.String,java.lang.String>`	`getCommandLineArguments()` Return the launch arguments of the application.
`ConfigurationManager`	`getConfigurationManager()` Return the Configuration Manager.
`ErrorLogger`	`getErrorLogger()` Return the error logger.
`default Plugin`	`getPlugin(java.lang.String clazz)` Return the Plugin, given its associated class path.
`Plugin`	`getPlugin(java.lang.String clazz, boolean acceptAll)` Return the Plugin, given its associated class path.If `acceptAll` is `false` and the plugin is not enabled, it will return `null`.
`default Plugin`	`getPluginForName(java.lang.String name)` Return a Plugin, given its associated name.
`Plugin`	`getPluginForName(java.lang.String name, boolean acceptAll)` Return a Plugin, given its associated name.
`java.util.List<Plugin>`	`getPlugins()` Return the Plugins List.
`default short`	`getPluginsDeactivationPolicy()` Return the plugins deactivation policy.
`default PluginsEDTSupport`	`getPluginsEDTSupport(PluginsManager manager)` Return the support class for the GUI initialization of Plugins.
`PluginsManager`	`getPluginsManager()` Return the PluginsManager.
`java.util.Map<java.lang.String,Plugin>`	`getPluginsMap()` Return Plugins Map.
`default java.io.File`	`getStartDirectory()` Return the starting directory of the application.
`long`	`getTime()` Return the time after the last operation.
`default boolean`	`hasEnabledPlugin(java.lang.String name)` Return true if the application has an enabled Plugin of a specified name.
`boolean`	`hasPlugin(java.lang.String name)` Return true if the application has a Plugin of a specified name.
`default void`	`initConfiguration(java.util.prefs.Preferences prefRoot)` Creates the Configuration, and initialize it with a root Preference.
`default void`	`initConfiguration(java.util.prefs.Preferences prefRoot, short mdiPluginsInitMode)` Creates the Configuration, and initialize it with a root Preference.
`default boolean`	`isDefaultBlockingActions()` Return true if actions are blocking by default.
`boolean`	`isEnabled(Plugin plugin)` Return true if a plugin is enabled.
`boolean`	`isEnabled(java.lang.String pluginName)` Return true if a plugin is enabled.
`void`	`noTimeMessages()` Avoid to write time in messages for the current MDIAction.
`void`	`noWriteMessages()` Avoid to write messages for the current MDIAction.
`default void`	`serializeConfiguration()` Serialize the configuration.
`default void`	`setDefaultBlockingActions(boolean isBlocking)` Set if actions are blocking by default.
`default boolean`	`setPluginsDeactivationPolicy(short policy)` Set the plugins deactivation policy.Defer to `PluginsManager.setPluginsDeactivationPolicy(short)` by default.
`void`	`showActionException(java.lang.String message, java.lang.Exception e)` Show the last Exception associated with an Action.
`void`	`startTime(MDIAction action)` Start to count the time for the last operation, and show the statusBar progress.
`long`	`stopTime(MDIAction action)` Stop the time counting.

- Method Detail
  - getAllowedPluginTypes
```
java.util.Map<java.lang.String,java.lang.Boolean> getAllowedPluginTypes()
```
    Return the allowed Plugin Types. Plugins which have the PluginsManager.KEY_PLUGIN_TYPE attribute in their manifest will have to match one of the Application allowed plugin type names.
    
    Returns:
    
    the allowed Plugin Types
  - getAdditionalPluginTypes
```
java.util.Map<java.lang.String,AppliManifestType> getAdditionalPluginTypes()
```
    Return the optional additional Plugin Types. Contrary to the allowed Plugin Types the manifest key for these types is up to the application. It allows to define additional constraints which will define if Plugins will be loaded.
    
    Returns:
    
    the optional additional Plugin Types
    
    See Also:
    
    PluginsManager.setAdditionalPluginTypes(java.util.Map)
  - getConfigurationManager
```
ConfigurationManager getConfigurationManager()
```
    Return the Configuration Manager.
    
    Returns:
    
    the Configuration Manager
  - getErrorLogger
```
ErrorLogger getErrorLogger()
```
    Return the error logger.
    
    Returns:
    
    the error logger
  - getPluginsManager
```
PluginsManager getPluginsManager()
```
    Return the PluginsManager.
    
    Returns:
    
    the PluginsManager
  - isEnabled
```
boolean isEnabled(java.lang.String pluginName)
```
    Return true if a plugin is enabled.
    
    Parameters:
    
    pluginName - the plugin name
    
    Returns:
    
    true if the plugin is enabled
  - isEnabled
```
boolean isEnabled(Plugin plugin)
```
    Return true if a plugin is enabled.
    
    Parameters:
    
    plugin - the plugin
    
    Returns:
    
    true if the plugin is enabled
  - getStartDirectory
```
default java.io.File getStartDirectory()
```
    Return the starting directory of the application. Return the user.dir directory by default.
    
    Returns:
    
    the starting directory
  - executeAction
```
default void executeAction(MDIAction action)
```
    Execute a generic Action. It will use the default blocking behavior of the application.
    
    Parameters:
    
    action - the Action
  - setDefaultBlockingActions
```
default void setDefaultBlockingActions(boolean isBlocking)
```
    Set if actions are blocking by default.
    
    Parameters:
    
    isBlocking - true if actions are blocking by default
  - isDefaultBlockingActions
```
default boolean isDefaultBlockingActions()
```
    Return true if actions are blocking by default. Return false by default.
    
    Returns:
    
    true if actions are blocking by default
  - getPluginsEDTSupport
```
default PluginsEDTSupport getPluginsEDTSupport(PluginsManager manager)
```
    Return the support class for the GUI initialization of Plugins. Returns a DefaultPluginsEDTSupport by default.
    
    Parameters:
    
    manager - the PluginsManager
    
    Returns:
    
    the support class
  - executeAction
```
void executeAction(MDIAction action,
                   short blockingType)
```
    Execute a generic Action.
    Blocking types
    The blocking type can be:
    - BlockingType.DEFAULT: use the default blocking type of the application
    - BlockingType.BLOCKING: if the action should be blocking
    - BlockingType.NOT_BLOCKING: if the action should not be blocking
    Parameters:
    
    action - the Action
    
    blockingType - the enumeration specifying if the action should be blocking
  - executeAction
```
default void executeAction(MDIAction action,
                           java.lang.ClassLoader loader)
```
    Execute a generic Action, using a specific Classloader. It will use the default blocking behavior of the application.
    
    Parameters:
    
    action - the Action
    
    loader - the ClassLoader
  - executeAction
```
void executeAction(MDIAction action,
                   short blockingType,
                   java.lang.ClassLoader loader)
```
    Execute a generic Action, using a specific Classloader.
    Blocking types
    The blocking type can be:
    - BlockingType.DEFAULT: use the default blocking type of the application
    - BlockingType.BLOCKING: if the action should be blocking
    - BlockingType.NOT_BLOCKING: if the action should not be blocking
    Parameters:
    
    action - the Action
    
    blockingType - the enumeration specifying if the action should be blocking
    
    loader - the ClassLoader
  - showActionException
```
void showActionException(java.lang.String message,
                         java.lang.Exception e)
```
    Show the last Exception associated with an Action.
    
    Parameters:
    
    message - the message
    
    e - the Exception
  - getPlugins
```
java.util.List<Plugin> getPlugins()
```
    Return the Plugins List.
    
    Returns:
    
    the Plugins List
  - getPluginsMap
```
java.util.Map<java.lang.String,Plugin> getPluginsMap()
```
    Return Plugins Map.
    
    Returns:
    
    the Plugins Map
  - getPluginForName
```
default Plugin getPluginForName(java.lang.String name)
```
    Return a Plugin, given its associated name. If the plugin id not enabled, it will return null.
    
    Parameters:
    
    name - the Plugin name
    
    Returns:
    
    the Plugin
  - getPluginForName
```
Plugin getPluginForName(java.lang.String name,
                        boolean acceptAll)
```
    Return a Plugin, given its associated name. If acceptAll is false and the plugin is not enabled, it will return null.
    
    Parameters:
    
    name - the Plugin name
    
    acceptAll - true if disabled plugins are accepted
    
    Returns:
    
    the Plugin
  - hasPlugin
```
boolean hasPlugin(java.lang.String name)
```
    Return true if the application has a Plugin of a specified name.
    
    Parameters:
    
    name - the Plugin name
    
    Returns:
    
    true if the application has a Plugin of the specified name
  - hasEnabledPlugin
```
default boolean hasEnabledPlugin(java.lang.String name)
```
    Return true if the application has an enabled Plugin of a specified name.
    
    Parameters:
    
    name - the Plugin name
    
    Returns:
    
    true if the application has an enabled Plugin of the specified name
  - getPlugin
```
default Plugin getPlugin(java.lang.String clazz)
```
    Return the Plugin, given its associated class path. If the plugin id not enabled, it will return null.
    
    Parameters:
    
    clazz - the plugin class path
    
    Returns:
    
    the Plugin
  - getPlugin
```
Plugin getPlugin(java.lang.String clazz,
                 boolean acceptAll)
```
    Return the Plugin, given its associated class path.If acceptAll is false and the plugin is not enabled, it will return null.
    
    Parameters:
    
    clazz - the plugin class path
    
    acceptAll - true if disabled plugins are accepted
    
    Returns:
    
    the Plugin
  - setPluginsDeactivationPolicy
```
default boolean setPluginsDeactivationPolicy(short policy)
```
    Set the plugins deactivation policy.Defer to PluginsManager.setPluginsDeactivationPolicy(short) by default.
    
    Parameters:
    
    policy - the policy
    
    Returns:
    
    true if the PluginsManager exists
  - getPluginsDeactivationPolicy
```
default short getPluginsDeactivationPolicy()
```
    Return the plugins deactivation policy. Defer to PluginsManager.getPluginsDeactivationPolicy() by default.
    
    Returns:
    
    the policy
  - initConfiguration
```
default void initConfiguration(java.util.prefs.Preferences prefRoot)
```
    Creates the Configuration, and initialize it with a root Preference. Defer to initConfiguration(java.util.prefs.Preferences, short) by default., with the MDIPluginsInitMode.INIT_DEFAULT argument.
    
    Parameters:
    
    prefRoot - the root Preference, or null if there is no Preference for this MDIApplication
    
    See Also:
    
    PluginsManager
  - initConfiguration
```
default void initConfiguration(java.util.prefs.Preferences prefRoot,
                               short mdiPluginsInitMode)
```
    Creates the Configuration, and initialize it with a root Preference. Do nothing by default.
    
    Parameters:
    
    prefRoot - the root Preference, or null if there is no Preference for this MDIApplication
    
    mdiPluginsInitMode - the plugins initialization mode
    
    See Also:
    
    PluginsManager
  - serializeConfiguration
```
default void serializeConfiguration()
```
    Serialize the configuration.
  - startTime
```
void startTime(MDIAction action)
```
    Start to count the time for the last operation, and show the statusBar progress.
    
    Parameters:
    
    action - the Action
  - getTime
```
long getTime()
```
    Return the time after the last operation.
    
    Returns:
    
    the time after the last operation
  - stopTime
```
long stopTime(MDIAction action)
```
    Stop the time counting.
    
    Parameters:
    
    action - the Action
    
    Returns:
    
    the elapsed time
  - endAction
```
void endAction(MDIAction action)
```
    Ends a generic action.
    
    Parameters:
    
    action - the action
  - noWriteMessages
```
void noWriteMessages()
```
    Avoid to write messages for the current MDIAction.
  - noTimeMessages
```
void noTimeMessages()
```
    Avoid to write time in messages for the current MDIAction.
  - getApplicationDesc
```
default ApplicationDesc getApplicationDesc()
```
    Return the Application description. Return null by default.
    
    Returns:
    
    the ApplicationID
  - getApplicationID
```
default java.lang.String getApplicationID()
```
    Return the ApplicationID. Return null by default.
    
    Returns:
    
    the ApplicationID
  - disposeApplication
```
void disposeApplication()
```
    Dispose of the Application, calling all necessary code before effectively calling System.exit(0).
  - getCommandLineArguments
```
default java.util.Map<java.lang.String,java.lang.String> getCommandLineArguments()
```
    Return the launch arguments of the application. Return null by default.
    
    Returns:
    
    the launch arguments of the application

Interface MDIApplication

Method Summary

Method Detail

getAllowedPluginTypes

getAdditionalPluginTypes

getConfigurationManager

getErrorLogger

getPluginsManager

isEnabled

isEnabled

getStartDirectory

executeAction

setDefaultBlockingActions

isDefaultBlockingActions

getPluginsEDTSupport

executeAction

Blocking types

executeAction

executeAction

Blocking types

showActionException

getPlugins

getPluginsMap

getPluginForName

getPluginForName

hasPlugin

hasEnabledPlugin

getPlugin

getPlugin

setPluginsDeactivationPolicy

getPluginsDeactivationPolicy

initConfiguration

initConfiguration

serializeConfiguration

startTime

getTime

stopTime

endAction

noWriteMessages

noTimeMessages

getApplicationDesc

getApplicationID

disposeApplication

getCommandLineArguments