public interface IQuickDiffReferenceProvider
IDocument
) that is used as the original against which
diff information is generated.
Extensions to the extension point quickdiff.referenceprovider
have to implement
this interface (plus another interface for plug-in and UI management.
Modifier and Type | Method and Description |
---|---|
void |
dispose()
Called when the reference is no longer used and the provider can free resources.
|
String |
getId()
Returns the id of this reference provider.
|
IDocument |
getReference(IProgressMonitor monitor)
Returns the reference document for the quick diff display.
|
boolean |
isEnabled()
Gives the implementation a hook to publish its enablement.
|
void |
setActiveEditor(ITextEditor editor)
Sets the active editor for the provider implementation.
|
void |
setId(String id)
Sets the id of this implementation.
|
IDocument getReference(IProgressMonitor monitor) throws CoreException
monitor
- a preference monitor to monitor / cancel the process, or null
null
if getting the
document was canceled or there is no reference available.CoreException
- if getting the document fails.void dispose()
String getId()
void setActiveEditor(ITextEditor editor)
editor
- the active editor.boolean isEnabled()
false
if the implementation cannot be executed, true
if it can,
or if it cannot be decided yet.void setId(String id)
id
will be set to the Id
attribute specified in the extension's
declaration.id
- the provider's new id.
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.