Document Providers

Identifier:

org.eclipse.ui.editors.documentProviders

Since:

3.0 (originally named org.eclipse.ui.documentProviders)

Description:

This extension point is used to define mappings between file types and document providers or between types of editor inputs and document providers that can be used by editors. Document providers must implement the interface org.eclipse.ui.texteditor.IDocumentProvider. Editor inputs must be instance of org.eclipse.ui.IEditorInput.

Configuration Markup:

<!ELEMENT extension (provider+)>

<!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 provider EMPTY>

<!ATTLIST provider

extensions CDATA #IMPLIED

inputTypes CDATA #IMPLIED

class CDATA #REQUIRED

id CDATA #REQUIRED>

extensions - a comma separated list of file extensions
inputTypes - a comma separated list of qualified editor input class names
class - the qualified name of the document provider class
id - the unique id of this provider

Examples:


<extension point="org.eclipse.ui.editors.documentProviders"> 
    <provider 
        extensions="jav" 
        class="org.eclipse.ui.examples.javaeditor.JavaDocumentProvider" 
        id="org.eclipse.ui.examples.javaeditor.JavaDocumentProvider"> 
    </provider> 
</extension>

This example registers org.eclipse.ui.examples.javaeditor.JavaDocumentProvider as the default provider for files with the extension ".jav".


<extension point="org.eclipse.ui.editors.documentProviders"> 
    <provider 
        inputTypes="org.eclipse.ui.IStorageEditorInput" 
        class="org.eclipse.ui.editors.text.FileDocumentProvider" 
        id="org.eclipse.ui.editors.text.FileDocumentProvider"> 
    </provider> 
</extension>

This example registers org.eclipse.ui.editors.text.FileDocumentProvider as the default provider for all editor inputs that are instance of org.eclipse.ui.IStorageEditorInput.

API Information:

Document providers registered for a file extension have precedence over those registered for input types. Document providers must implement the interface org.eclipse.ui.texteditor.IDocumentProvider. Editor inputs must be instance of org.eclipse.ui.IEditorInput.

Copyright (c) 2001, 2009 IBM Corporation 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