Class Reconciler
- java.lang.Object
-
- org.eclipse.jface.text.reconciler.AbstractReconciler
-
- org.eclipse.jface.text.reconciler.Reconciler
-
- All Implemented Interfaces:
IReconciler,IReconcilerExtension
public class Reconciler extends AbstractReconciler implements IReconcilerExtension
Standard implementation ofIReconciler. 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.
- See Also:
IDocumentListener,ITextInputListener,DirtyRegion
-
-
Constructor Summary
Constructors Constructor Description Reconciler()Creates a new reconciler with the following configuration: it is an incremental reconciler with a standard delay of 500 milliseconds.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetDocumentPartitioning()Returns the partitioning this reconciler is using.IReconcilingStrategygetReconcilingStrategy(String contentType)Returns the reconciling strategy registered with the reconciler for the specified content type.protected voidinitialProcess()This method is called on startup of the background activity.protected voidprocess(DirtyRegion dirtyRegion)Processes a dirty region.protected voidreconcilerDocumentChanged(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.voidsetDocumentPartitioning(String partitioning)Sets the document partitioning for this reconciler.voidsetProgressMonitor(IProgressMonitor monitor)Sets the progress monitor of this reconciler.voidsetReconcilingStrategy(IReconcilingStrategy strategy, String contentType)Registers a given reconciling strategy for a particular content type.-
Methods inherited from class org.eclipse.jface.text.reconciler.AbstractReconciler
aboutToBeReconciled, forceReconciling, getDocument, getProgressMonitor, getTextViewer, install, isIncrementalReconciler, isRunningInReconcilerThread, reconcilerReset, setDelay, setIsAllowedToModifyDocument, setIsIncrementalReconciler, startReconciling, uninstall
-
-
-
-
Constructor Detail
-
Reconciler
public 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 partitioningIDocumentExtension3.DEFAULT_PARTITIONING.
-
-
Method Detail
-
setDocumentPartitioning
public void setDocumentPartitioning(String partitioning)
Sets the document partitioning for this reconciler.- Parameters:
partitioning- the document partitioning for this reconciler- Since:
- 3.0
-
getDocumentPartitioning
public String getDocumentPartitioning()
Description copied from interface:IReconcilerExtensionReturns the partitioning this reconciler is using.- Specified by:
getDocumentPartitioningin interfaceIReconcilerExtension- Returns:
- the partitioning this reconciler is using
-
setReconcilingStrategy
public void setReconcilingStrategy(IReconcilingStrategy strategy, String contentType)
Registers 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.- Parameters:
strategy- the reconciling strategy to register, ornullto remove an existing onecontentType- the content type under which to register
-
getReconcilingStrategy
public IReconcilingStrategy getReconcilingStrategy(String contentType)
Description copied from interface:IReconcilerReturns the reconciling strategy registered with the reconciler for the specified content type.- Specified by:
getReconcilingStrategyin interfaceIReconciler- Parameters:
contentType- the content type for which to determine the reconciling strategy- Returns:
- the reconciling strategy registered for the given content type, or
nullif there is no such strategy
-
process
protected void process(DirtyRegion dirtyRegion)
Processes a dirty region. If the dirty region isnullthe 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.- Specified by:
processin classAbstractReconciler- Parameters:
dirtyRegion- the dirty region to be processed- See Also:
AbstractReconciler.process(DirtyRegion)
-
reconcilerDocumentChanged
protected void reconcilerDocumentChanged(IDocument document)
Description copied from class:AbstractReconcilerHook 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.- Specified by:
reconcilerDocumentChangedin classAbstractReconciler- Parameters:
document- the new reconciler document
-
setProgressMonitor
public void setProgressMonitor(IProgressMonitor monitor)
Description copied from class:AbstractReconcilerSets the progress monitor of this reconciler.- Overrides:
setProgressMonitorin classAbstractReconciler- Parameters:
monitor- the monitor to be used
-
initialProcess
protected void initialProcess()
Description copied from class:AbstractReconcilerThis 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.- Overrides:
initialProcessin classAbstractReconciler
-
-