summaryrefslogtreecommitdiffstats
path: root/src/jrummikub
diff options
context:
space:
mode:
authorMatthias Schiffer <mschiffer@universe-factory.net>2011-05-10 17:05:58 +0200
committerMatthias Schiffer <mschiffer@universe-factory.net>2011-05-10 17:05:58 +0200
commit34a8bf5a275f2f2db10267b30dce386a1c927db4 (patch)
tree3c779c193c7932144044828bec04cf05c40b15a0 /src/jrummikub
parent670fcf2613f6db2a4bfdaa91ac9d90001a90359e (diff)
downloadJRummikub-34a8bf5a275f2f2db10267b30dce386a1c927db4.tar
JRummikub-34a8bf5a275f2f2db10267b30dce386a1c927db4.zip
Fix a comment and update documentation
git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@233 72836036-5685-4462-b002-a69064685172
Diffstat (limited to 'src/jrummikub')
-rw-r--r--src/jrummikub/view/IStonePanel.java55
1 files changed, 28 insertions, 27 deletions
diff --git a/src/jrummikub/view/IStonePanel.java b/src/jrummikub/view/IStonePanel.java
index 6720902..723231f 100644
--- a/src/jrummikub/view/IStonePanel.java
+++ b/src/jrummikub/view/IStonePanel.java
@@ -4,35 +4,36 @@ import jrummikub.model.Stone;
import jrummikub.util.IEvent2;
/**
- * An interface for view elements that can emit click events for clicks on stones
+ * An interface for view elements that can emit click events for clicks on
+ * stones
*/
public interface IStonePanel {
- /**
- * the click event is emitted when the player clicks on the table/hand/etc.
- *
- * @return the event; the first parameter is the position of the click in grid
- * coordinates, the second is true when the player wants to add stones
- * to his selection instead of replacing them
- */
- public IEvent2<Stone, Boolean> getStoneClickEvent();
+ /**
+ * the click event is emitted when the player clicks on the table/hand/etc.
+ *
+ * @return the event; the first parameter is the stone that was clicked on,
+ * the second is true when the player wants to add stones to his
+ * selection instead of replacing them
+ */
+ public IEvent2<Stone, Boolean> getStoneClickEvent();
- /**
- * the range click event is emitted when the player clicks on the table/hand/
- * etc. and wants to select a range instead of a single stone
- *
- * @return the event; the first parameter is the position of the click in grid
- * coordinates, the second is true when the player wants to add stones
- * to his selection instead of replacing them
- */
- public IEvent2<Stone, Boolean> getRangeClickEvent();
+ /**
+ * the range click event is emitted when the player clicks on the table/hand/
+ * etc. and wants to select a range instead of a single stone
+ *
+ * @return the event; the first parameter is the stone that was clicked on,
+ * the second is true when the player wants to add stones to his
+ * selection instead of replacing them
+ */
+ public IEvent2<Stone, Boolean> getRangeClickEvent();
- /**
- * the set click event is emitted when the player clicks on the table/hand/
- * etc. and wants to select a whole set instead of a single stone
- *
- * @return the event; the first parameter is the position of the click in grid
- * coordinates, the second is true when the player wants to add stones
- * to his selection instead of replacing them
- */
- public IEvent2<Stone, Boolean> getSetClickEvent();
+ /**
+ * the set click event is emitted when the player clicks on the table/hand/
+ * etc. and wants to select a whole set instead of a single stone
+ *
+ * @return the event; the first parameter the stone that was clicked on, the
+ * second is true when the player wants to add stones to his selection
+ * instead of replacing them
+ */
+ public IEvent2<Stone, Boolean> getSetClickEvent();
}