1 /*
2 * XNap Commons
3 *
4 * Copyright (C) 2005 Steffen Pingel
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
20 package org.xnap.commons.gui.wizard;
21
22 import javax.swing.Icon;
23 import javax.swing.JComponent;
24
25 /***
26 * Defines the requirements for panels that are shown in the wizard or
27 * preferences dialog.
28 *
29 * @author Steffen Pingel
30 */
31 public interface WizardPage {
32
33 /***
34 * Invoked when the dialog is closed or the apply button is pressed.
35 */
36 boolean apply();
37
38 /***
39 * Returns a short description of the panel.
40 */
41 String getDescription();
42
43 /***
44 * Returns an icon.
45 */
46 Icon getIcon();
47
48 /***
49 * Returns the panel.
50 */
51 JComponent getPanel();
52
53 /***
54 * Returns the title of the panel.
55 */
56 String getTitle();
57
58 }
59