KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > columba > mail > folderoptions > IFolderOptionsController


1 // The contents of this file are subject to the Mozilla Public License Version
2 // 1.1
3 //(the "License"); you may not use this file except in compliance with the
4 //License. You may obtain a copy of the License at http://www.mozilla.org/MPL/
5 //
6 //Software distributed under the License is distributed on an "AS IS" basis,
7 //WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
8 //for the specific language governing rights and
9 //limitations under the License.
10 //
11 //The Original Code is "The Columba Project"
12 //
13 //The Initial Developers of the Original Code are Frederik Dietz and Timo
14 // Stich.
15 //Portions created by Frederik Dietz and Timo Stich are Copyright (C) 2003.
16 //
17 //All Rights Reserved.
18 package org.columba.mail.folderoptions;
19
20 import org.columba.core.xml.XmlElement;
21 import org.columba.mail.folder.IMailbox;
22
23 /**
24  * @author fdietz
25  *
26  */
27 public interface IFolderOptionsController {
28     /**
29      * Get plugin with specific name.
30      *
31      * @param name name of plugin
32      * @return instance of plugin
33      */
34     //AbstractFolderOptionsPlugin getPlugin(String name);
35
36     /**
37      * Load all folder options for this folder.
38      *
39      * @param folder selected folder
40      */
41     void load(IMailbox folder, int state);
42
43     /**
44      * Save all folder options for this folder.
45      *
46      * @param folder selected folder
47      */
48     void save(IMailbox folder);
49
50     /**
51      * Load all folder options globally.
52      *
53      */
54     void load(int state);
55
56     /**
57      * Get parent configuration node of plugin.
58      * <p>
59      * Example for the sorting plugin configuration node. This is
60      * how it can be found in options.xml and tree.xml:<br>
61      * <pre>
62      * <sorting column="Date" order="true" />
63      * </pre>
64      * <p>
65      *
66      * @param folder selected folder
67      * @param name name of plugin (example: ColumnOptions)
68      * @return parent configuration node
69      */
70     XmlElement getConfigNode(IMailbox folder, String JavaDoc name);
71
72     /**
73      * Create default settings for this folder.
74      *
75      * @param folder selected folder
76      */
77     void createDefaultSettings(IMailbox folder);
78 }
Popular Tags