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: Field.java 1966 2009-10-30 01:15:14Z dmsmith $
21   */
22  package org.crosswire.common.config.swing;
23  
24  import javax.swing.JComponent;
25  
26  import org.crosswire.common.config.Choice;
27  
28  /**
29   * A Field is an interface for a visual representation of a Choice.
30   * 
31   * @see gnu.lgpl.License for license details.<br>
32   *      The copyright to this program is held by it's authors.
33   * @author Joe Walker [joe at eireneh dot com]
34   */
35  public interface Field {
36      /**
37       * Some fields will need some extra info to display properly like the
38       * options in an options field. FieldMap calls this method with options
39       * provided by the choice.
40       * 
41       * @param param
42       *            The options provided by the Choice
43       */
44      void setChoice(Choice param);
45  
46      /**
47       * Return a string version of the current value
48       * 
49       * @return The current value
50       */
51      String getValue();
52  
53      /**
54       * Set the current value.
55       * 
56       * @param value
57       *            The new text
58       */
59      void setValue(String value);
60  
61      /**
62       * Get the actual component that we can add to a Panel. (This can well be
63       * <code>this</code> in an implementation).
64       */
65      JComponent getComponent();
66  }
67