org.eclipse.xtext.ui.refactoring.ui
Class RenameRefactoringPopup

java.lang.Object
  extended by org.eclipse.xtext.ui.refactoring.ui.RenameRefactoringPopup
All Implemented Interfaces:
org.eclipse.jface.text.IWidgetTokenKeeper, org.eclipse.jface.text.IWidgetTokenKeeperExtension

public class RenameRefactoringPopup
extends java.lang.Object
implements org.eclipse.jface.text.IWidgetTokenKeeper, org.eclipse.jface.text.IWidgetTokenKeeperExtension

Author:
Holger Schill - Initial contribution and API

Nested Class Summary
protected  class RenameRefactoringPopup.PopupVisibilityManager
           
 
Constructor Summary
RenameRefactoringPopup(XtextEditor editor, RenameRefactoringController controller)
           
 
Method Summary
 void close()
           
 void open()
           
 boolean ownsFocusShell()
           
 boolean requestWidgetToken(org.eclipse.jface.text.IWidgetTokenOwner owner)
          The given widget token owner requests the widget token from this token keeper.
 boolean requestWidgetToken(org.eclipse.jface.text.IWidgetTokenOwner owner, int priority)
          The given widget token owner requests the widget token from this token keeper.
 boolean setFocus(org.eclipse.jface.text.IWidgetTokenOwner owner)
          Requests the receiver to give focus to its popup shell, hover, or similar.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RenameRefactoringPopup

public RenameRefactoringPopup(XtextEditor editor,
                              RenameRefactoringController controller)
Method Detail

open

public void open()

requestWidgetToken

public boolean requestWidgetToken(org.eclipse.jface.text.IWidgetTokenOwner owner,
                                  int priority)
Description copied from interface: org.eclipse.jface.text.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.

Specified by:
requestWidgetToken in interface org.eclipse.jface.text.IWidgetTokenKeeperExtension
Parameters:
owner - the token owner
priority - the priority of the request
Returns:
true if token has been released false otherwise

setFocus

public boolean setFocus(org.eclipse.jface.text.IWidgetTokenOwner owner)
Description copied from interface: org.eclipse.jface.text.IWidgetTokenKeeperExtension
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.

Specified by:
setFocus in interface org.eclipse.jface.text.IWidgetTokenKeeperExtension
Parameters:
owner - the token owner
Returns:
true if the receiver tried to take focus, false if it did not.

requestWidgetToken

public boolean requestWidgetToken(org.eclipse.jface.text.IWidgetTokenOwner owner)
Description copied from interface: org.eclipse.jface.text.IWidgetTokenKeeper
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).

Specified by:
requestWidgetToken in interface org.eclipse.jface.text.IWidgetTokenKeeper
Parameters:
owner - the token owner
Returns:
true if token has been released false otherwise

ownsFocusShell

public boolean ownsFocusShell()

close

public void close()