---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help		Eclipse Platform Release 3.5
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR |  METHOD	DETAIL: FIELD | CONSTR |  METHOD

---

org.eclipse.core.filebuffers
Interface IDocumentSetupParticipant

---

public interface IDocumentSetupParticipant

Participates in the setup of a text file buffer document.

This interface is the expected interface for extensions provided for the "org.eclipse.core.filebuffers.documentSetup" extension point.

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 IDocumentExtension3 API and choose a unique partitioning id.

In order to provide backward compatibility for clients of IDocumentSetupParticipant, extension interfaces are used to provide a means of evolution. The following extension interfaces exist:

• IDocumentSetupParticipantExtension since version 3.4 introducing the concept of rewrite sessions. .

Since:

3.0

See Also:

IDocumentExtension3, IDocumentSetupParticipantExtension

---

Method Summary
void	setup ( IDocument document)           Sets up the document to be ready for use by a text file buffer.

 

Method Detail

setup

void setup(
IDocument document)

Sets up the document to be ready for use by a text file buffer.

Parameters:

document - the document to be set up

---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help		Eclipse Platform Release 3.5
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR |  METHOD	DETAIL: FIELD | CONSTR |  METHOD

---

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.