schema.documentCreation.exsd Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.core.filebuffers Show documentation
File Buffers
The newest version!




      
         
      
      
         This extension point is used to customize the document creation behavior of this plug-in's default text file buffer manager. It allows to specify which document factory should be used in order to create the document instance of a text file buffer created for a certain file content type, file extension, or file name.
<br>
<br>
<h6 class=CaptionFigColumn id=header>Deprecated since 3.2: </h6> This extension must no longer be used. We urge existing clients to remove their contribution:
<ul>
<li>the file buffer manager now provides an <code>ISynchronizable</code> document. Clients which need a synchronized document can set a lock object. <em>To overwrite an existing lock object is considered bad practice and can break other clients: if the document already has a lock object set then this one should be used by the client</em>.</li>
<li>clients which need a different <code>org.eclipse.jface.text.IDocument</code> implementation create the corresponding document in their document provider. The custom document will wrap the document provided by the file buffer.</li>
</ul>
      
   

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

   
      
         
            The specification of a document factory. In order to find a factory for a given file the attributes of each factory specification are consulted in the following sequence: contentTypeId, fileNames, extensions. If multiple, equally specific factory specifications are found for a given file it is not specified which factory is used.
         
      
      
         
            
               
                  a fully qualified name of the factory implementation class. This class must implement the <code>org.eclipse.core.filebuffers.IDocumentFactory</code> interface.
               
               
                  
               
            
         
         
            
               
                  a comma separated list of file extensions for which this factory should be used
               
            
         
         
            
               
                  a comma separated list of file names for which this factory should be used
               
            
         
         
            
               
                  the id of a content type as defined by the <code>org.eclipse.core.runtime.contentTypes</code> extension point for which this factory should be used
               
            
         
      
   

   
      
         
      
      
         3.0
      
   

   
      
         
      
      
         <pre>
<extension
     id="org.eclipse.jdt.debug.ui.SnippetDocumentFactory"
     name="%snippetDocumentFactory.name"
     point="org.eclipse.core.filebuffers.documentCreation">
  <factory
        extensions="jpage"
        class="org.eclipse.jdt.internal.debug.ui.snippeteditor.SnippetDocumentFactory">
  </factory>
</extension>
</pre>
      
   

   
      
         
      
      
         Document factories have to implement org.eclipse.core.filebuffers.IDocumentFactory.
      
   

   
      
         
      
      
         
      
   

   
      
         
      
      
         Copyright (c) 2001, 2006 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