View Javadoc

1   package net.sourceforge.simplegamenet.specs.gui;
2   
3   import javax.swing.*;
4   
5   /***
6    * A factory that creates utility panels, such as a {@link net.sourceforge.simplegamenet.framework.gui.ChatClientPanel}.
7    * These utility panels are meant to be used inside the {@link net.sourceforge.simplegamenet.specs.gui.GamePanel}
8    * or windows originating from the <code>GamePanel</code>.
9    *
10   * @author Geoffrey De Smet
11   * @version 1.0, 2003-06-18
12   * @see net.sourceforge.simplegamenet.specs.model.GamePlayerClient#createGamePanel(UtilityPanelFactory)
13   */
14  public interface UtilityPanelFactory {
15  
16      /***
17       * Creates a {@link net.sourceforge.simplegamenet.framework.gui.ChatClientPanel} for use inside
18       * the {@link net.sourceforge.simplegamenet.specs.gui.GamePanel} or windows originating from the
19       * <code>GamePanel</code>. This <code>ChatClientPanel</code> behaves exactly like the
20       * <code>ChatClientPanel</code> inside the "Chat" tab. It sends chat messages and receives
21       * events and chat messages.
22       *
23       * @return a new <code>ChatClientPanel</code>
24       * @see net.sourceforge.simplegamenet.framework.gui.ChatClientPanel
25       */
26      public JPanel createChatClientPanel();
27  
28  }