Interface IInformationPresenter
-
- All Known Implementing Classes:
InformationPresenter
public interface IInformationPresenterAn information presenter shows information available at the text viewer's current document position. AnIInformationPresenteris aITextVieweradd-on.An information presenters has a list of
IInformationProviderobjects each of which is registered for a particular document content type. The presenter uses the strategy objects to retrieve the information to present.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:IInformationPresenterExtensionsince version 3.0 introducing the ability to handle documents with multiple partitions
The interface can be implemented by clients. By default, clients use
InformationPresenteras the standard implementer of this interface.- Since:
- 2.0
- See Also:
IInformationPresenterExtension,ITextViewer,IInformationProvider
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IInformationProvidergetInformationProvider(String contentType)Returns the information provider to be used for the given content type.voidinstall(ITextViewer textViewer)Installs the information presenter on the given text viewer.voidshowInformation()Shows information related to the cursor position of the text viewer this information presenter is installed on.voiduninstall()Removes the information presenter from the text viewer it has previously been installed on.
-
-
-
Method Detail
-
install
void install(ITextViewer textViewer)
Installs the information presenter on the given text viewer. After this method has been finished, the presenter is operational, i.e. the methodshowInformation()can be called untiluninstall()is called.- Parameters:
textViewer- the viewer on which the presenter is installed
-
uninstall
void uninstall()
Removes the information presenter from the text viewer it has previously been installed on.
-
showInformation
void showInformation()
Shows information related to the cursor position of the text viewer this information presenter is installed on.
-
getInformationProvider
IInformationProvider getInformationProvider(String contentType)
Returns the information provider to be used for the given content type.- Parameters:
contentType- the type of the content for which information will be requested- Returns:
- an information provider or
nullif none exists for the specified content type
-
-