View Javadoc

1   /*
2    * Trip Tracker, a real-time position tracking system for the Internet.
3    * Copyright (C) 2006  Team Trip Tracker
4    *
5    * This program is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License as published by the
7    * Free Software Foundation; either version 2 of the License, or (at your
8    * option) any later version.
9    *
10   * This program is distributed in the hope that it will be useful, but
11   * WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13   * General Public License for more details.
14   *
15   * You should have received a copy of the GNU General Public License along
16   * with this program; if not, write to the Free Software Foundation, Inc.,
17   * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
18   */
19  
20  package triptracker.client.ui;
21  
22  /***
23   * The form manager interface provides methods for forms to register on their
24   * parent GUI object and gives them the ability to change to other forms
25   * dynamically.
26   */
27  public interface FormManager {
28  	/***
29  	 * Register a form on the form manager. The form manager usually inserts
30  	 * the form into a form list and adds the <code>JComponent</code> from the
31  	 * form to its container object.
32  	 * 
33  	 * @param form to register
34  	 */
35  	public void register(Form form);
36  	
37  	/***
38  	 * De-register a form from a form manager. The form manager removes the form
39  	 * from the form list and its container object. 
40  	 * 
41  	 * @param form to de-register
42  	 */
43  	public void deregister(Form form);
44  	
45  	/***
46  	 * Shows the specified form on the container controlled by the form manager.
47  	 * 
48  	 * @param form to show
49  	 */
50  	public void showForm(Form form);
51  }