KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > columba > core > context > api > IContextProvider


1 package org.columba.core.context.api;
2
3 import javax.swing.ImageIcon JavaDoc;
4 import javax.swing.JComponent JavaDoc;
5
6 import org.columba.api.gui.frame.IFrameMediator;
7 import org.columba.api.plugin.IExtensionInterface;
8 import org.columba.core.context.semantic.api.ISemanticContext;
9
10 public interface IContextProvider extends IExtensionInterface{
11     
12     /**
13      * Returns technical name. Should be unique.
14      * @return
15      */

16     public String JavaDoc getTechnicalName();
17     
18     /**
19      * Return provider human-readable name
20      * @return
21      */

22     public String JavaDoc getName();
23     
24     /**
25      * Return provider human-readable description
26      * @return
27      */

28     public String JavaDoc getDescription();
29     
30     /**
31      * Return provider icon
32      * @return
33      */

34     public ImageIcon JavaDoc getIcon();
35     
36     /**
37      * Return total number of search results. Method only returns valid result after calling
38      * <code>query</code> first.
39      *
40      * @return total number of search results. <code>-1</code>, in case <code>query</code> was not called, yet
41      */

42     public int getTotalResultCount();
43     
44     public void search(ISemanticContext context, int startIndex, int resultCount);
45     
46     public void showResult();
47     
48     public void clear();
49     
50     public JComponent JavaDoc getView();
51     
52     public boolean isEnabledShowMoreLink();
53     
54     public void showMoreResults(IFrameMediator mediator);
55     
56 }
57
Popular Tags