schema.hoverProviders.exsd Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.ui.genericeditor Show documentation
Generic and Extensible Text Editor
The newest version!




      
         
      
      
         This extension point is used to contribute hover providers for showing text hovers in a file with a given content type.
      
   

   

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

   
      
         
            
         
         
            
               
                  A string uniquely identifying this reference provider.
               
            
         
         
            
               
                  The fully qualified class name implementing the interface <code>org.eclipse.jface.text.ITextHover</code>
               
               
                  
               
            
         
         
            
               
                  The target content-type for this extension. Content-types are defined as extension to the org.eclipse.core.contenttype.contentTypes extension point.
               
               
                  
               
            
         
         
            
               
                  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)
               
               
                  
               
            
         
         
            
               
                  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)
               
               
                  
               
            
         
      
   

   
      
         
            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:

 * <with variable="viewer"/> : use it if your expression requires the viewer.
 * <with variable="document"/> : use it if your expression requires the document.
 * <with variable="editor"/> : use it if your expression requires the editor (deprecated, not always set).
 * <with variable="editorInput"/> :  use it if your expression requires the editor input (deprecated, not always set).
         
      
      
         
            
            
            
            
            
            
            
            
            
            
            
            
            
         
      
   

   
      
         
      
      
         1.0
      
   

   
      
         
      
      
         Below is an example using the hover provider extension point:

<pre>
<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>
</pre>
      
   



   
      
         
      
      
         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 <a href="https://www.eclipse.org/legal/epl-2.0">https://www.eclipse.org/legal/epl-v20.html</a>/

SPDX-License-Identifier: EPL-2.0