Source code: com/virtuosotechnologies/asaph/maingui/PrefsPaneProvider.java
1 /*
2 ================================================================================
3
4 FILE: PrefsPaneProvider.java
5
6 PROJECT:
7
8 Asaph
9
10 CONTENTS:
11
12 This interface should be implemented to implement a prefs pane
13
14 PROGRAMMERS:
15
16 Daniel Azuma (DA) <dazuma@kagi.com>
17
18 COPYRIGHT:
19
20 Copyright (C) 2003 Daniel Azuma (dazuma@kagi.com)
21
22 This program is free software; you can redistribute it and/or
23 modify it under the terms of the GNU General Public License as
24 published by the Free Software Foundation; either version 2
25 of the License, or (at your option) any later version.
26
27 This program is distributed in the hope that it will be useful,
28 but WITHOUT ANY WARRANTY; without even the implied warranty of
29 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30 GNU General Public License for more details.
31
32 You should have received a copy of the GNU General Public
33 License along with this program; if not, write to
34 Free Software Foundation, Inc.
35 59 Temple Place, Suite 330
36 Boston, MA 02111-1307 USA
37
38 ================================================================================
39 */
40
41
42 package com.virtuosotechnologies.asaph.maingui;
43
44
45 import javax.swing.JComponent;
46
47
48 /**
49 * This interface should be implemented to implement a prefs pane.
50 */
51 public interface PrefsPaneProvider
52 {
53 /**
54 * This method is called when the prefs window is opened. The provider
55 * should return a JComponent implementing the prefs pane, and ensure that it
56 * reflects the current settings.
57 *
58 * @param dialogParent a JComponent to use as a dialog parent
59 * @return the JComponent to add to the prefs window
60 */
61 public JComponent createPane(
62 JComponent dialogParent);
63
64
65 /**
66 * This method is called when the pane is brought into focus.
67 */
68 public void paneFocused();
69
70
71 /**
72 * This method is called when the pane is unfocused.
73 */
74 public void paneUnfocused();
75
76
77 /**
78 * This method is called when the prefs window is closed. The provider should
79 * generally respond by defuncting the pane.
80 */
81 public void paneDisposed();
82 }