Eclipse Platform
2.1

org.eclipse.jface.text
Interface ISlaveDocumentManager

All Known Implementing Classes:
ChildDocumentManager

public interface ISlaveDocumentManager

Slave documents are documents that use a text store which is based on a master document.

Since:
2.1

Method Summary
 IDocumentInformationMapping createMasterSlaveMapping(IDocument slave)
          Creates a new mapping between the given slave document and its master.
 IDocument createSlaveDocument(IDocument master)
          Creates a new slave document for the given master document.
 void freeSlaveDocument(IDocument slave)
          Frees the given slave document.
 IDocument getMasterDocument(IDocument slave)
          Returns the master of the given slave document.
 boolean isSlaveDocument(IDocument document)
          Method isSlaveDocument.
 void setAutoExpandMode(IDocument slave, boolean autoExpand)
          Sets the given document's auto expand mode.
 

Method Detail

createSlaveDocument

public IDocument createSlaveDocument(IDocument master)
Creates a new slave document for the given master document.

Parameters:
master -
Returns:
IDocument

freeSlaveDocument

public void freeSlaveDocument(IDocument slave)
Frees the given slave document.

Parameters:
slave -

createMasterSlaveMapping

public IDocumentInformationMapping createMasterSlaveMapping(IDocument slave)
Creates a new mapping between the given slave document and its master.

Returns:
IDocumentInformationMapping

getMasterDocument

public IDocument getMasterDocument(IDocument slave)
Returns the master of the given slave document.

Parameters:
slave -
Returns:
IDocument

isSlaveDocument

public boolean isSlaveDocument(IDocument document)
Method isSlaveDocument.

Parameters:
document -
Returns:
boolean

setAutoExpandMode

public void setAutoExpandMode(IDocument slave,
                              boolean autoExpand)
Sets the given document's auto expand mode. In auto expand mode, a slave is expanded to include all of the master document affected by document changes.

Parameters:
slave - the slave whose auto expand mode should be set
autoExpand - the mode

Eclipse Platform
2.1

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.