public interface IInformationProvider
In order to provide backward compatibility for clients of
interfaces are used to provide a means of evolution. The following extension interfaces exist:
IInformationProviderExtensionsince version 2.1 introducing the ability to provide the element for a given subject
IInformationProviderExtension2since version 3.0 introducing the ability to provide its own information control creator
Clients may implement this interface.
|Modifier and Type||Method and Description|
As of 2.1, replaced by
Returns the region of the text viewer's document close to the given offset that contains a subject about which information can be provided.
IRegion getSubject(ITextViewer textViewer, int offset)
For example, if information can be provided on a per code block basis, the offset should be used to find the enclosing code block and the source range of the block should be returned.
textViewer- the text viewer in which information has been requested
offset- the offset at which information has been requested
String getInformation(ITextViewer textViewer, IRegion subject)
nullif no information is available. It depends on the concrete configuration in which format the information is to be provided. For example, information presented in an information control displaying HTML, should be provided in HTML.
textViewer- the viewer in whose document the subject is contained
subject- the text region constituting the information subject
Copyright (c) 2000, 2013 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.