1   /**
2    * Distribution License:
3    * JSword is free software; you can redistribute it and/or modify it under
4    * the terms of the GNU Lesser General Public License, version 2.1 as published by
5    * the Free Software Foundation. This program is distributed in the hope
6    * that it will be useful, but WITHOUT ANY WARRANTY; without even the
7    * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
8    * See the GNU Lesser General Public License for more details.
9    *
10   * The License is available on the internet at:
11   *       http://www.gnu.org/copyleft/lgpl.html
12   * or by writing to:
13   *      Free Software Foundation, Inc.
14   *      59 Temple Place - Suite 330
15   *      Boston, MA 02111-1307, USA
16   *
17   * Copyright: 2005
18   *     The copyright to this program is held by it's authors.
19   *
20   * ID: $Id: ConfigEditor.java 1966 2009-10-30 01:15:14Z dmsmith $
21   */
22  package org.crosswire.common.config.swing;
23  
24  import java.awt.Component;
25  import java.awt.event.ActionListener;
26  
27  import org.crosswire.common.config.Config;
28  
29  /**
30   * An abstraction of a Configuration Editor.
31   * 
32   * @see gnu.lgpl.License for license details.<br>
33   *      The copyright to this program is held by it's authors.
34   * @author Joe Walker [joe at eireneh dot com]
35   */
36  public interface ConfigEditor {
37      /**
38       * The equivalent of a constructor, create a Config base with the set of
39       * Fields that it will display.
40       * 
41       * @param config
42       *            The configurable settings
43       */
44      void construct(Config config);
45  
46      /**
47       * Create a dialog to house a TreeConfig component using the default set of
48       * Fields
49       * 
50       * @param parent
51       *            A component to use to find a frame to use as a dialog parent
52       */
53      void showDialog(Component parent, ActionListener al);
54  }
55