将操作悬停在 Eclipse 中自己的注释上（插件）

Question

我创建了一个使用自己的注释标记的插件。现在，当我将鼠标悬停在这个特殊标记上时，我想添加一个特殊的悬停操作。我真的不知道在哪里添加这个动作。我已经阅读了有关 IAnnotationHover 界面的内容，但是如何访问普通工作台文本编辑器的垂直标尺来添加/更改 AnnotationHover？

ps：更准确地说，我使用 Eclipse 的通用编辑器，而不是自己的编辑器...所以我认为我不应该覆盖 SourceViewerConfiguration 或 IAnnotationHover 到目前为止有什么想法吗？

Answer 1

这是在默认 Java 编辑器上创建自定义悬停的一种方法。

这是针对您的特定用例的 @PKeidel 的 LangHover 类的自定义实现，结合 用于检测 java 元素的自定义脚本。请注意，您应该将 ANNOTATION_NAME 的值更改为自定义注释的值，并将 getHoverInfo 的返回值更改为您希望自定义悬停包含的任何内容。

public class LangHover implements IJavaEditorTextHover
{
    public static final String ANNOTATION_NAME = "YourCustomAnnotation";

    @SuppressWarnings("restriction")
    public static ICodeAssist getCodeAssist(IEditorPart fEditor)
    {
        if (fEditor != null) {
            IEditorInput input= fEditor.getEditorInput();
            if (input instanceof IClassFileEditorInput) {
                IClassFileEditorInput cfeInput= (IClassFileEditorInput) input;
                return cfeInput.getClassFile();
            }

            WorkingCopyManager manager= JavaPlugin.getDefault().getWorkingCopyManager();
            return manager.getWorkingCopy(input, false);
        }

        return null;
    }

    public static IEditorPart getActiveEditor()
    {
        IWorkbenchWindow window= PlatformUI.getWorkbench().getActiveWorkbenchWindow();
        if (window != null) {
            IWorkbenchPage page= window.getActivePage();
            if (page != null) {
                return page.getActiveEditor();
            }
        }
        return null;
    } 

    // When this returns true, the custom hover should be shown.
    public static boolean elementIsCustomAnnotation(ITextViewer textViewer, IRegion hoverRegion)
    {
        IEditorPart activeEditor = getActiveEditor();
        ICodeAssist resolve = getCodeAssist(activeEditor);
        IJavaElement[] detectedJavaElements = null;

        if (resolve != null)
        {
            try
            {
                detectedJavaElements = resolve.codeSelect(hoverRegion.getOffset(), hoverRegion.getLength());
            }
            catch (JavaModelException x)
            {
                System.out.println("JavaModelException occured");
            }
        }

        for (IJavaElement javaElement : detectedJavaElements)
        {
            // If I found an element of type IJavaElement.ANNOTATION
            // and its name equals ANNOTATION_NAME, return true
            if (javaElement.getElementType() == IJavaElement.ANNOTATION && javaElement.getElementName().equals(ANNOTATION_NAME))
            {
                return true;
            }
        }
        return false;           
    }

    @Override
    public String getHoverInfo(ITextViewer textviewer, IRegion region)
    {
        if(elementIsCustomAnnotation(textviewer, region))
        {
            return "Your own hover text goes here"";
        }
        return null; // Shows the default Hover (Java Docs)
    }
}

基本上，这里发生的事情是 elementIsCustomAnnotation 正在检查用户悬停在其上的 java 元素，将它们放入 DetectedJavaElements 数组中，然后检查该数组以查找名称等于 ANNOTATION_NAME 的注释。