|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface IHelpContentProducer
Producer capable of generating or otherwise obtaining contents for help
resources. A plug-in can contribute instance of IHelpContentProducer to
"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.
| Method Summary | |
|---|---|
java.io.InputStream |
getInputStream(java.lang.String pluginID,
java.lang.String href,
java.util.Locale locale)
Obtains content of a specified help resource. |
| Method Detail |
|---|
java.io.InputStream getInputStream(java.lang.String pluginID,
java.lang.String href,
java.util.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.
|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.