diff options
Diffstat (limited to 'doc/uk/org/ury/frontend/FrontendFrame.html')
| -rw-r--r-- | doc/uk/org/ury/frontend/FrontendFrame.html | 85 |
1 files changed, 75 insertions, 10 deletions
diff --git a/doc/uk/org/ury/frontend/FrontendFrame.html b/doc/uk/org/ury/frontend/FrontendFrame.html index 9b82f52..57b1dae 100644 --- a/doc/uk/org/ury/frontend/FrontendFrame.html +++ b/doc/uk/org/ury/frontend/FrontendFrame.html @@ -2,12 +2,12 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_22) on Tue Mar 15 10:21:48 GMT 2011 --> +<!-- Generated by javadoc (build 1.6.0_20) on Sun Mar 20 03:05:34 GMT 2011 --> <TITLE> FrontendFrame </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"> @@ -204,10 +204,10 @@ A frame that hosts a FrontendModulePanel, used for serving frontend <B>Constructor Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><B><A HREF="../../../../uk/org/ury/frontend/FrontendFrame.html#FrontendFrame(uk.org.ury.frontend.FrontendModulePanel)">FrontendFrame</A></B>(<A HREF="../../../../uk/org/ury/frontend/FrontendModulePanel.html" title="class in uk.org.ury.frontend">FrontendModulePanel</A> parent)</CODE> +<TD><CODE><B><A HREF="../../../../uk/org/ury/frontend/FrontendFrame.html#FrontendFrame(java.lang.String)">FrontendFrame</A></B>(java.lang.String moduleName)</CODE> <BR> - </TD> + Construct a new FrontendFrame given an initial frontend module.</TD> </TR> </TABLE> @@ -229,6 +229,14 @@ A frame that hosts a FrontendModulePanel, used for serving frontend </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../uk/org/ury/frontend/FrontendFrame.html#getResourceDirectory()">getResourceDirectory</A></B>()</CODE> + +<BR> + </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/FrontendFrame.html#loadModule(java.lang.String)">loadModule</A></B>(java.lang.String moduleName)</CODE> @@ -255,6 +263,14 @@ A frame that hosts a FrontendModulePanel, used for serving frontend Restore an existing module and control panel 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/FrontendFrame.html#setupUI()">setupUI</A></B>()</CODE> + +<BR> + Set up the user interface of the frame.</TD> +</TR> </TABLE> <A NAME="methods_inherited_from_class_javax.swing.JFrame"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> @@ -332,11 +348,19 @@ A frame that hosts a FrontendModulePanel, used for serving frontend </TR> </TABLE> -<A NAME="FrontendFrame(uk.org.ury.frontend.FrontendModulePanel)"><!-- --></A><H3> +<A NAME="FrontendFrame(java.lang.String)"><!-- --></A><H3> FrontendFrame</H3> <PRE> -public <B>FrontendFrame</B>(<A HREF="../../../../uk/org/ury/frontend/FrontendModulePanel.html" title="class in uk.org.ury.frontend">FrontendModulePanel</A> parent)</PRE> +public <B>FrontendFrame</B>(java.lang.String moduleName)</PRE> <DL> +<DD>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. +<P> +<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> </DL> <!-- ============ METHOD DETAIL ========== --> @@ -349,10 +373,27 @@ public <B>FrontendFrame</B>(<A HREF="../../../../uk/org/ury/frontend/FrontendMod </TR> </TABLE> +<A NAME="setupUI()"><!-- --></A><H3> +setupUI</H3> +<PRE> +public void <B>setupUI</B>()</PRE> +<DL> +<DD>Set up the user interface of the frame. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../uk/org/ury/frontend/FrontendMaster.html#setupUI()">setupUI</A></CODE> in interface <CODE><A HREF="../../../../uk/org/ury/frontend/FrontendMaster.html" title="interface in uk.org.ury.frontend">FrontendMaster</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + <A NAME="loadModule(java.lang.String)"><!-- --></A><H3> loadModule</H3> <PRE> -public void <B>loadModule</B>(java.lang.String moduleName)</PRE> +public void <B>loadModule</B>(java.lang.String 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. @@ -364,7 +405,11 @@ public void <B>loadModule</B>(java.lang.String moduleName)</PRE> </DD> <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> @@ -373,7 +418,8 @@ public void <B>loadModule</B>(java.lang.String moduleName)</PRE> loadModule</H3> <PRE> public void <B>loadModule</B>(java.lang.String moduleName, - java.lang.String cPanelName)</PRE> + java.lang.String 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. @@ -388,7 +434,11 @@ public void <B>loadModule</B>(java.lang.String 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> @@ -429,6 +479,21 @@ public void <B>fatalError</B>(java.lang.String message)</PRE> to the user.</DL> </DD> </DL> +<HR> + +<A NAME="getResourceDirectory()"><!-- --></A><H3> +getResourceDirectory</H3> +<PRE> +public java.lang.String <B>getResourceDirectory</B>()</PRE> +<DL> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../uk/org/ury/frontend/FrontendMaster.html#getResourceDirectory()">getResourceDirectory</A></CODE> in interface <CODE><A HREF="../../../../uk/org/ury/frontend/FrontendMaster.html" title="interface in uk.org.ury.frontend">FrontendMaster</A></CODE></DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>the resource directory.</DL> +</DD> +</DL> <!-- ========= END OF CLASS DATA ========= --> <HR> |