AbstractConfigPlugin


1   //The contents of this file are subject to the Mozilla Public License Version 1.1
2   //(the "License"); you may not use this file except in compliance with the 
3   //License. You may obtain a copy of the License at http://www.mozilla.org/MPL/
4   //
5   //Software distributed under the License is distributed on an "AS IS" basis,
6   //WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
7   //for the specific language governing rights and
8   //limitations under the License.
9   //
10  //The Original Code is "The Columba Project"
11  //
12  //The Initial Developers of the Original Code are Frederik Dietz and Timo Stich.
13  //Portions created by Frederik Dietz and Timo Stich are Copyright (C) 2003. 
14  //
15  //All Rights Reserved.
16  package org.columba.core.gui.plugin;
17  
18  import javax.swing.JPanel  ;
19  
20  import org.columba.api.plugin.IExtensionInterface;
21  
22  /**
23   * 
24   * 
25   * <class>AbstractConfigPlugin</class> is the abstract class for the
26   * org.columba.core.config plugin extension point
27   * 
28   * @author fdietz
29   * 
30   */
31  public abstract class AbstractConfigPlugin implements IExtensionInterface {
32      /**
33       * default constructor
34       */
35      public AbstractConfigPlugin() {
36      }
37  
38      /** ******************* abstract methods ******************************** */
39      /**
40       * 
41       * This method is called when the dialog is viewed the first time.
42       * updateComponents(true) - initialse the gui elements with the
43       * configuration data
44       * 
45       * Its also called when pressing the OK button updateComponents(false) -
46       * update the configuration data in using the gui elements data
47       * 
48       * 
49       * 
50       * @param b
51       *            if true, model -> view, otherwise view -> model
52       * 
53       */
54      public abstract void updateComponents(boolean b);
55  
56      /**
57       * 
58       * Create your configuration <class>JPanel</class> here
59       * 
60       * This panel will be automatically plugged in the configuration dialog.
61       * 
62       * 
63       * @return <class>JPanel</class>
64       */
65      public abstract JPanel   createPanel();
66  
67      /** ****************** internal stuff ********************************* */
68  }
69
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags