1 package net.sourceforge.simplegamenet.specs.gui;
2
3 import javax.swing.*;
4
5 /***
6 * A <code>JPanel</code> shown in the "Game" tab and is the primary source for a game module to
7 * communicate with a user. This game panel is normally created in {@link
8 * GamePlayerClient#createGamePanel(UtilityPanelFactory)} and usually holds a reference back to that
9 * <code>GamePlayerClient</code> to be able to send events to the <code>GameServer</code>.
10 * <p/>
11 * The SimpleGameNet framework leaves a 10 pixel empty space around this game panel, so the game
12 * panel normally doesn't have the need to leave any empty space itself at its edges.
13 *
14 * @author Geoffrey De Smet
15 * @version 1.0, 2003-06-18
16 * @see net.sourceforge.simplegamenet.specs.model.GamePlayerClient#createGamePanel(net.sourceforge.simplegamenet.specs.gui.UtilityPanelFactory)
17 */
18 abstract public class GamePanel extends JPanel {
19
20 /***
21 * Called by the SimpleGameNet framework to inform this game panel that it is being reclaimed
22 * and that it should destroy any resources that it has allocated.
23 * <p/>
24 * A subclass of <code>GamePanel</code> should override this method if it has any operation that
25 * it wants to perform before it is destroyed.
26 * <p/>
27 * The implementation of this method provided by the <code>GamePanel</code> class does nothing.
28 */
29 public void destroy() {
30 }
31
32 }