Fix a comment and update documentation

git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@233 72836036-5685-4462-b002-a69064685172
This commit is contained in:
Matthias Schiffer 2011-05-10 17:05:58 +02:00
parent 670fcf2613
commit 34a8bf5a27
157 changed files with 274 additions and 268 deletions

View file

@ -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();
}