Package org.eclipse.help
Interface IHelpResource
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getHref()
Returns the URL (as a string) associated with this help resource.String
getLabel()
Returns the label of this help resource.
-
-
-
Field Detail
-
HREF
static final String HREF
This is attribute name used for href in XML files.- See Also:
- Constant Field Values
-
LABEL
static final String LABEL
This is attribute name used for label in XML files.- See Also:
- Constant Field Values
-
-
Method Detail
-
getHref
String getHref()
Returns the URL (as a string) associated with this help resource.- Returns:
- the URL (as a string) associated with the resource
Valid URL of a help resource is:
- a /pluginID/path/to/resource, where
- pluginID is the unique identifier of the plugin containing the help resource,
- path/to/document is the help resource path, relative to the plugin directory.
- string representation of URI to an external document. In this case, all special characters have to be enoded such that the URI is appropriate to be opened with a web browser. http://eclipse.org/documents/my%20file.html and jar:file:/c:/my%20sources/src.zip!/mypackage/MyClass.html are examples of valid URIs.
- a /pluginID/path/to/resource, where
-
getLabel
String getLabel()
Returns the label of this help resource.- Returns:
- the label
-
-