Document Setup

Identifier:
org.eclipse.core.filebuffers.documentSetup

Since:
3.0

Description:
This extension point is used to customize the initialization process of a document for a text file buffer manager by this plug-in's default text file buffer manager. It allows to specify which document setup participant should be involved in the initialization process for a text file buffer created for a certain file content type, file extension, or file name.

Note: Participants have to be aware of the existence of other participants i.e. they should always setup a document in a way that does not interfere with others. E.g., when a participant wants to install partitioning on the document, it must use the org.eclipse.jface.text.IDocumentExtension3 API and choose a unique partitioning id. As of 3.2, a warning is written to the log file if this isn't followed.

Configuration Markup:

<!ELEMENT extension (participant)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT participant EMPTY>

<!ATTLIST participant

class         CDATA #REQUIRED

extensions    CDATA #IMPLIED

fileNames     CDATA #IMPLIED

contentTypeId CDATA #IMPLIED>

The specification of a document setup participant. In order find all participants for a given file the attributes of each participant specification are consulted in the following sequence: contentTypeId, fileNames, extensions. If multiple participants are found, the sequence in which they are called is not specified.



Examples:

   <extension
         id="JavaDocumentSetupParticipant"
         name="%javaDocumentSetupParticipant"
         point="org.eclipse.core.filebuffers.documentSetup">
      <participant
            extensions="java"
            class="org.eclipse.jdt.internal.ui.javaeditor.JavaDocumentSetupParticipant">
      </participant>
   </extension>

API Information:
Document setup participants have to implement org.eclipse.core.filebuffers.IDocumentSetupParticipant.


Copyright (c) 2001, 2006 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html