1 /******************************************************************************
2 * MainDialogI.java - The MainDialog's public Interface
3 * $Id$
4 *
5 * BuckoFIBS - Backgammon by BuckoSoft
6 * Copyright© 2009,2010 - Dick Balaska - BuckoSoft, Corp.
7 *
8 * $Log$
9 * Revision 1.6 2011/06/05 06:47:46 dick
10 * Make writeGameMessageLn(s) public.
11 *
12 * Revision 1.5 2011/05/23 05:56:03 dick
13 * Add playSound().
14 *
15 * Revision 1.4 2011/05/15 02:19:41 dick
16 * Move the GameEvent objects to c.b.f.domain.gameEvent.
17 *
18 * Revision 1.3 2011/05/14 04:43:01 dick
19 * I needed to deal with some lightweight Boards.
20 * So finally make the primary document Document
21 * and demote just the Board handling to a domain object.
22 *
23 * Revision 1.2 2011/05/13 14:29:35 dick
24 * Extract some functions to a MainDialog API.
25 *
26 */
27
28 /*
29 * This program is free software: you can redistribute it and/or modify
30 * it under the terms of the GNU General Public License as published by
31 * the Free Software Foundation, either version 3 of the License, or
32 * (at your option) any later version.
33 *
34 * This program is distributed in the hope that it will be useful,
35 * but WITHOUT ANY WARRANTY; without even the implied warranty of
36 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
37 * GNU General Public License for more details.
38 *
39 * You should have received a copy of the GNU General Public License
40 * along with this program. If not, see <http://www.gnu.org/licenses/>.
41 *
42 * The Original Code is BuckoFIBS, <http://www.buckosoft.com/BuckoFIBS/>.
43 * The Initial Developer of the Original Code is Dick Balaska and BuckoSoft, Corp.
44 *
45 */
46 package com.buckosoft.fibs.BuckoFIBS.gui;
47
48 import com.buckosoft.fibs.BuckoFIBS.AudioManager;
49 import com.buckosoft.fibs.document.Document;
50 import com.buckosoft.fibs.domain.gameEvent.GameEvent;
51
52 /** MainDialog's public Interface
53 * @author Dick Balaska
54 * @since 2011/05/12
55 * @version $Revision$ <br> $Date$
56 * @see <a href="http://cvs.buckosoft.com/Projects/BuckoFIBS/BuckoFIBS/src/main/java/com/buckosoft/fibs/BuckoFIBS/gui/MainDialog.java">cvs MainDialog.java</a>
57 */
58 public interface MainDialogI {
59
60 /** Return a reference to our board.
61 * This is the master board in the BuckoFIBS system.
62 * @return The Board
63 */
64 //public Board getBoard();
65
66 public Document getDocument();
67
68 /** Repaint the backgammon board, after its been manipulated somehow
69 */
70 public void updateBoard();
71
72 /** Draw this move happening
73 * @param gameEvent The move to do
74 */
75 public void moveEvent(GameEvent gameEvent);
76
77 /** Play a sound
78 * @param cue The sound Cue to play
79 */
80 public void playSound(AudioManager.Cue cue);
81
82 /** Write a message to the game window
83 * @param s The message to write
84 */
85 public void writeGameMessageln(String s);
86
87 }