public interface ISlaveDocumentManager
A slave document manager creates slave documents for given master documents, manages the life cycle of the slave documents, and keeps track of the information flow between master and slave documents. The slave document manager defines the construction rules of the slave documents in terms of the master document.
In order to provided backward compatibility for clients of ISlaveDocumentManager
, extension
interfaces are used to provide a means of evolution. The following extension interfaces
exist:
ISlaveDocumentManagerExtension
since version 3.0 extending the protocol
with an access to all managed slave document for a given master document. IDocument
Modifier and Type | Method and Description |
---|---|
IDocumentInformationMapping |
createMasterSlaveMapping(IDocument slave)
Creates a new document information mapping between the given slave document and
its master document.
|
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 document of the given slave document or
null if the
given document is unknown to this slave document manager. |
boolean |
isSlaveDocument(IDocument document)
Returns whether the given document is a slave document known to this slave document manager.
|
void |
setAutoExpandMode(IDocument slave,
boolean autoExpand)
Sets the given slave document's auto expand mode.
|
IDocument createSlaveDocument(IDocument master)
freeSlaveDocument
is called. The connection between the newly created slave document and the master
document is managed by this slave document manager.master
- the master documentfreeSlaveDocument(IDocument)
void freeSlaveDocument(IDocument slave)
createSlaveDocument
.slave
- the slave document to be freedcreateSlaveDocument(IDocument)
IDocumentInformationMapping createMasterSlaveMapping(IDocument slave)
null
if the given document is unknown
to this slave document manager.slave
- the slave documentnull
IDocument getMasterDocument(IDocument slave)
null
if the
given document is unknown to this slave document manager.slave
- the slave documentnull
boolean isSlaveDocument(IDocument document)
document
- the document to be checked whether it is a slave document known to this managertrue
if the document is a slave document, false
otherwisevoid setAutoExpandMode(IDocument slave, boolean autoExpand)
This call is without effect if the given document is unknown to this slave document manager.
slave
- the slave whose auto expand mode should be setautoExpand
- true
for auto expand, false
otherwise
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.