com.kheops.jmap.client

Class JMapClientExtension

java.lang.Object

com.kheops.jmap.client.JMapClientExtension

public abstract class JMapClientExtension
extends java.lang.Object

A JMapClientExtension is a module that can be integrated into a JMap client application to extend its functionalities. The interface provides the required methods to integrate the extension with the application user interface. The init() method is typically called at the application startup and receives a reference to the application context object which provides various information about the application. The initGUI() method is called after the application GUI is initialized. The destroy() method is typically called at application exit.

Since:

4.0

See Also:

JMapApplicationContext

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXTENSION_MANIFEST_ATTRIBUTE_CLASS
static java.lang.String	EXTENSION_MANIFEST_ATTRIBUTE_DEPENDENCIES
static java.lang.String	EXTENSION_MANIFEST_ATTRIBUTE_DEPLOYER
static java.lang.String	EXTENSION_MANIFEST_ATTRIBUTE_NAME
static java.lang.String	EXTENSION_MANIFEST_ATTRIBUTE_VERSION
static java.lang.String	EXTENSION_PARAMETER_GUI_VISIBLE
static java.lang.String	EXTENSION_PARAMETER_TOOLBAR_VISIBLE

Constructor Summary

Constructors

Constructor and Description
JMapClientExtension()

Method Summary

Modifier and Type	Method and Description
abstract void	destroy() Tells the extension to do its cleanup before the application exits.
abstract void	init(JMapApplicationContext appContext) Deprecated. Replaced by init(JMapApplicationContext, java.util.Map)
void	init(JMapApplicationContext appContext, java.util.Map<java.lang.String,java.lang.String> mapExtensionParameters) Tells the extension to initialize itself.
abstract void	initGUI() Tells the extension to initialize its GUI (toolbars, menus, etc).

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSION_MANIFEST_ATTRIBUTE_CLASS

public static final java.lang.String EXTENSION_MANIFEST_ATTRIBUTE_CLASS

See Also:

Constant Field Values

EXTENSION_MANIFEST_ATTRIBUTE_NAME

public static final java.lang.String EXTENSION_MANIFEST_ATTRIBUTE_NAME

See Also:

Constant Field Values

EXTENSION_MANIFEST_ATTRIBUTE_VERSION

public static final java.lang.String EXTENSION_MANIFEST_ATTRIBUTE_VERSION

See Also:

Constant Field Values

EXTENSION_MANIFEST_ATTRIBUTE_DEPLOYER

public static final java.lang.String EXTENSION_MANIFEST_ATTRIBUTE_DEPLOYER

See Also:

Constant Field Values

EXTENSION_MANIFEST_ATTRIBUTE_DEPENDENCIES

public static final java.lang.String EXTENSION_MANIFEST_ATTRIBUTE_DEPENDENCIES

See Also:

Constant Field Values

EXTENSION_PARAMETER_TOOLBAR_VISIBLE

public static final java.lang.String EXTENSION_PARAMETER_TOOLBAR_VISIBLE

See Also:

Constant Field Values

EXTENSION_PARAMETER_GUI_VISIBLE

public static final java.lang.String EXTENSION_PARAMETER_GUI_VISIBLE

See Also:

Constant Field Values

Constructor Detail

JMapClientExtension

public JMapClientExtension()

Method Detail

init

@Deprecated
public abstract void init(JMapApplicationContext appContext)

Deprecated. Replaced by init(JMapApplicationContext, java.util.Map)

Tells the extension to initialize itself. Called by the application at startup. This method is called before the GUI is ready and should be used for early initialization actions that don't involve the GUI.

Parameters:

appContext - the JMap client application context

init

public void init(JMapApplicationContext appContext,
                 java.util.Map<java.lang.String,java.lang.String> mapExtensionParameters)

Tells the extension to initialize itself. Called by the application at startup. This method is called before the GUI is ready and should be used for early initialization actions that don't involve the GUI.

Parameters:

appContext - the JMap client application context

mapExtensionParameters - a map containing parameters for the extension

initGUI

public abstract void initGUI()

Tells the extension to initialize its GUI (toolbars, menus, etc). Called by the application when it is ready.

destroy

public abstract void destroy()

Tells the extension to do its cleanup before the application exits.