aboutsummaryrefslogtreecommitdiff
path: root/src/uk/org/ury/frontend/FrontendModule.java
diff options
context:
space:
mode:
authorMatt Windsor <mattwindsor@btinternet.com>2011-03-21 21:54:31 +0000
committerMatt Windsor <mattwindsor@btinternet.com>2011-03-21 21:54:31 +0000
commitdf7d7981b56a4560c95ea7e9b194080e93398ecf (patch)
treeb3ae4f02d23ae1f7f4951c776ee8d91b0047dd6f /src/uk/org/ury/frontend/FrontendModule.java
parent2d073129857a42ab4195cd433c8be152e357033f (diff)
GREAT PACKAGE RESHUFFLE: Everything is now organised into frontend, backend and common (to frontend and backend) packages. Things may have been broken. Doc refresh.
Diffstat (limited to 'src/uk/org/ury/frontend/FrontendModule.java')
-rw-r--r--src/uk/org/ury/frontend/FrontendModule.java42
1 files changed, 18 insertions, 24 deletions
diff --git a/src/uk/org/ury/frontend/FrontendModule.java b/src/uk/org/ury/frontend/FrontendModule.java
index 4d1e3bf..8298ac5 100644
--- a/src/uk/org/ury/frontend/FrontendModule.java
+++ b/src/uk/org/ury/frontend/FrontendModule.java
@@ -4,38 +4,32 @@
package uk.org.ury.frontend;
/**
- * Interface for all system modules that are to be reachable from
- * the frontend array.
+ * Interface for all system modules that are to be reachable from the frontend
+ * array.
*
* Frontend-exposed modules must:
*
* - be runnable standalone, as either an application or an applet;
*
- * - contain their user interface in a subclass of FrontendModulePanel
- * which can be embedded either in a FrontendFrame, a web page
- * or another module;
- *
+ * - contain their user interface in a subclass of FrontendModulePanel which can
+ * be embedded either in a FrontendFrame, a web page or another module;
+ *
* - use the frontend error reporting systems.
*
- * An abstract implementation of this interface,
- * AbstractFrontendModule, is provided to simplify the creation of
- * frontend modules.
+ * An abstract implementation of this interface, AbstractFrontendModule, is
+ * provided to simplify the creation of frontend modules.
*
* @author Matt Windsor
- *
+ *
*/
-
-public interface FrontendModule
-{
- /**
- * Begin execution of the frontend module.
- *
- * @param master The FrontendMaster driving the frontend.
- *
- * @return the frontend panel to insert into the
- * FrontendMaster.
- */
-
- public FrontendModulePanel
- runFrontend (FrontendMaster master);
+public interface FrontendModule {
+ /**
+ * Begin execution of the frontend module.
+ *
+ * @param master
+ * The FrontendMaster driving the frontend.
+ *
+ * @return the frontend panel to insert into the FrontendMaster.
+ */
+ public FrontendModulePanel runFrontend(FrontendMaster master);
}