---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help		Eclipse Platform Release 3.5
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD |  CONSTR |  METHOD	DETAIL: FIELD |  CONSTR |  METHOD

---

org.eclipse.ui.texteditor.spelling
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
SpellingReconcileStrategy ( ISourceViewer viewer, SpellingService spellingService)           Creates a new comment reconcile strategy.

 

Method Summary
protected   ISpellingProblemCollector	createSpellingProblemCollector ()           Creates a new spelling problem collector.
protected   IAnnotationModel	getAnnotationModel ()           Returns the annotation model to be used by this reconcile strategy.
protected   IContentType	getContentType ()           Returns the content type of the underlying editor input.
protected   IDocument	getDocument ()           Returns the document which is spell checked.
void	initialReconcile ()           Called only once in the life time of this reconciling strategy.
void	reconcile ( DirtyRegion dirtyRegion, IRegion subRegion)           Activates incremental reconciling of the specified dirty region.
void	reconcile ( IRegion region)           Activates non-incremental reconciling.
void	setDocument ( IDocument document)           Tells this reconciling strategy on which document it will work.
void	setProgressMonitor ( IProgressMonitor monitor)           Tells this reconciling strategy with which progress monitor it will work.

 

Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

SpellingReconcileStrategy

public SpellingReconcileStrategy(
ISourceViewer viewer,
                                 
SpellingService spellingService)

Creates a new comment reconcile strategy.

Parameters:

viewer - the source viewer

spellingService - the spelling service to use

Method Detail

initialReconcile

public void initialReconcile()

Description copied from interface: IReconcilingStrategyExtension

Called only once in the life time of this reconciling strategy.

Specified by:

initialReconcile in interface IReconcilingStrategyExtension

---

reconcile

public void reconcile(
DirtyRegion dirtyRegion,
                      
IRegion subRegion)

Description copied from interface: IReconcilingStrategy

Activates 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 of IReconcilingStrategy.setDocument(IDocument).

Specified by:

reconcile in interface IReconcilingStrategy

Parameters:

dirtyRegion - the document region which has been changed

subRegion - the sub region in the dirty region which should be reconciled

---

reconcile

public void reconcile(
IRegion region)

Description copied from interface: IReconcilingStrategy

Activates 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 into IReconcilingStrategy.setDocument(IDocument).

Specified by:

reconcile in interface IReconcilingStrategy

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 null if 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: IReconcilingStrategy

Tells 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:

setDocument in interface IReconcilingStrategy

Parameters:

document - the document on which this strategy will work

---

createSpellingProblemCollector

protected 
ISpellingProblemCollector createSpellingProblemCollector()

Creates a new spelling problem collector.

Returns:

the collector or null if none is available

---

setProgressMonitor

public final void setProgressMonitor(
IProgressMonitor monitor)

Description copied from interface: IReconcilingStrategyExtension

Tells 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:

setProgressMonitor in interface IReconcilingStrategyExtension

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 null if none could be determined

---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help		Eclipse Platform Release 3.5
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD |  CONSTR |  METHOD	DETAIL: FIELD |  CONSTR |  METHOD

---

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.