diff options
Diffstat (limited to 'doc/jrummikub/control/TurnControl.html')
| -rw-r--r-- | doc/jrummikub/control/TurnControl.html | 329 |
1 files changed, 329 insertions, 0 deletions
diff --git a/doc/jrummikub/control/TurnControl.html b/doc/jrummikub/control/TurnControl.html new file mode 100644 index 0000000..465384f --- /dev/null +++ b/doc/jrummikub/control/TurnControl.html @@ -0,0 +1,329 @@ +<!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_20) on Tue May 10 16:57:31 CEST 2011 --> +<TITLE> +TurnControl +</TITLE> + +<META NAME="date" CONTENT="2011-05-10"> + +<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="TurnControl"; + } +} +</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/TurnControl.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="../../jrummikub/control/RoundControl.html" title="class in jrummikub.control"><B>PREV CLASS</B></A> + <A HREF="../../jrummikub/control/TurnControl.HandStonePositionComparator.html" title="class in jrummikub.control"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?jrummikub/control/TurnControl.html" target="_top"><B>FRAMES</B></A> + <A HREF="TurnControl.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: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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"> +jrummikub.control</FONT> +<BR> +Class TurnControl</H2> +<PRE> +java.lang.Object + <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>jrummikub.control.TurnControl</B> +</PRE> +<HR> +<DL> +<DT><PRE>public class <B>TurnControl</B><DT>extends java.lang.Object</DL> +</PRE> + +<P> +Controller for a single turn made by a human player +<P> + +<P> +<HR> + +<P> +<!-- ======== NESTED CLASS SUMMARY ======== --> + +<A NAME="nested_class_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>Nested Class Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>(package private) static class</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../jrummikub/control/TurnControl.HandStonePositionComparator.html" title="class in jrummikub.control">TurnControl.HandStonePositionComparator</A></B></CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_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>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../jrummikub/control/TurnControl.html#TurnControl(jrummikub.model.IHand, jrummikub.model.ITable, jrummikub.view.IView)">TurnControl</A></B>(<A HREF="../../jrummikub/model/IHand.html" title="interface in jrummikub.model">IHand</A> hand, + <A HREF="../../jrummikub/model/ITable.html" title="interface in jrummikub.model">ITable</A> table, + <A HREF="../../jrummikub/view/IView.html" title="interface in jrummikub.view">IView</A> view)</CODE> + +<BR> + Create a new TurnControl using a given hand (of the active player), a given + table and a given view for user interaction.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../jrummikub/control/TurnControl.html#TurnControl(jrummikub.model.IHand, jrummikub.model.ITable, jrummikub.view.IView, jrummikub.control.ITurnTimer)">TurnControl</A></B>(<A HREF="../../jrummikub/model/IHand.html" title="interface in jrummikub.model">IHand</A> hand, + <A HREF="../../jrummikub/model/ITable.html" title="interface in jrummikub.model">ITable</A> table, + <A HREF="../../jrummikub/view/IView.html" title="interface in jrummikub.view">IView</A> view, + <A HREF="../../jrummikub/control/ITurnTimer.html" title="interface in jrummikub.control">ITurnTimer</A> testTimer)</CODE> + +<BR> + Test only constructor</TD> +</TR> +</TABLE> + +<!-- ========== 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> <A HREF="../../jrummikub/util/IEvent.html" title="interface in jrummikub.util">IEvent</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../jrummikub/control/TurnControl.html#getEndOfTurnEvent()">getEndOfTurnEvent</A></B>()</CODE> + +<BR> + Get the event that is emitted when the turn is over</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="../../jrummikub/control/TurnControl.html#startTurn()">startTurn</A></B>()</CODE> + +<BR> + Start the turn</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_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>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="TurnControl(jrummikub.model.IHand, jrummikub.model.ITable, jrummikub.view.IView)"><!-- --></A><H3> +TurnControl</H3> +<PRE> +public <B>TurnControl</B>(<A HREF="../../jrummikub/model/IHand.html" title="interface in jrummikub.model">IHand</A> hand, + <A HREF="../../jrummikub/model/ITable.html" title="interface in jrummikub.model">ITable</A> table, + <A HREF="../../jrummikub/view/IView.html" title="interface in jrummikub.view">IView</A> view)</PRE> +<DL> +<DD>Create a new TurnControl using a given hand (of the active player), a given + table and a given view for user interaction. +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>hand</CODE> - active player's hand<DD><CODE>table</CODE> - current table<DD><CODE>view</CODE> - view for user interaction.</DL> +</DL> +<HR> + +<A NAME="TurnControl(jrummikub.model.IHand, jrummikub.model.ITable, jrummikub.view.IView, jrummikub.control.ITurnTimer)"><!-- --></A><H3> +TurnControl</H3> +<PRE> +<B>TurnControl</B>(<A HREF="../../jrummikub/model/IHand.html" title="interface in jrummikub.model">IHand</A> hand, + <A HREF="../../jrummikub/model/ITable.html" title="interface in jrummikub.model">ITable</A> table, + <A HREF="../../jrummikub/view/IView.html" title="interface in jrummikub.view">IView</A> view, + <A HREF="../../jrummikub/control/ITurnTimer.html" title="interface in jrummikub.control">ITurnTimer</A> testTimer)</PRE> +<DL> +<DD>Test only constructor +<P> +</DL> + +<!-- ============ 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="startTurn()"><!-- --></A><H3> +startTurn</H3> +<PRE> +public void <B>startTurn</B>()</PRE> +<DL> +<DD>Start the turn +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getEndOfTurnEvent()"><!-- --></A><H3> +getEndOfTurnEvent</H3> +<PRE> +public <A HREF="../../jrummikub/util/IEvent.html" title="interface in jrummikub.util">IEvent</A> <B>getEndOfTurnEvent</B>()</PRE> +<DL> +<DD>Get the event that is emitted when the turn is over +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>end of turn event</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/TurnControl.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="../../jrummikub/control/RoundControl.html" title="class in jrummikub.control"><B>PREV CLASS</B></A> + <A HREF="../../jrummikub/control/TurnControl.HandStonePositionComparator.html" title="class in jrummikub.control"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?jrummikub/control/TurnControl.html" target="_top"><B>FRAMES</B></A> + <A HREF="TurnControl.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: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + +</BODY> +</HTML> |