Class SpellingReconcileStrategy
- java.lang.Object
-
- org.eclipse.ui.texteditor.spelling.SpellingReconcileStrategy
-
- All Implemented Interfaces:
IReconcilingStrategy,IReconcilingStrategyExtension
public class SpellingReconcileStrategy extends Object implements IReconcilingStrategy, IReconcilingStrategyExtension
Reconcile strategy used for spell checking.- Since:
- 3.3
-
-
Constructor Summary
Constructors Constructor Description SpellingReconcileStrategy(ISourceViewer viewer, SpellingService spellingService)Creates a new comment reconcile strategy.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected ISpellingProblemCollectorcreateSpellingProblemCollector()Creates a new spelling problem collector.protected IAnnotationModelgetAnnotationModel()Returns the annotation model to be used by this reconcile strategy.protected IContentTypegetContentType()Returns the content type of the underlying editor input.protected IDocumentgetDocument()Returns the document which is spell checked.voidinitialReconcile()Called only once in the life time of this reconciling strategy.voidreconcile(IRegion region)Activates non-incremental reconciling.voidreconcile(DirtyRegion dirtyRegion, IRegion subRegion)Activates incremental reconciling of the specified dirty region.voidsetDocument(IDocument document)Tells this reconciling strategy on which document it will work.voidsetProgressMonitor(IProgressMonitor monitor)Tells this reconciling strategy with which progress monitor it will work.
-
-
-
Constructor Detail
-
SpellingReconcileStrategy
public SpellingReconcileStrategy(ISourceViewer viewer, SpellingService spellingService)
Creates a new comment reconcile strategy.- Parameters:
viewer- the source viewerspellingService- the spelling service to use
-
-
Method Detail
-
initialReconcile
public void initialReconcile()
Description copied from interface:IReconcilingStrategyExtensionCalled only once in the life time of this reconciling strategy.- Specified by:
initialReconcilein interfaceIReconcilingStrategyExtension
-
reconcile
public void reconcile(DirtyRegion dirtyRegion, IRegion subRegion)
Description copied from interface:IReconcilingStrategyActivates incremental reconciling of the specified dirty region. As a dirty region might span multiple content types, the segment of the dirty region which should be investigated is also provided to this reconciling strategy. The given regions refer to the document passed into the most recent call ofIReconcilingStrategy.setDocument(IDocument).- Specified by:
reconcilein interfaceIReconcilingStrategy- Parameters:
dirtyRegion- the document region which has been changedsubRegion- the sub region in the dirty region which should be reconciled
-
reconcile
public void reconcile(IRegion region)
Description copied from interface:IReconcilingStrategyActivates non-incremental reconciling. The reconciling strategy is just told that there are changes and that it should reconcile the given partition of the document most recently passed intoIReconcilingStrategy.setDocument(IDocument).- Specified by:
reconcilein interfaceIReconcilingStrategy- Parameters:
region- the document partition to be reconciled
-
getContentType
protected IContentType getContentType()
Returns the content type of the underlying editor input.- Returns:
- the content type of the underlying editor input or
nullif none could be determined
-
getDocument
protected final IDocument getDocument()
Returns the document which is spell checked.- Returns:
- the document
-
setDocument
public void setDocument(IDocument document)
Description copied from interface:IReconcilingStrategyTells this reconciling strategy on which document it will work. This method will be called before any other method and can be called multiple times. The regions passed to the other methods always refer to the most recent document passed into this method.- Specified by:
setDocumentin interfaceIReconcilingStrategy- Parameters:
document- the document on which this strategy will work
-
createSpellingProblemCollector
protected ISpellingProblemCollector createSpellingProblemCollector()
Creates a new spelling problem collector.- Returns:
- the collector or
nullif none is available
-
setProgressMonitor
public final void setProgressMonitor(IProgressMonitor monitor)
Description copied from interface:IReconcilingStrategyExtensionTells this reconciling strategy with which progress monitor it will work. This method will be called before any other method and can be called multiple times.- Specified by:
setProgressMonitorin interfaceIReconcilingStrategyExtension- Parameters:
monitor- the progress monitor with which this strategy will work
-
getAnnotationModel
protected IAnnotationModel getAnnotationModel()
Returns the annotation model to be used by this reconcile strategy.- Returns:
- the annotation model of the underlying editor input or
nullif none could be determined
-
-