Standard implementation of
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.
Constructor SummaryConstructorDescriptionCreates a new reconciler with the following configuration: it is an incremental reconciler with a standard delay of 500 milliseconds.
Method SummaryModifier and TypeMethodDescriptionReturns the partitioning this reconciler is using.Returns the reconciling strategy registered with the reconciler for the specified content type.
protected voidThis method is called on startup of the background activity.
voidInstalls the reconciler on the given text viewer.
protected voidProcesses a dirty region.
protected voidHook 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.
voidSets the document partitioning for this reconciler.
voidSets the progress monitor of this reconciler.
voidRegisters a given reconciling strategy for a particular content type.
voidRemoves the reconciler from the text viewer it has previously been installed on.
Methods inherited from class org.eclipse.jface.text.reconciler.AbstractReconciler
aboutToBeReconciled, aboutToWork, forceReconciling, getDocument, getProgressMonitor, getTextViewer, isIncrementalReconciler, isRunningInReconcilerThread, reconcilerReset, setDelay, setIsAllowedToModifyDocument, setIsIncrementalReconciler, signalWaitForFinish, startReconciling
Reconcilerpublic Reconciler()Creates a new reconciler with the following configuration: it is an incremental reconciler with a standard delay of 500 milliseconds. There are no predefined reconciling strategies. The partitioning it uses is the default partitioning
setDocumentPartitioningpublic void setDocumentPartitioning
(String partitioning)Sets the document partitioning for this reconciler.
partitioning- the document partitioning for this reconciler
getDocumentPartitioningpublic String getDocumentPartitioning()Description copied from interface:
IReconcilerExtensionReturns the partitioning this reconciler is using.
setReconcilingStrategyRegisters a given reconciling strategy for a particular content type. If there is already a strategy registered for this type, the new strategy is registered instead of the old one.
strategy- the reconciling strategy to register, or
nullto remove an existing one
contentType- the content type under which to register
getReconcilingStrategyReturns the reconciling strategy registered with the reconciler for the specified content type.
processprotected void process
(DirtyRegion dirtyRegion)Processes a dirty region. If the dirty region is
nullthe 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.
reconcilerDocumentChangedprotected 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. Usually, subclasses use this hook to inform all their reconciling strategies about the change.
installpublic void install
(ITextViewer textViewer)Installs the reconciler on the given text viewer. After this method has been finished, the reconciler is operational, i.e., it works without requesting further client actions until
uninstallpublic void uninstall()Removes the reconciler from the text viewer it has previously been installed on.
setProgressMonitorpublic void setProgressMonitor
(IProgressMonitor monitor)Sets the progress monitor of this reconciler.
initialProcessprotected void initialProcess()This method is called on startup of the background activity. It is called only once during the life time of the reconciler. Clients may reimplement this method.