public class ModuleHelp extends java.lang.Object implements IHoverHelp
IHoverHelp.IMementoVisitor
Constructor and Description |
---|
ModuleHelp(java.net.URL helpLocation)
Help provider for modules, methods and fields.
|
Modifier and Type | Method and Description |
---|---|
IHoverHelp |
getConstantHelp(java.lang.reflect.Field field) |
java.lang.String |
getDescription() |
java.lang.String |
getHoverContent() |
IHoverHelp |
getMethodHelp(java.lang.reflect.Method method) |
static java.net.URL |
getModuleHelpLocation(ModuleDefinition definition)
Retrieve help page URL for a given module definition.
|
java.lang.String |
getName() |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getImageAndLabel, getNodeContent, resolveUrl, updateRelativeLinks, visitMemento
public ModuleHelp(java.net.URL helpLocation) throws java.lang.Exception
helpLocation
- location of help html file.java.lang.Exception
- when help content cannot be readpublic static java.net.URL getModuleHelpLocation(ModuleDefinition definition)
definition
- module definition to get location forpublic java.lang.String getName()
getName
in interface IHoverHelp
public java.lang.String getDescription()
getDescription
in interface IHoverHelp
public java.lang.String getHoverContent()
getHoverContent
in interface IHoverHelp
public IHoverHelp getConstantHelp(java.lang.reflect.Field field)
public IHoverHelp getMethodHelp(java.lang.reflect.Method method) throws java.lang.Exception
java.lang.Exception