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
Interface IWidgetTokenKeeper

All Known Implementing Classes:
ContentAssistant, InformationPresenter, SubjectControlContentAssistant

public interface IWidgetTokenKeeper

A widget token keeper may require a widget token from an IWidgetTokenOwner and release the token to the owner after usage. A widget token owner may request the token from the token keeper. The keeper may deny the return of the token.

The widget token owner and keeper interplay is used by a text viewer in order to manage the appearance and disappearance of addition, on-top popup windows such as text hovers, content assist, etc. In order to provide backward compatibility for clients of IWidgetTokeKeeper, extension interfaces are used as a means of evolution. The following extension interfaces exist:

  • IWidgetTokenKeeperExtension since version 3.0 introducing priorities when requesting a widget token and thus replacing the non-prioritized scheme. It also allows a client to force a widget token keeper to accept focus.

Since:
2.0
See Also:
IWidgetTokenKeeperExtension

Method Summary
 boolean requestWidgetToken ( IWidgetTokenOwner owner)
          The given widget token owner requests the widget token from this token keeper.
 

Method Detail

requestWidgetToken

boolean requestWidgetToken(
IWidgetTokenOwner owner)
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.

Replaced by IWidgetTokenKeeperExtension.requestWidgetToken(IWidgetTokenOwner, int).

Parameters:
owner - the token owner
Returns:
true if token has been released false otherwise

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