telcert.schemaprof.gui
Interface PlugIn

All Known Implementing Classes:

AbstractPlugIn

public interface PlugIn

With this class other developers have the possibility to write PlugIns for the 'SchemaProf' application. Before calling any of the functions of a PlugIn, setFrame(MainFrame) and setClassLoader(ClassLoader) have to be called first.

Version:

$Id: PlugIn.java,v 1.7 2006/03/15 15:02:20 klaasd Exp $

Method Summary

ClassLoader	getClassLoader() Returns the ClassLoadercorrespondent to this jar file.
MainFrame	getFrame() Returns the MainFrame which loaded this PlugIn.
JMenu	getMenu() Returns a JMenu already filled with the PlugIn Action's in a User defined Layout.
List	getMenuActions() Returns a List of PlugIn Action's which will be shown in the Menu of a MainFrame.
String	getName() Returns the PlugIn Name for Identification of the PlugIn in the Menu.
Set	getSupportedLocales() Returns a set of Locale-instances which are supported by this plugin.
void	setClassLoader(ClassLoader loader) Sets the ClassLoader correspondent to the jar file of this PlugIn for loading Resources.
void	setFrame(MainFrame frame) Sets the MainFrame which loads this PlugIn.
void	updateActionStates() Updates the States of all Actions dependend on the current State of the Application's MainFrame, which was previously set with setFrame(MainFrame).
void	updateBundleDirectory(File bundleDirectory) Sets a directory in the local file systems which should be scanned for resource files.
void	updateLocale(Locale locale) Updates the Text of all Visual Components correspondent to the given Locale.
void	updateUI() Updates the current Look&Feel of all Visual Components.

Method Detail

getName

String getName()

Returns the PlugIn Name for Identification of the PlugIn in the Menu.

Returns:

The PlugIn Name as a String.

getMenuActions

List getMenuActions()

Returns a List of PlugIn Action's which will be shown in the Menu of a MainFrame. The MainFrame has to be first set with setFrame(MainFrame).

Returns:

A Listof PlugIn Menu Action's.

See Also:

setFrame(MainFrame)

getMenu

JMenu getMenu()

Returns a JMenu already filled with the PlugIn Action's in a User defined Layout. The menu will be displayed in the MainFrame, which was previously set with setFrame(MainFrame).

Returns:

A JMenuof the PlugIn Action's.

See Also:

setFrame(MainFrame)

updateActionStates

void updateActionStates()

Updates the States of all Actions dependend on the current State of the Application's MainFrame, which was previously set with setFrame(MainFrame).

See Also:

setFrame(MainFrame)

updateLocale

void updateLocale(Locale locale)

Updates the Text of all Visual Components correspondent to the given Locale.

Parameters:

locale - The new Localeof the parent Frame.

getSupportedLocales

Set getSupportedLocales()

Returns a set of Locale-instances which are supported by this plugin.

Returns:

Set of Locale-instances.

updateBundleDirectory

void updateBundleDirectory(File bundleDirectory)

Sets a directory in the local file systems which should be scanned for resource files.

Parameters:

bundleDirectory -

updateUI

void updateUI()

Updates the current Look&Feel of all Visual Components. Please use SwingUtilities.updateComponentTreeUI(java.awt.Component) for all Components if any.

setClassLoader

void setClassLoader(ClassLoader loader)

Sets the ClassLoader correspondent to the jar file of this PlugIn for loading Resources. The ClassLoader will be set before any other method is be called.

Parameters:

loader - The ClassLoaderof the jar file.

setFrame

void setFrame(MainFrame frame)
              throws IllegalArgumentException

Sets the MainFrame which loads this PlugIn. This method should be called before all other methods of this interface. If the MainFrame is already set, calling this method will lead to an IllegalArgumentException.

Parameters:

frame - The MainFrame which loads this PlugIn.

Throws:

IllegalArgumentException - if the MainFrame of this PlugIn was already set.

getFrame

MainFrame getFrame()

Returns the MainFrame which loaded this PlugIn.

Returns:

The MainFrame which loaded this PlugIn.

getClassLoader

ClassLoader getClassLoader()

Returns the ClassLoadercorrespondent to this jar file. Please use the ClassLoader Instance given by setClassLoader(ClassLoader).

Returns:

The ClassLoadercorrespondent to this jar file.