Add some documentation to view

git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@108 72836036-5685-4462-b002-a69064685172
This commit is contained in:
Matthias Schiffer 2011-05-04 17:03:16 +02:00
parent e3e0e301a3
commit a96f92148a
2 changed files with 23 additions and 0 deletions

View file

@ -50,6 +50,11 @@ class PlayerPanel extends JPanel implements IPlayerPanel {
return hand;
}
/**
* Sets the current player name
*
* @param playerName the player name
*/
void setCurrentPlayerName(String playerName) {
currentPlayerNameLabel.setText(playerName);
}

View file

@ -14,6 +14,9 @@ import javax.swing.border.EmptyBorder;
import jrummikub.util.Event;
import jrummikub.util.IEvent;
/**
* A panel that is displayed before a player's turn
*/
@SuppressWarnings("serial")
class StartTurnPanel extends JPanel {
private final static int PANEL_INSET = 15;
@ -27,6 +30,9 @@ class StartTurnPanel extends JPanel {
private Event startTurnEvent = new Event();
/**
* Creates a new StartTurnPanel
*/
StartTurnPanel() {
setLayout(null);
setBorder(new EmptyBorder(PANEL_INSET, PANEL_INSET, PANEL_INSET,
@ -56,10 +62,22 @@ class StartTurnPanel extends JPanel {
});
}
/**
* Sets the current player name
*
* @param playerName
* the player name
*/
void setCurrentPlayerName(String playerName) {
startTurnLabel.setText("'" + playerName + "' ist jetzt an der Reihe.");
}
/**
* The start turn event is emitted when the current player has clicked the
* start turn button
*
* @return the event
*/
IEvent getStartTurnEvent() {
return startTurnEvent;
}