| org.eclipse.jface.text.information.IInformationProvider
IInformationProvider | public interface IInformationProvider (Code) | | Provides information related to the content of a text viewer.
In order to provide backward compatibility for clients of IInformationPresenter , extension
interfaces are used to provide a means of evolution. The following extension interfaces exist:
Clients may implement this interface.
See Also: org.eclipse.jface.text.ITextViewer since: 2.0 |
Method Summary | |
String | getInformation(ITextViewer textViewer, IRegion subject) Returns the information about the given subject or null if
no information is available. | IRegion | getSubject(ITextViewer textViewer, int offset) Returns the region of the text viewer's document close to the given
offset that contains a subject about which information can be provided.
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. |
getInformation | String getInformation(ITextViewer textViewer, IRegion subject)(Code) | | Returns the information about the given subject or null if
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.
Parameters: textViewer - the viewer in whose document the subject is contained Parameters: subject - the text region constituting the information subject the information about the subject See Also: IInformationPresenterIInformationProviderExtension.getInformation2(ITextViewerIRegion) |
getSubject | IRegion getSubject(ITextViewer textViewer, int offset)(Code) | | Returns the region of the text viewer's document close to the given
offset that contains a subject about which information can be provided.
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.
Parameters: textViewer - the text viewer in which information has been requested Parameters: offset - the offset at which information has been requested the region of the text viewer's document containing the information subject |
|
|