Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added refactorings to editor context and quick menus (see #1000097)
- Loading branch information
Showing
3 changed files
with
96 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
78 changes: 78 additions & 0 deletions
78
org.scala-ide.sdt.core/src/scala/tools/eclipse/refactoring/RefactoringMenu.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| /* | ||
| * Copyright (c) 2011 Fabian Steeg. All rights reserved. This program and the accompanying materials | ||
| * are made available under the terms of the Scala License which accompanies this distribution, and | ||
| * is available at http://www.scala-lang.org/node/146 | ||
| */ | ||
| package scala.tools.eclipse.refactoring | ||
|
|
||
| import org.eclipse.ui.handlers.IHandlerService | ||
| import org.eclipse.ui.commands.{ ICommandService, IHandler } | ||
| import org.eclipse.ui.part.EditorPart | ||
| import org.eclipse.core.commands.Command | ||
| import org.eclipse.jface.action.{ Action, IAction, IMenuManager, IMenuListener, ActionContributionItem } | ||
| import org.eclipse.jdt.internal.ui.javaeditor.JavaEditor | ||
| import org.eclipse.jdt.internal.ui.actions.JDTQuickMenuCreator | ||
|
|
||
| /** | ||
| * Unfortunately, it seems we cannot simply define a context menu on the Scala source editor via | ||
| * plugin.xml for the refactorings, as the editor is a CompilationUnitEditor, which controls our | ||
| * editor's context menu. Stuff we add in plugin.xml is programmatically changed internally in | ||
| * CompilationUnitEditor. So instead, we add our refactorings to the context and quick menus | ||
| * programmatically after CompilationUnitEditor, using the commands declared in plugin.xml. | ||
| * | ||
| * @author Fabian Steeg <fsteeg@gmail.com> | ||
| */ | ||
| protected[eclipse] object RefactoringMenu { | ||
|
|
||
| private object Id extends Enumeration { | ||
| val QuickMenu = Value("scala.tools.eclipse.refactoring.commands.quickMenu") | ||
| val ContextMenu = Value("org.eclipse.jdt.ui.refactoring.menu") | ||
| val CommandsCategory = Value("scala.tools.eclipse.refactoring.commands.refactoring") | ||
| type Id = Value; implicit def toString(id: Id.Value) = id.toString | ||
| } | ||
|
|
||
| def fillContextMenu(menu: IMenuManager, editor: EditorPart): Unit = { | ||
| val refactorSubmenu = menu.findMenuUsingPath(Id.ContextMenu) | ||
| /* Add actions in a listener to refill every time RefactorActionGroup's listener empties it for us: */ | ||
| refactorSubmenu.addMenuListener(new IMenuListener() { | ||
| def menuAboutToShow(menu: IMenuManager): Unit = fillFromPluginXml(menu, editor, true) | ||
| }) | ||
| } | ||
|
|
||
| def fillQuickMenu(editor: JavaEditor): Unit = { | ||
| val handler = new JDTQuickMenuCreator(editor) { | ||
| protected def fillMenu(menu: IMenuManager): Unit = fillFromPluginXml(menu, editor, false) | ||
| }.createHandler | ||
| /* Activating our handler here enables the binding specified in plugin.xml, but clears the | ||
| * binding for the context submenu, so the binding does not show up in the context menu. To | ||
| * show the binding to the user, we add the quick menu command to the context submenu, but | ||
| * not to the quick menu (see fillFromPluginXml below). */ | ||
| handlerService(editor).activateHandler(Id.QuickMenu, handler) | ||
| } | ||
|
|
||
| private def fillFromPluginXml(menu: IMenuManager, editor: EditorPart, all: Boolean): Unit = { | ||
|
|
||
| menu.removeAll | ||
| for (command <- refactoringCommandsDefinedInPluginXml) menu.add(wrapped(command)) | ||
|
|
||
| def refactoringCommandsDefinedInPluginXml = { | ||
| val service = commandService(editor) | ||
| val refactoringCategory = service.getCategory(Id.CommandsCategory) | ||
| service.getDefinedCommands.filter((command: Command) => | ||
| command.getCategory == refactoringCategory && (all || command.getId != Id.QuickMenu.toString)) | ||
| } | ||
|
|
||
| def wrapped(command: Command) = new Action { | ||
| setActionDefinitionId(command.getId) // adds the key binding defined for command in plugin.xml | ||
| setText(command.getName) | ||
| setEnabled(command.isEnabled) | ||
| override def run(): Unit = handlerService(editor).executeCommand(command.getId, null) | ||
| } | ||
|
|
||
| } | ||
|
|
||
| private def commandService(editor: EditorPart) = service(classOf[ICommandService], editor) | ||
| private def handlerService(editor: EditorPart) = service(classOf[IHandlerService], editor) | ||
| private def service[T](t: Class[T], e: EditorPart) = e.getEditorSite.getService(t).asInstanceOf[T] | ||
|
|
||
| } |