Added JavaDoc to WinPanel
git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@109 72836036-5685-4462-b002-a69064685172
This commit is contained in:
parent
a96f92148a
commit
8199274c9d
1 changed files with 17 additions and 0 deletions
|
@ -14,6 +14,10 @@ import javax.swing.border.EmptyBorder;
|
||||||
import jrummikub.util.Event;
|
import jrummikub.util.Event;
|
||||||
import jrummikub.util.IEvent;
|
import jrummikub.util.IEvent;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A panel that is displayed when a player has won
|
||||||
|
*/
|
||||||
|
@SuppressWarnings("serial")
|
||||||
public class WinPanel extends JPanel {
|
public class WinPanel extends JPanel {
|
||||||
private final static int PANEL_INSET = 15;
|
private final static int PANEL_INSET = 15;
|
||||||
private final static int PANEL_SEPARATOR = 10;
|
private final static int PANEL_SEPARATOR = 10;
|
||||||
|
@ -28,6 +32,9 @@ public class WinPanel extends JPanel {
|
||||||
private Event quitEvent = new Event();
|
private Event quitEvent = new Event();
|
||||||
private Event newGameEvent = new Event();
|
private Event newGameEvent = new Event();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a new WinPanel
|
||||||
|
*/
|
||||||
WinPanel() {
|
WinPanel() {
|
||||||
setLayout(null);
|
setLayout(null);
|
||||||
setBorder(new EmptyBorder(PANEL_INSET, PANEL_INSET, PANEL_INSET,
|
setBorder(new EmptyBorder(PANEL_INSET, PANEL_INSET, PANEL_INSET,
|
||||||
|
@ -66,10 +73,20 @@ public class WinPanel extends JPanel {
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The new game event is emitted when the player wants to start a new game
|
||||||
|
*
|
||||||
|
* @return the event
|
||||||
|
*/
|
||||||
IEvent getNewGameEvent() {
|
IEvent getNewGameEvent() {
|
||||||
return newGameEvent;
|
return newGameEvent;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The quit event is emitted when the player wants to quit the program
|
||||||
|
*
|
||||||
|
* @return the event
|
||||||
|
*/
|
||||||
IEvent getQuitEvent() {
|
IEvent getQuitEvent() {
|
||||||
return quitEvent;
|
return quitEvent;
|
||||||
}
|
}
|
||||||
|
|
Reference in a new issue