diff options
| author | Matt Windsor <matt@deling.(none)> | 2011-03-18 08:28:09 +0000 |
|---|---|---|
| committer | Matt Windsor <matt@deling.(none)> | 2011-03-18 08:28:09 +0000 |
| commit | d547f87da5f68c12dede7c9d45618cae11ff5699 (patch) | |
| tree | 613aa95d94b363c72ba9a7be639c74f76edf81f8 /doc/uk/org/ury/frontend/FrontendMaster.html | |
| parent | c8bb324e757587e742df0824304144e1eb881cee (diff) | |
Mega-commit to the rescue! Added Javadoc snapshot (admittedly old); show UI now fixed-layout; UI uses system selection colours for accents; now uses bapsserver password and can thus talk to show database relations; removed member relation dependencies until further notice; attempted to get application and applet launchers working but having issues with the latter; started working on a server communicating via a minimal implementation of HTTP 1.1 (standardisation required eventually).
Diffstat (limited to 'doc/uk/org/ury/frontend/FrontendMaster.html')
| -rw-r--r-- | doc/uk/org/ury/frontend/FrontendMaster.html | 307 |
1 files changed, 307 insertions, 0 deletions
diff --git a/doc/uk/org/ury/frontend/FrontendMaster.html b/doc/uk/org/ury/frontend/FrontendMaster.html new file mode 100644 index 0000000..485ebb1 --- /dev/null +++ b/doc/uk/org/ury/frontend/FrontendMaster.html @@ -0,0 +1,307 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.6.0_22) on Tue Mar 15 10:21:49 GMT 2011 --> +<TITLE> +FrontendMaster +</TITLE> + +<META NAME="date" CONTENT="2011-03-15"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="FrontendMaster"; + } +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> +<HR> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/FrontendMaster.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../uk/org/ury/frontend/FrontendFrame.html" title="class in uk.org.ury.frontend"><B>PREV CLASS</B></A> + <A HREF="../../../../uk/org/ury/frontend/FrontendModule.html" title="interface in uk.org.ury.frontend"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?uk/org/ury/frontend/FrontendMaster.html" target="_top"><B>FRAMES</B></A> + <A HREF="FrontendMaster.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +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> +</DL> +<HR> +<DL> +<DT><PRE>public interface <B>FrontendMaster</B></DL> +</PRE> + +<P> +Interface for classes providing the parent unit of a frontend + session. + + This includes the FrontendFrame used in application mode as + well as applets. +<P> + +<P> +<DL> +<DT><B>Author:</B></DT> + <DD>Matt Windsor</DD> +</DL> +<HR> + +<P> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../uk/org/ury/frontend/FrontendMaster.html#fatalError(java.lang.String)">fatalError</A></B>(java.lang.String message)</CODE> + +<BR> + Report a fatal error,</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> 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 moduleName)</CODE> + +<BR> + Load a module into the frontend frame.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../uk/org/ury/frontend/FrontendMaster.html#loadModule(java.lang.String, java.lang.String)">loadModule</A></B>(java.lang.String moduleName, + java.lang.String cPanelName)</CODE> + +<BR> + Load a module into the frontend frame, additionally installing + a control panel to communicate with the previous module.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../uk/org/ury/frontend/FrontendMaster.html#restoreModule(uk.org.ury.frontend.FrontendModulePanel, uk.org.ury.frontend.FrontendControlPanel)">restoreModule</A></B>(<A HREF="../../../../uk/org/ury/frontend/FrontendModulePanel.html" title="class in uk.org.ury.frontend">FrontendModulePanel</A> mpanel, + <A HREF="../../../../uk/org/ury/frontend/FrontendControlPanel.html" title="class in uk.org.ury.frontend">FrontendControlPanel</A> cpanel)</CODE> + +<BR> + Restore an existing module and control panel into the frontend + master.</TD> +</TR> +</TABLE> + +<P> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="loadModule(java.lang.String)"><!-- --></A><H3> +loadModule</H3> +<PRE> +void <B>loadModule</B>(java.lang.String moduleName)</PRE> +<DL> +<DD>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. +<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> +</DD> +</DL> +<HR> + +<A NAME="loadModule(java.lang.String, java.lang.String)"><!-- --></A><H3> +loadModule</H3> +<PRE> +void <B>loadModule</B>(java.lang.String moduleName, + java.lang.String cPanelName)</PRE> +<DL> +<DD>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. +<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.<DD><CODE>cPanelName</CODE> - The fully qualified class-name of the control + panel to install, minus the leading + "uk.org.ury." domain.</DL> +</DD> +</DL> +<HR> + +<A NAME="restoreModule(uk.org.ury.frontend.FrontendModulePanel, uk.org.ury.frontend.FrontendControlPanel)"><!-- --></A><H3> +restoreModule</H3> +<PRE> +void <B>restoreModule</B>(<A HREF="../../../../uk/org/ury/frontend/FrontendModulePanel.html" title="class in uk.org.ury.frontend">FrontendModulePanel</A> mpanel, + <A HREF="../../../../uk/org/ury/frontend/FrontendControlPanel.html" title="class in uk.org.ury.frontend">FrontendControlPanel</A> cpanel)</PRE> +<DL> +<DD>Restore an existing module and control panel into the frontend + master. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>mpanel</CODE> - The module panel to restore.<DD><CODE>cpanel</CODE> - The control panel to restore. +<DT><B>Throws:</B> +<DD><CODE>java.lang.IllegalArgumentException</CODE> - if either are null.</DL> +</DD> +</DL> +<HR> + +<A NAME="fatalError(java.lang.String)"><!-- --></A><H3> +fatalError</H3> +<PRE> +void <B>fatalError</B>(java.lang.String message)</PRE> +<DL> +<DD>Report a fatal error, +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>message</CODE> - The message, eg the exception message, to report + to the user.</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/FrontendMaster.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../uk/org/ury/frontend/FrontendFrame.html" title="class in uk.org.ury.frontend"><B>PREV CLASS</B></A> + <A HREF="../../../../uk/org/ury/frontend/FrontendModule.html" title="interface in uk.org.ury.frontend"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?uk/org/ury/frontend/FrontendMaster.html" target="_top"><B>FRAMES</B></A> + <A HREF="FrontendMaster.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + +</BODY> +</HTML> |