uk.org.ury.frontend
Interface FrontendMaster

All Known Implementing Classes:

FrontendApplet, FrontendFrame

public interface FrontendMaster

Interface for classes providing the parent unit of a frontend session. This includes the FrontendFrame used in application mode as well as applets.

Author:

Matt Windsor

Method Summary

void	fatalError(java.lang.String message) Report a fatal error,
java.lang.String	getResourceDirectory()
void	loadModule(java.lang.String moduleName) Load a module into the frontend frame.
void	loadModule(java.lang.String moduleName, java.lang.String cPanelName) Load a module into the frontend frame, additionally installing a control panel to communicate with the previous module.
void	restoreModule(FrontendModulePanel mpanel, FrontendControlPanel cpanel) Restore an existing module and control panel into the frontend master.
void	setupUI() Set up the frontend master's user interface.

Method Detail

loadModule

void loadModule(java.lang.String moduleName)
                throws LoadFailureException

Load a module into the frontend frame. Loading will fail with a fatal error if the class is not found, or is not an implementor of FrontendModule.

Parameters:

moduleName - The fully qualified class-name of the module, minus the leading "uk.org.ury." domain.

Throws:

LoadFailureException - if the class is not found, or is not an implementor of FrontendModule.

loadModule

void loadModule(java.lang.String moduleName,
                java.lang.String cPanelName)
                throws LoadFailureException

Load a module into the frontend frame, additionally installing a control panel to communicate with the previous module. Loading will fail with a fatal error if the class is not found, or is not an implementor of FrontendModule.

Parameters:

moduleName - The fully qualified class-name of the module, minus the leading "uk.org.ury." domain.

cPanelName - The fully qualified class-name of the control panel to install, minus the leading "uk.org.ury." domain.

Throws:

LoadFailureException - if the class is not found, or is not an implementor of FrontendModule.

restoreModule

void restoreModule(FrontendModulePanel mpanel,
                   FrontendControlPanel cpanel)

Restore an existing module and control panel into the frontend master.

Parameters:

mpanel - The module panel to restore.

cpanel - The control panel to restore.

Throws:

java.lang.IllegalArgumentException - if either are null.

fatalError

void fatalError(java.lang.String message)

Report a fatal error,

Parameters:

message - The message, eg the exception message, to report to the user.

setupUI

void setupUI()

Set up the frontend master's user interface.

getResourceDirectory

java.lang.String getResourceDirectory()

Returns:

the resource directory.