From e39dc98249e5b71892b4dca0fc0f5ca5e16740a6 Mon Sep 17 00:00:00 2001 From: Matthias Schiffer Date: Mon, 2 May 2011 03:59:15 +0200 Subject: Add JavaDoc comments to view interfaces git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@62 72836036-5685-4462-b002-a69064685172 --- src/jrummikub/view/IClickable.java | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) (limited to 'src/jrummikub/view/IClickable.java') diff --git a/src/jrummikub/view/IClickable.java b/src/jrummikub/view/IClickable.java index 9973d5b..818e4fa 100644 --- a/src/jrummikub/view/IClickable.java +++ b/src/jrummikub/view/IClickable.java @@ -4,9 +4,32 @@ import jrummikub.model.Position; import jrummikub.util.IEvent2; public interface IClickable { + /** + * the click event is emitted when the player clicks on the table/board/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 getClickEvent(); + /** + * the range click event is emitted when the player clicks on the table/board/ + * 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 getRangeClickEvent(); + /** + * the set click event is emitted when the player clicks on the table/board/ + * 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 getSetClickEvent(); } -- cgit v1.2.3