Package org.eclipse.jface.text

Interface IWidgetTokenKeeperExtension

All Known Implementing Classes:

ContentAssistant, InformationPresenter, SubjectControlContentAssistant

public interface IWidgetTokenKeeperExtension

Extension interface for IWidgetTokenKeeper.

Replaces the original requestWidgetToken functionality with a new priority based approach. Adds the concept of focus handling.

Since:

3.0

Method Summary

Modifier and Type	Method	Description
boolean	requestWidgetToken(IWidgetTokenOwner owner, int priority)	The given widget token owner requests the widget token from this token keeper.
boolean	setFocus(IWidgetTokenOwner owner)	Requests the receiver to give focus to its popup shell, hover, or similar.

Method Details

requestWidgetToken

boolean requestWidgetToken(IWidgetTokenOwner owner,
 int priority)

The given widget token owner requests the widget token from this token keeper. Returns true if the token is released by this token keeper. Note, the keeper must not call releaseWidgetToken(IWidgetTokenKeeper) explicitly.

The general contract is that the receiver should release the token if priority exceeds the receiver's priority.

Parameters:

owner - the token owner

priority - the priority of the request

Returns:

true if token has been released false otherwise

setFocus

boolean setFocus(IWidgetTokenOwner owner)

Requests the receiver to give focus to its popup shell, hover, or similar. There is no assumption made whether the receiver actually succeeded in taking the focus. The return value gives a hint whether the receiver tried to take focus.

Parameters:

owner - the token owner

Returns:

true if the receiver tried to take focus, false if it did not.