org.eclipse.xtext.ui.editor.syntaxcoloring

Class HighlightingReconciler

java.lang.Object

org.eclipse.xtext.ui.editor.syntaxcoloring.HighlightingReconciler

All Implemented Interfaces:

org.eclipse.jface.text.ITextInputListener, IHighlightedPositionAcceptor, IXtextModelListener, IXtextModelListenerExtension

public class HighlightingReconciler
extends Object
implements org.eclipse.jface.text.ITextInputListener, IXtextModelListener, IXtextModelListenerExtension, IHighlightedPositionAcceptor

Highlighting reconciler - Background thread implementation. Initially copied from org.eclipse.jdt.internal.ui.javaeditor.SemanticHighlightingReconciler

Author:

Sebastian Zarnekow

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.xtext.ui.editor.syntaxcoloring.IHighlightedPositionAcceptor

IHighlightedPositionAcceptor.DeprecationHelper

Constructor Summary

Constructors

Constructor and Description
HighlightingReconciler()

Method Summary

Methods

Modifier and Type	Method and Description
void	addPosition(int offset, int length, String... ids) Add a position with the given range and highlighting if it does not exist already.
protected void	beforeRefresh(XtextResource resource, CancelIndicator cancelIndicator)
protected void	checkCanceled(CancelIndicator cancelIndicator)
ISemanticHighlightingCalculator	getCalculator() Deprecated.
void	inputDocumentAboutToBeChanged(org.eclipse.jface.text.IDocument oldInput, org.eclipse.jface.text.IDocument newInput)
void	inputDocumentChanged(org.eclipse.jface.text.IDocument oldInput, org.eclipse.jface.text.IDocument newInput)
void	install(XtextEditor editor, XtextSourceViewer sourceViewer, HighlightingPresenter presenter) Install this reconciler on the given editor and presenter.
void	modelChanged(XtextResource resource)
void	modelChanged(XtextResource resource, CancelIndicator cancelIndicator) Called when the resource model of an XtextDocument has changed.
void	refresh() Refreshes the highlighting.
void	setCalculator(ISemanticHighlightingCalculator calculator) Deprecated.
void	uninstall() Uninstall this reconciler from the editor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HighlightingReconciler

public HighlightingReconciler()

Method Detail

addPosition

public void addPosition(int offset,
               int length,
               String... ids)

Add a position with the given range and highlighting if it does not exist already.

Specified by:

addPosition in interface IHighlightedPositionAcceptor

Parameters:

offset - The range offset

length - The range length

ids - The highlighting attribute ids

install

public void install(XtextEditor editor,
           XtextSourceViewer sourceViewer,
           HighlightingPresenter presenter)

Install this reconciler on the given editor and presenter.

Parameters:

editor - the editor

sourceViewer - the source viewer

presenter - the highlighting presenter

uninstall

public void uninstall()

Uninstall this reconciler from the editor

inputDocumentAboutToBeChanged

public void inputDocumentAboutToBeChanged(org.eclipse.jface.text.IDocument oldInput,
                                 org.eclipse.jface.text.IDocument newInput)

Specified by:

inputDocumentAboutToBeChanged in interface org.eclipse.jface.text.ITextInputListener

inputDocumentChanged

public void inputDocumentChanged(org.eclipse.jface.text.IDocument oldInput,
                        org.eclipse.jface.text.IDocument newInput)

Specified by:

inputDocumentChanged in interface org.eclipse.jface.text.ITextInputListener

refresh

public void refresh()

Refreshes the highlighting.

beforeRefresh

protected void beforeRefresh(XtextResource resource,
                 CancelIndicator cancelIndicator)

Since:

2.8

modelChanged

public void modelChanged(XtextResource resource)

Specified by:

modelChanged in interface IXtextModelListener

modelChanged

public void modelChanged(XtextResource resource,
                CancelIndicator cancelIndicator)

Description copied from interface: IXtextModelListenerExtension

Called when the resource model of an XtextDocument has changed.

Specified by:

modelChanged in interface IXtextModelListenerExtension

Parameters:

resource - the model

cancelIndicator - an indicator that should be asked in order to cancel an operation early in case there are new pending changes.

Since:

2.7

checkCanceled

protected void checkCanceled(CancelIndicator cancelIndicator)

Since:

2.8

setCalculator

@Deprecated
public void setCalculator(ISemanticHighlightingCalculator calculator)

Deprecated.

getCalculator

@Deprecated
public ISemanticHighlightingCalculator getCalculator()

Deprecated.