View Javadoc
1   /******************************************************************************
2    * ReplayToolbarI.java - Public Interface to the ReplayToolbar
3    * $Id$
4    * 
5    * BuckoFIBS - Backgammon by BuckoSoft
6    * Copyright© 2011 - Dick Balaska - BuckoSoft, Corp.
7    * 
8    * $Log$
9    * Revision 1.2  2011/05/23 03:10:41  dick
10   * Add PlayPause handling.
11   *
12   * Revision 1.1  2011/05/15 02:17:33  dick
13   * c.b.f.B.gui.board becomes c.b.f.B.gui.boardTab.
14   *
15   * Revision 1.1  2011/05/11 22:21:44  dick
16   * Extract ReplayToolbar's public api to an Interface.
17   *
18   */
19  
20  /* 
21   * This program is free software: you can redistribute it and/or modify
22   * it under the terms of the GNU General Public License as published by
23   * the Free Software Foundation, either version 3 of the License, or
24   * (at your option) any later version.
25   *
26   * This program is distributed in the hope that it will be useful,
27   * but WITHOUT ANY WARRANTY; without even the implied warranty of
28   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
29   * GNU General Public License for more details.
30   *
31   * You should have received a copy of the GNU General Public License
32   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
33   *
34   * The Original Code is BuckoFIBS, <http://www.buckosoft.com/BuckoFIBS/>.
35   * The Initial Developer of the Original Code is Dick Balaska and BuckoSoft, Corp.
36   * 
37   */
38  package com.buckosoft.fibs.BuckoFIBS.gui.boardTab;
39  
40  import com.buckosoft.swing.JButtonI;
41  
42  /** Replay Toolbar public interface
43   * @author Dick Balaska
44   * @since 2011/05/10
45   * @version $Revision$ <br> $Date$
46   * @see <a href="http://cvs.buckosoft.com/Projects/BuckoFIBS/BuckoFIBS/src/main/java/com/buckosoft/fibs/BuckoFIBS/gui/board/ReplayToolbar.java">cvs ReplayToolbarI.java</a>
47   */
48  public interface ReplayToolbarI {
49  	
50  	/** Set the ToolbarHandler that receives our events
51  	 * @param toolbarHandler The toolbarHandler to send events to
52  	 */
53  	public void setToolbarHandler(ToolbarHandler toolbarHandler);
54  	
55  	/** Get a handle to the button that rewinds to the first move in the list
56  	 * @return The First button
57  	 */
58  	public JButtonI getJButtonFirst();
59  	
60  	/** Get a handle to the button that rewinds to the previous move in the list
61  	 * @return The Back button
62  	 */
63  	public JButtonI getJButtonBack();
64  
65  	/** Get a handle to the button that advances to the next move in the list
66  	 * @return The Next button
67  	 */
68  	public JButtonI getJButtonNext();
69  
70  	/** Get a handle to the button that advances to the last move in the list
71  	 * @return The End button
72  	 */
73  	public JButtonI getJButtonEnd();
74  
75  	/** Set the state of play-pause
76  	 * @param playPause true=play mode, false=pause mode
77  	 */
78  	public void	setPlayPause(boolean playPause);
79  	
80  	/** Return the state of play-pause
81  	 * @return true if playing, false if pausing
82  	 */
83  	public boolean isPlayPause();
84  }