/******************************************************************************* * Copyright (c) 2000, 2004 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Common Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/cpl-v10.html * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.eclipse.jface.text; /** * Extension interface to IWidgetTokenOwner. Replaces the original * requestWidgetToken functionality with a new priority based approach. * * @since 3.0 */ public interface IWidgetTokenOwnerExtension { /** * 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. * *

priority is forwarded to any existing token keeper * to give it an estimate on whether the request has higher priority than * the current keeper's. There is, however, no guarantee that another keeper * will release the token even if it has a high priority.

* * @param requester the token requester * @param priority the priority of the request * @return true if requester aquires the token, * false otherwise */ boolean requestWidgetToken(IWidgetTokenKeeper requester, int priority); }