blob: 53e11835db76b40ff720442ab0a55379dcc10633 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
|
/*******************************************************************************
* Copyright (c) 2000, 2005 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jface.text;
/**
* Extension interface for {@link org.eclipse.jface.text.IWidgetTokenKeeper}.
* <p>
* Replaces the original <code>requestWidgetToken</code> 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 <code>true</code> if the token is released
* by this token keeper. Note, the keeper must not call
* <code>releaseWidgetToken(IWidgetTokenKeeper)</code> explicitly.
*
* <p>The general contract is that the receiver should release the token
* if <code>priority</code> exceeds the receiver's priority.</p>
*
* @param owner the token owner
* @param priority the priority of the request
* @return <code>true</code> if token has been released <code>false</code> 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 <code>true</code> if the receiver tried to take focus, <code>false</code> if it did not.
*/
boolean setFocus(IWidgetTokenOwner owner);
}
|
