Class EditorWorkingCopyReconciler
java.lang.Object
org.eclipse.jface.text.reconciler.AbstractReconciler
org.eclipse.handly.ui.text.reconciler.WorkingCopyReconciler
org.eclipse.handly.ui.text.reconciler.EditorWorkingCopyReconciler
- All Implemented Interfaces:
org.eclipse.jface.text.ITextViewerLifecycle
,org.eclipse.jface.text.reconciler.IReconciler
An abstract base class of a working copy reconciler that is activated on
editor activation and forces reconciling on a significant change in the
underlying model.
-
Constructor Summary
ConstructorDescriptionEditorWorkingCopyReconciler
(org.eclipse.ui.IEditorPart editor, Function<org.eclipse.jface.text.IDocument, ISourceFile> documentToSourceFile) Creates a new working copy reconciler for the given editor and with a function that is used to determine the source file for the reconciler's document.EditorWorkingCopyReconciler
(org.eclipse.ui.IEditorPart editor, IWorkingCopyManager workingCopyManager) Creates a new working copy reconciler for the given editor and with the given working copy manager. -
Method Summary
Methods inherited from class org.eclipse.handly.ui.text.reconciler.WorkingCopyReconciler
addElementChangeListener, elementChanged, forceReconciling, getReconcilingStrategy, initialProcess, isActive, isAffectedBy, isAffectedBy, process, reconcilerDocumentChanged, removeElementChangeListener, setActive, setProgressMonitor, setReconcilingStrategy
Methods inherited from class org.eclipse.jface.text.reconciler.AbstractReconciler
aboutToBeReconciled, aboutToWork, getDocument, getProgressMonitor, getTextViewer, isIncrementalReconciler, isRunningInReconcilerThread, reconcilerReset, setDelay, setIsAllowedToModifyDocument, setIsIncrementalReconciler, signalWaitForFinish, startReconciling
-
Constructor Details
-
EditorWorkingCopyReconciler
public EditorWorkingCopyReconciler(org.eclipse.ui.IEditorPart editor, IWorkingCopyManager workingCopyManager) Creates a new working copy reconciler for the given editor and with the given working copy manager. The working copy manager is used to determine the working copy for the reconciler's document. The reconciler is configured with a single reconciling strategy (by default, aWorkingCopyReconcilingStrategy
) that is used irrespective of where a dirty region is located in the reconciler's document.- Parameters:
editor
- notnull
workingCopyManager
- notnull
-
EditorWorkingCopyReconciler
public EditorWorkingCopyReconciler(org.eclipse.ui.IEditorPart editor, Function<org.eclipse.jface.text.IDocument, ISourceFile> documentToSourceFile) Creates a new working copy reconciler for the given editor and with a function that is used to determine the source file for the reconciler's document. The reconciler is configured with a single reconciling strategy (by default, aWorkingCopyReconcilingStrategy
) that is used irrespective of where a dirty region is located in the reconciler's document.- Parameters:
editor
- notnull
documentToSourceFile
- notnull
- Since:
- 1.5
-
-
Method Details
-
install
public void install(org.eclipse.jface.text.ITextViewer textViewer) WorkingCopyReconciler
extends this method toregister
an element change listener thatnotifies
when a change in the underlying modelaffects
the reconciler in some way, and also to register a shell listener thatsets
the active state of the reconciler when the reconciler's text viewer is activated or deactivated.EditorWorkingCopyReconciler
extends this method to register a part listener that sets the active state of the reconciler when the reconciler's editor is activated or deactivated.- Specified by:
install
in interfaceorg.eclipse.jface.text.reconciler.IReconciler
- Specified by:
install
in interfaceorg.eclipse.jface.text.ITextViewerLifecycle
- Overrides:
install
in classWorkingCopyReconciler
-
uninstall
public void uninstall()- Specified by:
uninstall
in interfaceorg.eclipse.jface.text.reconciler.IReconciler
- Specified by:
uninstall
in interfaceorg.eclipse.jface.text.ITextViewerLifecycle
- Overrides:
uninstall
in classWorkingCopyReconciler
-
getReconcilerLock
Returns the mutex for this reconciler. See Bug 66176 for a description of the underlying problem.This implementation returns the editor object as returned by
getEditor()
.- Overrides:
getReconcilerLock
in classWorkingCopyReconciler
- Returns:
- the mutex for the reconciler (never
null
)
-
getEditor
protected final org.eclipse.ui.IEditorPart getEditor()Returns the editor this reconciler is associated with. The association is immutable.- Returns:
- the reconciler's editor (never
null
)
-