Javadoc
git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@609 72836036-5685-4462-b002-a69064685172
This commit is contained in:
Ida Massow
parent
3193477354
commit
51b7fbe822
156 changed files with 22852 additions and 2001 deletions
|
|
@ -2,12 +2,12 @@
|
|||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<!-- Generated by javadoc (build 1.6.0_22) on Tue May 10 17:04:59 CEST 2011 -->
|
||||
<!-- Generated by javadoc (build 1.6.0_22) on Tue Jul 05 21:51:55 CEST 2011 -->
|
||||
<TITLE>
|
||||
AbstractStonePanel
|
||||
</TITLE>
|
||||
|
||||
<META NAME="date" CONTENT="2011-05-10">
|
||||
<META NAME="date" CONTENT="2011-07-05">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
|
||||
|
||||
|
|
@ -56,7 +56,7 @@ function windowTitle()
|
|||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
PREV CLASS
|
||||
<A HREF="../../../jrummikub/view/impl/HandPanel.html" title="class in jrummikub.view.impl"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<A HREF="../../../jrummikub/view/impl/ConnectPanel.html" title="class in jrummikub.view.impl"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../index.html?jrummikub/view/impl/AbstractStonePanel.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="AbstractStonePanel.html" target="_top"><B>NO FRAMES</B></A>
|
||||
|
|
@ -76,9 +76,9 @@ function windowTitle()
|
|||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: <A HREF="#nested_classes_inherited_from_class_javax.swing.JPanel">NESTED</A> | <A HREF="#fields_inherited_from_class_javax.swing.JComponent">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
SUMMARY: <A HREF="#nested_classes_inherited_from_class_javax.swing.JPanel">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <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>
|
||||
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
|
|
@ -175,6 +175,62 @@ Base class for panels that draw stones
|
|||
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
||||
<B>Field Summary</B></FONT></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>private <A HREF="../../../jrummikub/util/Event1.html" title="class in jrummikub.util">Event1</A><<A HREF="../../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A>></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../jrummikub/view/impl/AbstractStonePanel.html#clickEvent">clickEvent</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>private <A HREF="../../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../jrummikub/view/impl/AbstractStonePanel.html#hoveredStone">hoveredStone</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>private <A HREF="../../../jrummikub/util/Event2.html" title="class in jrummikub.util">Event2</A><<A HREF="../../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>,java.lang.Boolean></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../jrummikub/view/impl/AbstractStonePanel.html#rangeClickEvent">rangeClickEvent</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>private <A HREF="../../../jrummikub/util/Event2.html" title="class in jrummikub.util">Event2</A><<A HREF="../../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>,java.lang.Boolean></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../jrummikub/view/impl/AbstractStonePanel.html#setClickEvent">setClickEvent</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>private <A HREF="../../../jrummikub/util/Event2.html" title="class in jrummikub.util">Event2</A><<A HREF="../../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>,java.lang.Boolean></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../jrummikub/view/impl/AbstractStonePanel.html#stoneClickEvent">stoneClickEvent</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>private <A HREF="../../../jrummikub/view/impl/StonePainter.html" title="class in jrummikub.view.impl">StonePainter</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../jrummikub/view/impl/AbstractStonePanel.html#stonePainter">stonePainter</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>private java.lang.Iterable<<A HREF="../../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A><<A HREF="../../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>,<A HREF="../../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A>>></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../jrummikub/view/impl/AbstractStonePanel.html#stones">stones</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="fields_inherited_from_class_javax.swing.JComponent"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
|
|
@ -269,7 +325,7 @@ Base class for panels that draw stones
|
|||
|
||||
<BR>
|
||||
the range click event is emitted when the player clicks on the table/hand/
|
||||
etc.</TD>
|
||||
etc. and wants to select a range instead of a single stone</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
|
|
@ -278,7 +334,15 @@ Base class for panels that draw stones
|
|||
|
||||
<BR>
|
||||
the set click event is emitted when the player clicks on the table/hand/
|
||||
etc.</TD>
|
||||
etc. and wants to select a whole set instead of a single stone</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>private <A HREF="../../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../jrummikub/view/impl/AbstractStonePanel.html#getStoneAt(jrummikub.model.Position)">getStoneAt</A></B>(<A HREF="../../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A> pos)</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the stone at the specified position</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
|
|
@ -310,7 +374,8 @@ Base class for panels that draw stones
|
|||
<TD><CODE><B><A HREF="../../../jrummikub/view/impl/AbstractStonePanel.html#getTranslation()">getTranslation</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns the translation in pixels the stones in this panel are painted with</TD>
|
||||
Returns the translation in pixels the stones in this panel are painted
|
||||
with</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
|
|
@ -330,6 +395,14 @@ Base class for panels that draw stones
|
|||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>private void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../jrummikub/view/impl/AbstractStonePanel.html#setHoveredStone(jrummikub.model.Stone)">setHoveredStone</A></B>(<A HREF="../../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A> stone)</CODE>
|
||||
|
||||
<BR>
|
||||
Sets the stone over which the cursor hovers</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>protected void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../jrummikub/view/impl/AbstractStonePanel.html#setStones(java.lang.Iterable)">setStones</A></B>(java.lang.Iterable<<A HREF="../../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A><<A HREF="../../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>,<A HREF="../../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A>>> stones)</CODE>
|
||||
|
||||
|
|
@ -385,6 +458,85 @@ Base class for panels that draw stones
|
|||
|
||||
<P>
|
||||
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
|
||||
<A NAME="field_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>Field Detail</B></FONT></TH>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="stonePainter"><!-- --></A><H3>
|
||||
stonePainter</H3>
|
||||
<PRE>
|
||||
private <A HREF="../../../jrummikub/view/impl/StonePainter.html" title="class in jrummikub.view.impl">StonePainter</A> <B>stonePainter</B></PRE>
|
||||
<DL>
|
||||
<DL>
|
||||
</DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="clickEvent"><!-- --></A><H3>
|
||||
clickEvent</H3>
|
||||
<PRE>
|
||||
private <A HREF="../../../jrummikub/util/Event1.html" title="class in jrummikub.util">Event1</A><<A HREF="../../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A>> <B>clickEvent</B></PRE>
|
||||
<DL>
|
||||
<DL>
|
||||
</DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="stoneClickEvent"><!-- --></A><H3>
|
||||
stoneClickEvent</H3>
|
||||
<PRE>
|
||||
private <A HREF="../../../jrummikub/util/Event2.html" title="class in jrummikub.util">Event2</A><<A HREF="../../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>,java.lang.Boolean> <B>stoneClickEvent</B></PRE>
|
||||
<DL>
|
||||
<DL>
|
||||
</DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="rangeClickEvent"><!-- --></A><H3>
|
||||
rangeClickEvent</H3>
|
||||
<PRE>
|
||||
private <A HREF="../../../jrummikub/util/Event2.html" title="class in jrummikub.util">Event2</A><<A HREF="../../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>,java.lang.Boolean> <B>rangeClickEvent</B></PRE>
|
||||
<DL>
|
||||
<DL>
|
||||
</DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setClickEvent"><!-- --></A><H3>
|
||||
setClickEvent</H3>
|
||||
<PRE>
|
||||
private <A HREF="../../../jrummikub/util/Event2.html" title="class in jrummikub.util">Event2</A><<A HREF="../../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>,java.lang.Boolean> <B>setClickEvent</B></PRE>
|
||||
<DL>
|
||||
<DL>
|
||||
</DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="stones"><!-- --></A><H3>
|
||||
stones</H3>
|
||||
<PRE>
|
||||
private java.lang.Iterable<<A HREF="../../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A><<A HREF="../../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>,<A HREF="../../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A>>> <B>stones</B></PRE>
|
||||
<DL>
|
||||
<DL>
|
||||
</DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="hoveredStone"><!-- --></A><H3>
|
||||
hoveredStone</H3>
|
||||
<PRE>
|
||||
private <A HREF="../../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A> <B>hoveredStone</B></PRE>
|
||||
<DL>
|
||||
<DL>
|
||||
</DL>
|
||||
</DL>
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
|
||||
<A NAME="constructor_detail"><!-- --></A>
|
||||
|
|
@ -461,6 +613,22 @@ protected void <B>clickAt</B>(java.awt.Point p,
|
|||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setHoveredStone(jrummikub.model.Stone)"><!-- --></A><H3>
|
||||
setHoveredStone</H3>
|
||||
<PRE>
|
||||
private void <B>setHoveredStone</B>(<A HREF="../../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A> stone)</PRE>
|
||||
<DL>
|
||||
<DD>Sets the stone over which the cursor hovers
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>stone</CODE> - stone under cursor</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getHoveredStone()"><!-- --></A><H3>
|
||||
getHoveredStone</H3>
|
||||
<PRE>
|
||||
|
|
@ -511,6 +679,23 @@ protected void <B>handleOtherMoveEvent</B>(<A HREF="../../../jrummikub/model/Pos
|
|||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getStoneAt(jrummikub.model.Position)"><!-- --></A><H3>
|
||||
getStoneAt</H3>
|
||||
<PRE>
|
||||
private <A HREF="../../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A> <B>getStoneAt</B>(<A HREF="../../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A> pos)</PRE>
|
||||
<DL>
|
||||
<DD>Gets the stone at the specified position
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>pos</CODE> - position
|
||||
<DT><B>Returns:</B><DD>the stone</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setStones(java.lang.Iterable)"><!-- --></A><H3>
|
||||
setStones</H3>
|
||||
<PRE>
|
||||
|
|
@ -532,7 +717,8 @@ getTranslation</H3>
|
|||
<PRE>
|
||||
protected <A HREF="../../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A><java.lang.Integer,java.lang.Integer> <B>getTranslation</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns the translation in pixels the stones in this panel are painted with
|
||||
<DD>Returns the translation in pixels the stones in this panel are painted
|
||||
with
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
|
|
@ -673,7 +859,7 @@ public <A HREF="../../../jrummikub/util/Event2.html" title="class in jrummikub.u
|
|||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
PREV CLASS
|
||||
<A HREF="../../../jrummikub/view/impl/HandPanel.html" title="class in jrummikub.view.impl"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<A HREF="../../../jrummikub/view/impl/ConnectPanel.html" title="class in jrummikub.view.impl"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../index.html?jrummikub/view/impl/AbstractStonePanel.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="AbstractStonePanel.html" target="_top"><B>NO FRAMES</B></A>
|
||||
|
|
@ -693,9 +879,9 @@ public <A HREF="../../../jrummikub/util/Event2.html" title="class in jrummikub.u
|
|||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: <A HREF="#nested_classes_inherited_from_class_javax.swing.JPanel">NESTED</A> | <A HREF="#fields_inherited_from_class_javax.swing.JComponent">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
SUMMARY: <A HREF="#nested_classes_inherited_from_class_javax.swing.JPanel">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <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>
|
||||
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
|
|
|
|||
Reference in a new issue