public interface ISharedDocumentAdapter
ISharedDocumentAdapter is used to map an
ITypedElement to a shared document for the purposes of editing.
Method SummaryModifier and TypeMethodDescription
voidConnect the given element to its document provider.
voidDisconnect the element from the document provider.
(IDocumentProvider provider, IEditorInput documentKey, IDocument document, boolean overwrite)Flush the contents of the given document into the typed element that provided the document.
getDocumentKeyReturn the object that is to be used as the key for retrieving the appropriate
DocumentProviderRegistryand for obtaining the shared
IDocumentfrom the document provider. Returns
nullif the element does not have a shared document.
element- the element being queried for a shared document
- the object that acts as the key to obtain a document provider and
connectConnect the given element to its document provider. All connections must be performed through this adapter so that the adapter can track whether it is connected or not.
disconnectDisconnect the element from the document provider. All connects and disconnects must occur through the adapter so that the adapter can track whether it is connected or not.
(Object element)A helper disconnect method that looks up the appropriate key (using
getDocumentKey(Object)and the appropriate provider and calls
element- the element that was used to previously connect to a document
- See Also:
(IDocumentProvider provider, IEditorInput documentKey, IDocument document, boolean overwrite) throws CoreExceptionFlush the contents of the given document into the typed element that provided the document. This method is invoked by the Compare framework classes when a request to flush the viewers has been made. It is up to the implementor to decide whether the changes in the buffer should be saved to disk at the time of the flush or buffered to be saved at a later time.
provider- the document provider
documentKey- the element's key returned from
document- the document
overwrite- indicates whether overwrite should be performed while saving the given element if necessary
CoreException- if document could not be stored to the given element
- See Also: