From 74d8205f30732a8afd6aa45f859188b0a3d447e5 Mon Sep 17 00:00:00 2001
From: Ida Massow <massow@informatik.uni-luebeck.de>
Date: Mon, 20 Jun 2011 04:39:54 +0200
Subject: Kommentare, Kommentare

git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@509 72836036-5685-4462-b002-a69064685172
---
 src/jrummikub/view/IQuitWarningPanel.java | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

(limited to 'src/jrummikub/view/IQuitWarningPanel.java')

diff --git a/src/jrummikub/view/IQuitWarningPanel.java b/src/jrummikub/view/IQuitWarningPanel.java
index b1f4123..34d9e07 100644
--- a/src/jrummikub/view/IQuitWarningPanel.java
+++ b/src/jrummikub/view/IQuitWarningPanel.java
@@ -2,8 +2,14 @@ package jrummikub.view;
 
 import jrummikub.util.IEvent;
 
+/**
+ * Warning panel shown to if the emitted event would cancel the current game
+ */
 public interface IQuitWarningPanel {
 
+	/**
+	 * Enum summarizing the different events invoking the quit warning panel
+	 */
 	public enum QuitMode {
 		/** */
 		DEFAULT,
@@ -13,12 +19,33 @@ public interface IQuitWarningPanel {
 		QUIT_GAME
 	}
 
+	/**
+	 * Is emitted if the user is positive about quitting
+	 * 
+	 * @return the event
+	 */
 	public IEvent getQuitEvent();
 
+	/**
+	 * Is emitted if the user selected quit by mistake
+	 * 
+	 * @return the event
+	 */
 	public IEvent getCancelEvent();
 
+	/**
+	 * Sets the panel according to the event which invoked it
+	 * 
+	 * @param mode
+	 *            the invoking event type
+	 */
 	public void setMode(QuitMode mode);
 
+	/**
+	 * Getter for quit mode
+	 * 
+	 * @return the quit mode
+	 */
 	public QuitMode getQuitMode();
 
 }
\ No newline at end of file
-- 
cgit v1.2.3