Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.jface.text.information
Interface IInformationProvider


public interface IInformationProvider

Provides information related to the content of a text viewer.

In order to provide backward compatibility for clients of IInformationProvider, extension interfaces are used to provide a means of evolution. The following extension interfaces exist:

Clients may implement this interface.

Since:
2.0
See Also:
IInformationProviderExtension, IInformationProviderExtension2, IInformationPresenter, ITextViewer

Method Summary
  String getInformation ( ITextViewer textViewer, IRegion subject)
          Deprecated. As of 2.1, replaced by IInformationProviderExtension.getInformation2(ITextViewer, IRegion)
  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.
 

Method Detail

getSubject

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.

Parameters:
textViewer - the text viewer in which information has been requested
offset - the offset at which information has been requested
Returns:
the region of the text viewer's document containing the information subject

getInformation

String getInformation(
ITextViewer textViewer,
                      
IRegion subject)
Deprecated. As of 2.1, replaced by IInformationProviderExtension.getInformation2(ITextViewer, IRegion)

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
subject - the text region constituting the information subject
Returns:
the information about the subject
See Also:
IInformationPresenter

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire