KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > core > filebuffers > IDocumentSetupParticipant


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.core.filebuffers;
12
13
14 import org.eclipse.jface.text.IDocument;
15
16
17 /**
18  * Participates in the setup of a text file buffer document.
19  * <p>
20  * This interface is the expected interface for extensions provided for the
21  * <code>"org.eclipse.core.filebuffers.documentSetup"</code> extension point.
22  * <p>
23  * Participants have to be aware of the existence of other participants. I.e.
24  * they should always setup a document in a way that does not interfere with
25  * others. E.g., when a participant wants to install partitioning on the
26  * document, it must use the
27  * {@link org.eclipse.jface.text.IDocumentExtension3} API and choose a unique
28  * partitioning id.
29  *
30  * @since 3.0
31  * @see org.eclipse.jface.text.IDocumentExtension3
32  */
33 public interface IDocumentSetupParticipant {
34
35     /**
36      * Sets up the document to be ready for use by a text file buffer.
37      *
38      * @param document the document to be set up
39      */
40     void setup(IDocument document);
41 }
42
Popular Tags