public interface ScriptingHelpManager
ScriptingManager
Modifier and Type | Interface and Description |
---|---|
static interface |
ScriptingHelpManager.ScriptingHelpClass
Interface that represents a class contained on the JavaDocs
|
static interface |
ScriptingHelpManager.ScriptingHelpMethod
Interface that represents a method implemented by a class of the JavaDoc
|
Modifier and Type | Method and Description |
---|---|
void |
addMethods(URL methodsfile) |
boolean |
existsHelp(String name)
Checks if exists a help module from the application's helpset with the
same identificator
|
Map<String,ScriptingHelpManager.ScriptingHelpMethod> |
findMethods(String text)
Gets the methods of all the classes includes on the JavaDocs which
matches with the text provided
|
ScriptingHelpManager.ScriptingHelpClass |
getHelpClass(String name) |
List<ScriptingHelpManager.ScriptingHelpClass> |
getHelpClasses() |
List<File> |
getHelpRoots() |
HelpSet |
getHelpSet()
Returns the HelpSet with the Help information of the JavaDocs registered
|
List<ScriptingHelpManager.ScriptingHelpMethod> |
getMethods()
Gets a List of all the
ScriptingHelpManager.ScriptingHelpMethod s contained on the
JavaDocs |
boolean |
importJavadoc(String name,
File javadocFolder,
SimpleTaskStatus status)
Adds a new help module to the application's helpset with the
identificator specified
|
URL |
makeURL(File helpsetfolder,
URL sourceurl) |
void |
reloadHelp()
Reloads the Help information of the JavaDocs
|
boolean |
removeHelp(String name)
Removes a help module from the application's helpset
|
List<ScriptingHelpManager.ScriptingHelpMethod> getMethods()
ScriptingHelpManager.ScriptingHelpMethod
s contained on the
JavaDocsScriptingHelpManager.ScriptingHelpMethod
s on all the
ScriptingHelpAPI
s importedvoid addMethods(URL methodsfile)
Map<String,ScriptingHelpManager.ScriptingHelpMethod> findMethods(String text)
text
- HelpSet getHelpSet()
void reloadHelp()
boolean removeHelp(String name)
name
- String with the identificator of the module help to removeboolean existsHelp(String name)
name
- String with the identificator of the module help to checkboolean importJavadoc(String name, File javadocFolder, SimpleTaskStatus status)
name
- String with the identificator of the module help to addjavadocFolder
- status
- ScriptingHelpManager.ScriptingHelpClass getHelpClass(String name)
List<ScriptingHelpManager.ScriptingHelpClass> getHelpClasses()