gvsig-scripting / trunk / org.gvsig.scripting / org.gvsig.scripting.lib / org.gvsig.scripting.lib.api / src / main / java / org / gvsig / scripting / ScriptingHelpManager.java @ 164
History | View | Annotate | Download (2.08 KB)
1 |
package org.gvsig.scripting; |
---|---|
2 |
|
3 |
import java.io.File; |
4 |
import java.net.URL; |
5 |
import java.util.Iterator; |
6 |
import java.util.List; |
7 |
import java.util.Map; |
8 |
|
9 |
import javax.help.HelpSet; |
10 |
|
11 |
public interface ScriptingHelpManager { |
12 |
|
13 |
public interface ScriptingHelpAPI{ |
14 |
public String getName(); |
15 |
} |
16 |
|
17 |
public interface ScriptingHelpClass{ |
18 |
public String getName(); |
19 |
|
20 |
public String getUrl(); |
21 |
} |
22 |
|
23 |
public interface ScriptingHelpMethod extends Iterable{ |
24 |
public String getName(); |
25 |
|
26 |
public Iterator<ScriptingHelpClass> iterator(); |
27 |
|
28 |
} |
29 |
|
30 |
/**
|
31 |
* Returns the directory of the Help's content
|
32 |
*
|
33 |
* @return a File with the Help's Folder
|
34 |
*/
|
35 |
public File getFolder(); |
36 |
|
37 |
public List<ScriptingHelpAPI> getAPI(); |
38 |
|
39 |
public List<ScriptingHelpMethod> getMethods(); |
40 |
|
41 |
/**
|
42 |
* Gets the methods of all the classes includes on the JavaDocs which matches with a text
|
43 |
*
|
44 |
* @parama text String with the text to get the methods that contains it
|
45 |
*
|
46 |
* @return a HashMap with the references founded
|
47 |
*
|
48 |
*/
|
49 |
public Map<String,ScriptingHelpMethod> findMethods(String text); |
50 |
|
51 |
/**
|
52 |
* Returns the HelpSet with the Help information of the JavaDocs registered
|
53 |
*
|
54 |
* @return a HelpSet with the Help content
|
55 |
*/
|
56 |
public HelpSet getHelpSet();
|
57 |
|
58 |
/**
|
59 |
* Reloads the Help information of the JavaDocs
|
60 |
*
|
61 |
*/
|
62 |
public void reloadHelp(); |
63 |
|
64 |
/**
|
65 |
* Removes a help module from the application's helpset
|
66 |
*
|
67 |
* @param name String with the identificator of the module help to remove
|
68 |
*
|
69 |
*/
|
70 |
public void removeHelp(String name); |
71 |
|
72 |
/**
|
73 |
* Checks if exists a help module from the application's helpset with the same identificator
|
74 |
*
|
75 |
* @param name String with the identificator of the module help to check
|
76 |
*
|
77 |
* @return true if exists, false if not
|
78 |
*
|
79 |
*/
|
80 |
public boolean existsHelp(String name); |
81 |
|
82 |
/**
|
83 |
* Adds a new help module to the application's helpset with the identificator specified
|
84 |
*
|
85 |
* @param name String with the identificator of the module help to add
|
86 |
* @param url URL with the root directory of the help to import
|
87 |
*
|
88 |
* @return true if exists, false if not
|
89 |
*
|
90 |
*/
|
91 |
public void importHelp(String name, URL url); |
92 |
|
93 |
} |