From df7d7981b56a4560c95ea7e9b194080e93398ecf Mon Sep 17 00:00:00 2001 From: Matt Windsor Date: Mon, 21 Mar 2011 21:54:31 +0000 Subject: GREAT PACKAGE RESHUFFLE: Everything is now organised into frontend, backend and common (to frontend and backend) packages. Things may have been broken. Doc refresh. --- doc/uk/org/ury/frontend/FrontendFrame.html | 64 ++++++++++++++---------------- 1 file changed, 29 insertions(+), 35 deletions(-) (limited to 'doc/uk/org/ury/frontend/FrontendFrame.html') diff --git a/doc/uk/org/ury/frontend/FrontendFrame.html b/doc/uk/org/ury/frontend/FrontendFrame.html index 8f2f727..7b45c1a 100644 --- a/doc/uk/org/ury/frontend/FrontendFrame.html +++ b/doc/uk/org/ury/frontend/FrontendFrame.html @@ -2,7 +2,7 @@ - + FrontendFrame @@ -109,8 +109,8 @@ java.lang.Object

-A frame that hosts a FrontendModulePanel, used for serving frontend - panels in a window (application mode). +A frame that hosts a FrontendModulePanel, used for serving frontend panels in + a window (application mode).

@@ -250,8 +250,8 @@ A frame that hosts a FrontendModulePanel, used for serving frontend java.lang.String cPanelName)
-          Load a module into the frontend frame, additionally installing - a control panel to communicate with the previous module. +          Load a module into the frontend frame, additionally installing a control + panel to communicate with the previous module. @@ -260,8 +260,7 @@ A frame that hosts a FrontendModulePanel, used for serving frontend FrontendControlPanel cpanel)
-          Restore an existing module and control panel into the frontend - frame. +          Restore an existing module and control panel into the frontend frame. @@ -355,12 +354,12 @@ public FrontendFrame(java.lang.String moduleName)

Construct a new FrontendFrame given an initial frontend module. - Loading will fail with a fatal error if the class is not found, - or is not an implementor of FrontendModule. + 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.
+
Parameters:
moduleName - The fully qualified class-name of the module, minus the + leading "uk.org.ury." domain.
@@ -397,19 +396,18 @@ public void loadModule(java.lang.String moduleName)
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. + Loading will fail with a fatal error if the class is not found, or is not + an implementor of FrontendModule.

Specified by:
loadModule in interface FrontendMaster
-
Parameters:
moduleName - The fully qualified class-name of the module, - minus the leading "uk.org.ury." domain. +
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.
+
LoadFailureException - if the class is not found, or is not an implementor of + FrontendModule.
@@ -421,24 +419,22 @@ public 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. +
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. + Loading will fail with a fatal error if the class is not found, or is not + an implementor of FrontendModule.

Specified by:
loadModule in interface FrontendMaster
-
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. +
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.
+
LoadFailureException - if the class is not found, or is not an implementor of + FrontendModule.
@@ -449,15 +445,14 @@ restoreModule public void restoreModule(FrontendModulePanel mpanel, FrontendControlPanel cpanel)
-
Restore an existing module and control panel into the frontend - frame. +
Restore an existing module and control panel into the frontend frame.

Specified by:
restoreModule in interface FrontendMaster
-
Parameters:
mpanel - The module panel to restore.
cpanel - The control panel to restore, if any. A null - value signifies a lack of control panel. +
Parameters:
mpanel - The module panel to restore.
cpanel - The control panel to restore, if any. A null value signifies a + lack of control panel.
Throws:
java.lang.IllegalArgumentException - if the mpanel is null.
@@ -475,8 +470,7 @@ public void fatalError(java.lang.String message)
Specified by:
fatalError in interface FrontendMaster
-
Parameters:
message - The message, eg the exception message, to report - to the user.
+
Parameters:
message - The message, eg the exception message, to report to the user.
-- cgit v1.2.3