public interface IHelpContentProducer
"org.eclipse.help.contentProducer"
extension point. When
content for a resource is needed from a plug-in is needed, help tries to
obtain content from instance of this class contributed by the plugin. If
IHelpContentProvider does not return the content, help system searches
doc.zip and plug-in install location for the file and reads its content.Modifier and Type | Method and Description |
---|---|
InputStream |
getInputStream(String pluginID,
String href,
Locale locale)
Obtains content of a specified help resource.
|
InputStream getInputStream(String pluginID, String href, Locale locale)
pluginID
- unique identifier of a plug-in containing the resourcehref
- path of the resource in a plug-in.
An href has a format path/to/resource or path/to/resource?parameter=value1¶meter2=value2... For example, references/myclass.html may be passed.
locale
- used by the client. In most cases, content in a user language
should be produced.
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.