be.ac.ulg.montefiore.run.totem.visualtopo.guiModules
Interface GUIModule

All Known Implementing Classes:

AbstractGUIModule, CBGPManager, IGPWOGUIModule, RoutingGUIModule, RttMeasurementManager, SAMTEGUIModule, TopEditGUIModule, TrafficMatrixGenerationGUIModule, UninaModule, WhatIfModule

public interface GUIModule

Implement this interface will allow you to add your own modules to the gui. You will then be able to add new menus to the gui, insert you're own panels, JDialog, etc.

A more simple way to do this is by extending the abstract class: AbstractModuleLoader.

Once your module created, you can add it to the managed module list by using the addModule method of ModuleLoader.

The full class name of the module can be added to the preferences.xml file under the section "AVAILABLE-GUI-MODULES". The ModuleLoader will load them automatically. This can be possible only if the GUI module have a public constructor with no parameter.

Creation date: 21-Mar-2005

Author:

Olivier Materne (O.Materne@student.ulg.ac.be)

Method Summary

javax.swing.JMenu	getMenu() The method should return the menu you want to add to the gui
java.lang.String	getName() Returns the GUIModule's name
void	initialize() Any action that must be done at the module initialization
boolean	isUnloadable() Once loaded, can your GUIModule be unloaded ??
boolean	loadAtStartup() Should the module be loaded at startup ? (For the Module to be properly loaded at startup, it should be added to the database before the GUI is launched)
void	terminate() Any action that must be done when the Module is unloaded

Method Detail

getMenu

javax.swing.JMenu getMenu()

The method should return the menu you want to add to the gui

Returns:

isUnloadable

boolean isUnloadable()

Once loaded, can your GUIModule be unloaded ??

Returns:

true if the module can be unloaded, else false

loadAtStartup

boolean loadAtStartup()

Should the module be loaded at startup ? (For the Module to be properly loaded at startup, it should be added to the database before the GUI is launched)

Returns:

true if the GUIModule must be loaded at startup, else false

initialize

void initialize()

Any action that must be done at the module initialization

terminate

void terminate()

Any action that must be done when the Module is unloaded

getName

java.lang.String getName()

Returns the GUIModule's name

Returns:

the GUIModule's name