Matthias Schiffer
34a8bf5a27
git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@233 72836036-5685-4462-b002-a69064685172
388 lines
14 KiB
HTML
388 lines
14 KiB
HTML
<!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 May 10 17:04:59 CEST 2011 -->
|
|
<TITLE>
|
|
IView
|
|
</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="IView";
|
|
}
|
|
}
|
|
</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/IView.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/view/ITablePanel.html" title="interface in jrummikub.view"><B>PREV CLASS</B></A>
|
|
NEXT CLASS</FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../index.html?jrummikub/view/IView.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="IView.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">
|
|
jrummikub.view</FONT>
|
|
<BR>
|
|
Interface IView</H2>
|
|
<DL>
|
|
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../jrummikub/view/impl/View.html" title="class in jrummikub.view.impl">View</A></DD>
|
|
</DL>
|
|
<HR>
|
|
<DL>
|
|
<DT><PRE>public interface <B>IView</B></DL>
|
|
</PRE>
|
|
|
|
<P>
|
|
The top-level view interface
|
|
<P>
|
|
|
|
<P>
|
|
<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="../../jrummikub/view/IView.html#enableStartTurnPanel(boolean)">enableStartTurnPanel</A></B>(boolean enable)</CODE>
|
|
|
|
<BR>
|
|
Enables or disables the player's StartTurnPanel</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/view/IView.html#enableWinPanel(boolean)">enableWinPanel</A></B>(boolean enable)</CODE>
|
|
|
|
<BR>
|
|
Enables or disables the panel shown when a player has won</TD>
|
|
</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/view/IView.html#getNewGameEvent()">getNewGameEvent</A></B>()</CODE>
|
|
|
|
<BR>
|
|
The new game event is emitted when the player wants to start a new game</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../jrummikub/view/IPlayerPanel.html" title="interface in jrummikub.view">IPlayerPanel</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../jrummikub/view/IView.html#getPlayerPanel()">getPlayerPanel</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns the player panel</TD>
|
|
</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/view/IView.html#getQuitEvent()">getQuitEvent</A></B>()</CODE>
|
|
|
|
<BR>
|
|
The quit event is emitted when the player wants to quit the game</TD>
|
|
</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/view/IView.html#getStartTurnEvent()">getStartTurnEvent</A></B>()</CODE>
|
|
|
|
<BR>
|
|
The start turn event is emitted when the player wants to start his turn</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../jrummikub/view/ITablePanel.html" title="interface in jrummikub.view">ITablePanel</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../jrummikub/view/IView.html#getTablePanel()">getTablePanel</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns the table</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/view/IView.html#setCurrentPlayerName(java.lang.String)">setCurrentPlayerName</A></B>(java.lang.String playerName)</CODE>
|
|
|
|
<BR>
|
|
Sets the current player's name</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/view/IView.html#setSelectedStones(java.util.Collection)">setSelectedStones</A></B>(java.util.Collection<<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>> stones)</CODE>
|
|
|
|
<BR>
|
|
Sets the stones that are to be painted selected</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="getTablePanel()"><!-- --></A><H3>
|
|
getTablePanel</H3>
|
|
<PRE>
|
|
<A HREF="../../jrummikub/view/ITablePanel.html" title="interface in jrummikub.view">ITablePanel</A> <B>getTablePanel</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns the table
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the table</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getPlayerPanel()"><!-- --></A><H3>
|
|
getPlayerPanel</H3>
|
|
<PRE>
|
|
<A HREF="../../jrummikub/view/IPlayerPanel.html" title="interface in jrummikub.view">IPlayerPanel</A> <B>getPlayerPanel</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns the player panel
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the playerPanel</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setCurrentPlayerName(java.lang.String)"><!-- --></A><H3>
|
|
setCurrentPlayerName</H3>
|
|
<PRE>
|
|
void <B>setCurrentPlayerName</B>(java.lang.String playerName)</PRE>
|
|
<DL>
|
|
<DD>Sets the current player's name
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>playerName</CODE> - the player name</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setSelectedStones(java.util.Collection)"><!-- --></A><H3>
|
|
setSelectedStones</H3>
|
|
<PRE>
|
|
void <B>setSelectedStones</B>(java.util.Collection<<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>> stones)</PRE>
|
|
<DL>
|
|
<DD>Sets the stones that are to be painted selected
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>stones</CODE> - the stones to be painted selected</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="enableStartTurnPanel(boolean)"><!-- --></A><H3>
|
|
enableStartTurnPanel</H3>
|
|
<PRE>
|
|
void <B>enableStartTurnPanel</B>(boolean enable)</PRE>
|
|
<DL>
|
|
<DD>Enables or disables the player's StartTurnPanel
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>enable</CODE> - enable/disable</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getStartTurnEvent()"><!-- --></A><H3>
|
|
getStartTurnEvent</H3>
|
|
<PRE>
|
|
<A HREF="../../jrummikub/util/IEvent.html" title="interface in jrummikub.util">IEvent</A> <B>getStartTurnEvent</B>()</PRE>
|
|
<DL>
|
|
<DD>The start turn event is emitted when the player wants to start his turn
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the event</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="enableWinPanel(boolean)"><!-- --></A><H3>
|
|
enableWinPanel</H3>
|
|
<PRE>
|
|
void <B>enableWinPanel</B>(boolean enable)</PRE>
|
|
<DL>
|
|
<DD>Enables or disables the panel shown when a player has won
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>enable</CODE> - enable/disable</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getQuitEvent()"><!-- --></A><H3>
|
|
getQuitEvent</H3>
|
|
<PRE>
|
|
<A HREF="../../jrummikub/util/IEvent.html" title="interface in jrummikub.util">IEvent</A> <B>getQuitEvent</B>()</PRE>
|
|
<DL>
|
|
<DD>The quit event is emitted when the player wants to quit the game
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the event</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getNewGameEvent()"><!-- --></A><H3>
|
|
getNewGameEvent</H3>
|
|
<PRE>
|
|
<A HREF="../../jrummikub/util/IEvent.html" title="interface in jrummikub.util">IEvent</A> <B>getNewGameEvent</B>()</PRE>
|
|
<DL>
|
|
<DD>The new game event is emitted when the player wants to start a new game
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the 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/IView.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/view/ITablePanel.html" title="interface in jrummikub.view"><B>PREV CLASS</B></A>
|
|
NEXT CLASS</FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../index.html?jrummikub/view/IView.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="IView.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>
|