KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > columba > api > plugin > IExtensionHandlerKeys


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.api.plugin;
19
20 public interface IExtensionHandlerKeys {
21
22     /**
23      * Every action in Columba is handled by this class.
24      * <p>
25      * These actions are used to generate the menu and the toolbar dynamically.
26      * <p>
27      * @see org.columba.core.gui.action.AbstractColumbaAction
28      */
29     public static final String JavaDoc ORG_COLUMBA_CORE_ACTION = "org.columba.core.action";
30
31     /**
32      * Provides access to main entrypoint of components like addressbook
33      * and mail.
34      * <p>
35      * @see org.columba.core.component.api.IComponentPlugin
36      * @see org.columba.addressbook.main.AddressbookMain
37      * @see org.columba.mail.main.MailMain
38      */
39     public static final String JavaDoc ORG_COLUMBA_CORE_COMPONENT = "org.columba.core.component";
40
41     /**
42      * ConfigExtensionHandler provides an easy way for plugins to have their own
43      * configuration dialog.
44      * <p>
45      * Note that every plugin can have its own configuration file "config.xml"
46      * in its folder anyway.
47      * <p>
48      * @see org.columba.core.gui.plugin.AbstractConfigPlugin
49      */
50     public static final String JavaDoc ORG_COLUMBA_CORE_CONFIG = "org.columba.core.config";
51
52     /**
53      * Provides an easy way to integrate external apps in Columba.
54      * <p>
55      * This includes a first-time assistant for the user. And a configuration
56      * file "external_tools.xml" to store the options of the external tools.
57      * <p>
58      * When using external commandline (already used examples are aspell and
59      * GnuPG) tools, you should just use this handler to get the location of the
60      * executable.
61      * <p>
62      * If the executable wasn't configured, yet a wizard will assist the user in
63      * configuring the external tool. If everything is correctly configured, it
64      * will just return the path of the commandline tool as <code>File</code>.
65      * <p>
66      * <verbatim> File file = getLocationOfExternalTool("gpg"); </verbatim>
67      * <p>
68      * @see org.columba.core.gui.externaltools.AbstractExternalToolsPlugin
69      */
70     public static final String JavaDoc ORG_COLUMBA_CORE_EXTERNALTOOLS = "org.columba.core.externaltools";
71
72     /**
73      * Frame component which is shown in the JFrame container's content pane.
74      * <p>
75      * @see org.columba.api.gui.frame.IFrameMediator
76      * @see org.columba.core.gui.frame
77      * @see org.columba.mail.gui.frame.ThreePaneMailFrameController
78      */
79     public static final String JavaDoc ORG_COLUMBA_CORE_FRAME = "org.columba.core.frame";
80
81     /**
82      * Html Viewer component.
83      * <p>
84      * @see org.columba.core.gui.htmlviewer.api.IHTMLViewerPlugin
85      * @see org.columba.core.gui.htmlviewer
86      */
87     public static final String JavaDoc ORG_COLUMBA_CORE_HTMLVIEWER = "org.columba.core.htmlviewer";
88
89     /**
90      * Tray Icon plugged into the statusbar
91      * <p>
92      * @see org.columba.api.statusbar.IStatusBarExtension
93      */
94     public static final String JavaDoc ORG_COLUMBA_CORE_STATUSBAR = "org.columba.core.statusbar";
95
96     /**
97      * Look and Feel plugin handler.
98      * <p>
99      * @see org.columba.core.gui.themes.plugin.AbstractThemePlugin
100      */
101     public static final String JavaDoc ORG_COLUMBA_CORE_THEME = "org.columba.core.theme";
102
103
104     /**
105      * Background services
106      * <p>
107      * @see org.columba.core.scripting.service.api.IColumbaService
108      */
109     public static final String JavaDoc ORG_COLUMBA_CORE_SERVICE = "org.columba.core.service";
110
111     /**
112      * Actions can be registered. These actions should be representing "new item".
113      * For example "New Mail", "New Contact", "New Appointment".
114      * <p>
115      * They will be promptly presented in the "File->New" menu and the toolbar.
116      * <p>
117      * @see org.columba.core.gui.action.AbstractColumbaAction
118      */
119     public static final String JavaDoc ORG_COLUMBA_CORE_NEWITEM = "org.columba.core.newitem";
120     
121     /**
122      * Search Providers should implement <code>org.columba.core.search.api.ISearchProvider</code>
123      * <p>
124      * @see org.columba.core.search.api.ISearchProvider
125      */
126     public static final String JavaDoc ORG_COLUMBA_CORE_SEARCH = "org.columba.core.search";
127     
128     /**
129      * Context Providers should implemented <code>org.columba.core.gui.context.api.IContextProvider</code>
130      */
131     public static final String JavaDoc ORG_COLUMBA_CORE_CONTEXT_PROVIDER = "org.columba.core.context.provider";
132     
133     /**
134      * Components should implemented <code>org.columba.core.gui.frame.api.IComponentBox</code>
135      */
136     public static final String JavaDoc ORG_COLUMBA_CORE_COMPONENT_BOX = "org.columba.core.component.box";
137 }
138
Popular Tags