Hover providers

Identifier:

Since:

Description:

Configuration Markup:

<!ELEMENT extension (hoverProvider+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>

• point - a fully qualified identifier of the target extension point
• id - an optional identifier of the extension instance
• name - an optional name of the extension instance

<!ELEMENT hoverProvider (enabledWhen?)>

<!ATTLIST hoverProvider

id          CDATA #IMPLIED

class       CDATA #REQUIRED

contentType IDREF #REQUIRED

isBefore    IDREF #IMPLIED

isAfter     IDREF #IMPLIED>

• id - A string uniquely identifying this reference provider.
• class - The fully qualified class name implementing the interface org.eclipse.jface.text.ITextHover
• contentType - The target content-type for this extension. Content-types are defined as extension to the org.eclipse.core.contenttype.contentTypes extension point.
• isBefore - The id of a hoverProvider before which to place this contribution. Plan is to have contributions are sorted according to that value and to have only the first one shown (or the the first "compoundable" ones)
• isAfter - The id of a hoverProvider after which to place this contribution. Plan is to have contributions are sorted according to that value and to have only the first one shown (or the the first "compoundable" ones)

<!ELEMENT enabledWhen (not | or | and | instanceof | test | systemTest | equals | count | with | resolve | adapt | iterate | reference)?>

A core Expression that controls the enabled of the given hover provider. The viewer, editor, and editor input are registered in the evaluation context as variable: * : use it if your expression requires the viewer. * : use it if your expression requires the document. * : use it if your expression requires the editor (deprecated, not always set). * : use it if your expression requires the editor input (deprecated, not always set).

Examples:

<extension point="org.eclipse.ui.genericeditor.hoverProviders">
   <hoverProvider
       class="org.eclipse.ui.genericeditor.examples.TargetDefinitionHoverProvider"
       contentType="org.eclipse.pde.targetFile">
      <enabledWhen>
         <with variable="editor">
            <test property="org.eclipse.ui.genericeditor.examples.TargetDefinitionPropertyTester">
            </test>
         </with>
      </enabledWhen>
   </hoverProvider>
</extension>

Copyright (c) 2016 Red Hat Inc. 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-v20.html/ SPDX-License-Identifier: EPL-2.0