org.eclipse.jface.text.IWidgetTokenKeeperExtension Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.jface.text Show documentation

This is org.eclipse.jface.text jar used by Scout SDK

There is a newer version: 3.11.0.v20160505-1301

Show newest version

/*******************************************************************************
 * Copyright (c) 2000, 2005 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jface.text;

/**
 * Extension interface for {@link org.eclipse.jface.text.IWidgetTokenKeeper}.
 * 
 * Replaces the original requestWidgetToken functionality with a
 * new priority based approach. Adds the concept of focus handling.
 *
 * @since 3.0
 */
public interface IWidgetTokenKeeperExtension {

	/**
	 * 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.
	 *
	 * @param owner the token owner
	 * @param priority the priority of the request
	 * @return true if token has been released false otherwise
	 */
	boolean requestWidgetToken(IWidgetTokenOwner owner, int priority);

	/**
	 * 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.
	 *
	 * @param owner the token owner
	 * @return true if the receiver tried to take focus, false if it did not.
	 */
	boolean setFocus(IWidgetTokenOwner owner);
}