schema.uriSchemeHandlers.exsd Maven / Gradle / Ivy

Go to download




      
         
      
      
         <p>
This extension point is used to add implementations of URI scheme handlers. The term URI scheme refers to the definition in <a href="https://tools.ietf.org/html/rfc3986" target="_external">RFC 3986</a>.
An URI schema (the part before the colon) defines the context and thus defines the type of URI, which determines the interpretation of the following part. Examples of popular schemes include <code>https</code>, <code>mailto</code>, <code>file</code>, <code>data</code>, and <code>irc</code>.
Custom URI schemes can be used to trigger processing inside an application - so this extension point allow plug-in developers to add handlers for their custom URI scheme.
</p>
<p>
The identifing key of such a handler is the URI scheme name. If multiple handlers are registered for the same URI scheme the first found handler is called. The order of the handlers in undefined.
</p>
<!-- Add details about the preference page once it is available-->
      
   

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

   
      
         
            <p>Associates an URI scheme with a hander implementation.</p>
         
      
      
         
            
               
                  The URI scheme name.
               
            
         
         
            
               
                  A human readable description of the URI scheme.
               
               
                  
               
            
         
         
            
               
                  The fully qualified name of the handler class implementing <code>org.eclipse.urischeme.IUriSchemeHandler</code>.
               
               
                  
               
            
         
      
   

   
      
         
      
      
         4.9
      
   

   
      
         
      
      
         <p>
The following defines a handler for the <code>hello</code> protocol.
</p>
<pre>
 <extension
       point="org.eclipse.ui.uriSchemeHandlers">
    <uriSchemeHandler
          class="org.eclipse.ui.examples.urischemehandler.listeners.HelloListener"
          uriSchemeDescription="The Hello World demo protocol"
          uriScheme="hello">
    </uriSchemeHandler>
 </extension>
</pre>
      
   

   
      
         
      
      
         <p>
The value of the <code>class</code> attribute must be the fully qualified name of a class that implements the<code>org.eclipse.swt.widgets.Listener</code> interface.
</p>
<p>
Handlers are called in the user interface thread when it free for the next time. Handler implementations should not perform long running tasks in the user interface thread.
</p>
      
   

   
      
         
      
      
         <p>
There is no productive implementation provided. An example can be found in the org.eclipse.ui.examples.uriSchemeHandler plug-in.
</p>
      
   

   
      
         
      
      
         Copyright (c) 2002, 2007 IBM Corporation and others.<br>

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