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
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Mail Systems
Eclipse Documentation

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




Eclipse Platform
Release 3.5

Interface IWidgetTokenOwner

All Known Implementing Classes:
ProjectionViewer, SourceViewer, TextConsoleViewer, TextViewer

public interface IWidgetTokenOwner

In order to display information in a temporary window, a widget token must be acquired. 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. This concept is used by the ITextViewer.

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

  • IWidgetTokenOwnerExtension since version 3.0 introducing priorities when requesting a widget token and thus replacing the non-prioritized scheme.

See Also:

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


boolean requestWidgetToken(
IWidgetTokenKeeper requester)
Requests the widget token from this token owner. Returns true if the token has been acquired or is already owned by the requester. This method is non-blocking.

Replaced by IWidgetTokenOwnerExtension.requestWidgetToken(IWidgetTokenKeeper, int).

requester - the token requester
true if requester acquires the token, false otherwise


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.

tokenKeeper - the token keeper

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