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 import javax.swing.JComponent;
23
24 /***
25 * Form inteface for managing forms in a GUI by a {@link FormManager}.
26 */
27 public interface Form {
28 /***
29 * Returns the root {@link JComponent} object that this form operates on.
30 *
31 * @return root JComponent object
32 * @see FormManager
33 */
34 public JComponent getFormComponent();
35
36 /***
37 * Returns the name of this form. This name should be unique for each form
38 * for a given instance of {@link FormManager}.
39 *
40 * @return form name
41 * @see FormManager
42 */
43 public String getName();
44
45 /***
46 * Invoked by {@link FormManager} right before this form is displayed.
47 *
48 * @see FormManager
49 */
50 public void refreshView();
51
52 // public void updateModel (Model model);
53 }