public class Reconciler extends AbstractReconciler implements IReconcilerExtension
IReconciler
.
The reconciler is configured with a set of reconciling strategies
each of which is responsible for a particular content type.
Usually, clients instantiate this class and configure it before using it.
IDocumentListener
,
ITextInputListener
,
DirtyRegion
Constructor and Description |
---|
Reconciler()
Creates a new reconciler with the following configuration: it is
an incremental reconciler with a standard delay of 500 milliseconds.
|
Modifier and Type | Method and Description |
---|---|
String |
getDocumentPartitioning()
Returns the partitioning this reconciler is using.
|
IReconcilingStrategy |
getReconcilingStrategy(String contentType)
Returns the reconciling strategy registered with the reconciler
for the specified content type.
|
protected void |
initialProcess()
This method is called on startup of the background activity.
|
protected void |
process(DirtyRegion dirtyRegion)
Processes a dirty region.
|
protected void |
reconcilerDocumentChanged(IDocument document)
Hook called when the document whose contents should be reconciled
has been changed, i.e., the input document of the text viewer this
reconciler is installed on.
|
void |
setDocumentPartitioning(String partitioning)
Sets the document partitioning for this reconciler.
|
void |
setProgressMonitor(IProgressMonitor monitor)
Sets the progress monitor of this reconciler.
|
void |
setReconcilingStrategy(IReconcilingStrategy strategy,
String contentType)
Registers a given reconciling strategy for a particular content type.
|
aboutToBeReconciled, forceReconciling, getDocument, getProgressMonitor, getTextViewer, install, isIncrementalReconciler, isRunningInReconcilerThread, reconcilerReset, setDelay, setIsAllowedToModifyDocument, setIsIncrementalReconciler, startReconciling, uninstall
public Reconciler()
IDocumentExtension3.DEFAULT_PARTITIONING
.public void setDocumentPartitioning(String partitioning)
partitioning
- the document partitioning for this reconcilerpublic String getDocumentPartitioning()
IReconcilerExtension
getDocumentPartitioning
in interface IReconcilerExtension
public void setReconcilingStrategy(IReconcilingStrategy strategy, String contentType)
strategy
- the reconciling strategy to register, or null
to remove an existing onecontentType
- the content type under which to registerpublic IReconcilingStrategy getReconcilingStrategy(String contentType)
IReconciler
getReconcilingStrategy
in interface IReconciler
contentType
- the content type for which to determine the reconciling strategynull
if there is no such strategyprotected void process(DirtyRegion dirtyRegion)
null
the whole
document is consider being dirty. The dirty region is partitioned by the
document and each partition is handed over to a reconciling strategy registered
for the partition's content type.process
in class AbstractReconciler
dirtyRegion
- the dirty region to be processedAbstractReconciler.process(DirtyRegion)
protected void reconcilerDocumentChanged(IDocument document)
AbstractReconciler
reconcilerDocumentChanged
in class AbstractReconciler
document
- the new reconciler documentpublic void setProgressMonitor(IProgressMonitor monitor)
AbstractReconciler
setProgressMonitor
in class AbstractReconciler
monitor
- the monitor to be usedprotected void initialProcess()
AbstractReconciler
initialProcess
in class AbstractReconciler
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.