org.gvsig.scripting

Interface ScriptingHelpManager

All Known Implementing Classes:

DefaultScriptingHelpManager

public interface ScriptingHelpManager

This class is responsable of the management of the Help services provided to the application. It shows all the methods applied to the JavaDocs imported on the ScriptingFramework

See Also:

ScriptingManager

Nested Class Summary

Nested Classes

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

Method Summary

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.ScriptingHelpMethods 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

Method Detail

makeURL

URL makeURL(File helpsetfolder,
            URL sourceurl)

getMethods

List<ScriptingHelpManager.ScriptingHelpMethod> getMethods()

Gets a List of all the ScriptingHelpManager.ScriptingHelpMethods contained on the JavaDocs

Returns:

a List of the ScriptingHelpManager.ScriptingHelpMethods on all the ScriptingHelpAPIs imported

addMethods

void addMethods(URL methodsfile)

findMethods

Map<String,ScriptingHelpManager.ScriptingHelpMethod> findMethods(String text)

Gets the methods of all the classes includes on the JavaDocs which matches with the text provided

Parameters:

text -

Returns:

a HashMap with the references founded

getHelpSet

HelpSet getHelpSet()

Returns the HelpSet with the Help information of the JavaDocs registered

Returns:

a HelpSet with the Help content

reloadHelp

void reloadHelp()

Reloads the Help information of the JavaDocs

removeHelp

boolean removeHelp(String name)

Removes a help module from the application's helpset

Parameters:

name - String with the identificator of the module help to remove

Returns:

existsHelp

boolean existsHelp(String name)

Checks if exists a help module from the application's helpset with the same identificator

Parameters:

name - String with the identificator of the module help to check

Returns:

true if exists, false if not

importJavadoc

boolean importJavadoc(String name,
                      File javadocFolder,
                      SimpleTaskStatus status)

Adds a new help module to the application's helpset with the identificator specified

Parameters:

name - String with the identificator of the module help to add

javadocFolder -

status -

Returns:

getHelpClass

ScriptingHelpManager.ScriptingHelpClass getHelpClass(String name)

getHelpClasses

List<ScriptingHelpManager.ScriptingHelpClass> getHelpClasses()

getHelpRoots

List<File> getHelpRoots()