aboutsummaryrefslogtreecommitdiff
path: root/doc/uk/org/ury/frontend/FrontendMaster.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/uk/org/ury/frontend/FrontendMaster.html')
-rw-r--r--doc/uk/org/ury/frontend/FrontendMaster.html65
1 files changed, 58 insertions, 7 deletions
diff --git a/doc/uk/org/ury/frontend/FrontendMaster.html b/doc/uk/org/ury/frontend/FrontendMaster.html
index 485ebb1..08e34a5 100644
--- a/doc/uk/org/ury/frontend/FrontendMaster.html
+++ b/doc/uk/org/ury/frontend/FrontendMaster.html
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_22) on Tue Mar 15 10:21:49 GMT 2011 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Sun Mar 20 03:05:35 GMT 2011 -->
<TITLE>
FrontendMaster
</TITLE>
-<META NAME="date" CONTENT="2011-03-15">
+<META NAME="date" CONTENT="2011-03-20">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
@@ -92,7 +92,7 @@ uk.org.ury.frontend</FONT>
<BR>
Interface FrontendMaster</H2>
<DL>
-<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../uk/org/ury/frontend/FrontendAppletPanel.html" title="class in uk.org.ury.frontend">FrontendAppletPanel</A>, <A HREF="../../../../uk/org/ury/frontend/FrontendFrame.html" title="class in uk.org.ury.frontend">FrontendFrame</A></DD>
+<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../uk/org/ury/frontend/FrontendApplet.html" title="class in uk.org.ury.frontend">FrontendApplet</A>, <A HREF="../../../../uk/org/ury/frontend/FrontendFrame.html" title="class in uk.org.ury.frontend">FrontendFrame</A></DD>
</DL>
<HR>
<DL>
@@ -134,6 +134,14 @@ Interface for classes providing the parent unit of a frontend
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../uk/org/ury/frontend/FrontendMaster.html#getResourceDirectory()">getResourceDirectory</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../uk/org/ury/frontend/FrontendMaster.html#loadModule(java.lang.String)">loadModule</A></B>(java.lang.String&nbsp;moduleName)</CODE>
@@ -160,6 +168,14 @@ Interface for classes providing the parent unit of a frontend
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Restore an existing module and control panel into the frontend
master.</TD>
</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../uk/org/ury/frontend/FrontendMaster.html#setupUI()">setupUI</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set up the frontend master's user interface.</TD>
+</TR>
</TABLE>
&nbsp;
<P>
@@ -177,7 +193,8 @@ Interface for classes providing the parent unit of a frontend
<A NAME="loadModule(java.lang.String)"><!-- --></A><H3>
loadModule</H3>
<PRE>
-void <B>loadModule</B>(java.lang.String&nbsp;moduleName)</PRE>
+void <B>loadModule</B>(java.lang.String&nbsp;moduleName)
+ throws <A HREF="../../../../uk/org/ury/frontend/exceptions/LoadFailureException.html" title="class in uk.org.ury.frontend.exceptions">LoadFailureException</A></PRE>
<DL>
<DD>Load a module into the frontend frame.
@@ -186,7 +203,11 @@ void <B>loadModule</B>(java.lang.String&nbsp;moduleName)</PRE>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>moduleName</CODE> - The fully qualified class-name of the module,
- minus the leading "uk.org.ury." domain.</DL>
+ minus the leading "uk.org.ury." domain.
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="../../../../uk/org/ury/frontend/exceptions/LoadFailureException.html" title="class in uk.org.ury.frontend.exceptions">LoadFailureException</A></CODE> - if the class is
+ not found, or is not an implementor of
+ FrontendModule.</DL>
</DD>
</DL>
<HR>
@@ -195,7 +216,8 @@ void <B>loadModule</B>(java.lang.String&nbsp;moduleName)</PRE>
loadModule</H3>
<PRE>
void <B>loadModule</B>(java.lang.String&nbsp;moduleName,
- java.lang.String&nbsp;cPanelName)</PRE>
+ java.lang.String&nbsp;cPanelName)
+ throws <A HREF="../../../../uk/org/ury/frontend/exceptions/LoadFailureException.html" title="class in uk.org.ury.frontend.exceptions">LoadFailureException</A></PRE>
<DL>
<DD>Load a module into the frontend frame, additionally installing
a control panel to communicate with the previous module.
@@ -207,7 +229,11 @@ void <B>loadModule</B>(java.lang.String&nbsp;moduleName,
<DT><B>Parameters:</B><DD><CODE>moduleName</CODE> - The fully qualified class-name of the module,
minus the leading "uk.org.ury." domain.<DD><CODE>cPanelName</CODE> - The fully qualified class-name of the control
panel to install, minus the leading
- "uk.org.ury." domain.</DL>
+ "uk.org.ury." domain.
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="../../../../uk/org/ury/frontend/exceptions/LoadFailureException.html" title="class in uk.org.ury.frontend.exceptions">LoadFailureException</A></CODE> - if the class is
+ not found, or is not an implementor of
+ FrontendModule.</DL>
</DD>
</DL>
<HR>
@@ -241,6 +267,31 @@ void <B>fatalError</B>(java.lang.String&nbsp;message)</PRE>
to the user.</DL>
</DD>
</DL>
+<HR>
+
+<A NAME="setupUI()"><!-- --></A><H3>
+setupUI</H3>
+<PRE>
+void <B>setupUI</B>()</PRE>
+<DL>
+<DD>Set up the frontend master's user interface.
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getResourceDirectory()"><!-- --></A><H3>
+getResourceDirectory</H3>
+<PRE>
+java.lang.String <B>getResourceDirectory</B>()</PRE>
+<DL>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the resource directory.</DL>
+</DD>
+</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>