org.eclipse.jface.text
Interface IWidgetTokenOwner

All Known Implementing Classes:

TextViewer

public interface IWidgetTokenOwner

A widget token must be aquired in order to display information in a temporary window. The intent behind this concept is that only one temporary window should be presented at any moment in time and also to avoid overlapping temporary windows.

Since:

2.0

Method Summary

void	releaseWidgetToken(IWidgetTokenKeeper tokenKeeper) The given token keeper releases the token to this token owner.
boolean	requestWidgetToken(IWidgetTokenKeeper requester) Requests the widget token from this token owner.

Method Detail

requestWidgetToken

public boolean requestWidgetToken(IWidgetTokenKeeper requester)

Requests the widget token from this token owner. Returns true if the token has been aquired or is already owned by the requester. This method is non-blocking.

Parameters:

requester - the token requester

Returns:

true if requester aquires the token, false otherwise

releaseWidgetToken

public void releaseWidgetToken(IWidgetTokenKeeper tokenKeeper)

The given token keeper releases the token to this token owner. If the token has previously not been held by the given token keeper, nothing happens. This method is non-blocking.

Parameters:

tokenKeeper - the token keeper