ptolemy.backtrack.eclipse.plugin.editor

Class SemanticHighlightingPresenter

java.lang.Object

ptolemy.backtrack.eclipse.plugin.editor.SemanticHighlightingPresenter

All Implemented Interfaces:

org.eclipse.jface.text.IDocumentListener, org.eclipse.jface.text.ITextInputListener, org.eclipse.jface.text.ITextPresentationListener

public class SemanticHighlightingPresenter
extends java.lang.Object
implements org.eclipse.jface.text.ITextPresentationListener, org.eclipse.jface.text.ITextInputListener, org.eclipse.jface.text.IDocumentListener

Semantic highlighting presenter. This class is a modification of Eclipse's Java semantic highlighting presenter.

Since:

Ptolemy II 5.1

Version:

$Id$

Author:

Thomas Feng

Pt.AcceptedRating:

Red (tfeng)

Pt.ProposedRating:

Red (tfeng)

Constructor Summary

Constructors

Constructor and Description
SemanticHighlightingPresenter()

Method Summary

Modifier and Type	Method and Description
void	addAllPositions(java.util.List<SemanticHighlightingReconciler.HighlightedPosition> list) Adds all current positions to the given list.
void	applyTextPresentation(org.eclipse.jface.text.TextPresentation textPresentation) This method is called when a text presentation is about to be applied to the text viewer.
SemanticHighlightingReconciler.HighlightedPosition	createHighlightedPosition(int offset, int length, SemanticHighlightingReconciler.HighlightingStyle highlighting) Creates and returns a new highlighted position with the given offset, length and highlighting.
org.eclipse.jface.text.TextPresentation	createPresentation(java.util.List<?> addedPositions, java.util.List<?> removedPositions) Create a text presentation in the background.
java.lang.Runnable	createUpdateRunnable(org.eclipse.jface.text.TextPresentation textPresentation, java.util.List<SemanticHighlightingReconciler.HighlightedPosition> addedPositions, java.util.List<SemanticHighlightingReconciler.HighlightedPosition> removedPositions) Create a runnable for updating the presentation.
void	documentAboutToBeChanged(org.eclipse.jface.text.DocumentEvent event) The manipulation described by the document event will be performed.
void	documentChanged(org.eclipse.jface.text.DocumentEvent event) The manipulation described by the document event has been performed.
void	highlightingStyleChanged(SemanticHighlightingReconciler.HighlightingStyle highlighting) Invalidate text presentation of positions with the given highlighting.
void	inputDocumentAboutToBeChanged(org.eclipse.jface.text.IDocument oldInput, org.eclipse.jface.text.IDocument newInput) Called before the input document is replaced.
void	inputDocumentChanged(org.eclipse.jface.text.IDocument oldInput, org.eclipse.jface.text.IDocument newInput) Called after the input document has been replaced.
void	install(JavaSourceViewer sourceViewer, JavaPresentationReconciler backgroundPresentationReconciler) Install this presenter on the given source viewer and background presentation reconciler.
boolean	isCanceled() Test whether the current reconcile is canceled.
void	setCanceled(boolean isCanceled) Set whether or not the current reconcile is canceled.
void	uninstall() Uninstall this presenter.
void	updatePresentation(org.eclipse.jface.text.TextPresentation textPresentation, SemanticHighlightingReconciler.HighlightedPosition[] addedPositions, SemanticHighlightingReconciler.HighlightedPosition[] removedPositions) Invalidate the presentation of the positions based on the given added positions and the existing deleted positions.

Methods inherited from class java.lang.Object

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

Constructor Detail

SemanticHighlightingPresenter

public SemanticHighlightingPresenter()

Method Detail

addAllPositions

public void addAllPositions(java.util.List<SemanticHighlightingReconciler.HighlightedPosition> list)

Adds all current positions to the given list.

NOTE: Called from background thread.

Parameters:

list - The list

applyTextPresentation

public void applyTextPresentation(org.eclipse.jface.text.TextPresentation textPresentation)

This method is called when a text presentation is about to be applied to the text viewer. The receiver is allowed to change the text presentation during that call.

Specified by:

applyTextPresentation in interface org.eclipse.jface.text.ITextPresentationListener

Parameters:

textPresentation - the current text presentation

createHighlightedPosition

public SemanticHighlightingReconciler.HighlightedPosition createHighlightedPosition(int offset,
                                                                                    int length,
                                                                                    SemanticHighlightingReconciler.HighlightingStyle highlighting)

Creates and returns a new highlighted position with the given offset, length and highlighting.

NOTE: Also called from background thread.

Parameters:

offset - The offset

length - The length

highlighting - The highlighting

Returns:

The new highlighted position

createPresentation

public org.eclipse.jface.text.TextPresentation createPresentation(java.util.List<?> addedPositions,
                                                                  java.util.List<?> removedPositions)

Create a text presentation in the background.

NOTE: Called from background thread.

Parameters:

addedPositions - the added positions

removedPositions - the removed positions

Returns:

the text presentation or null, if reconciliation should be canceled

createUpdateRunnable

public java.lang.Runnable createUpdateRunnable(org.eclipse.jface.text.TextPresentation textPresentation,
                                               java.util.List<SemanticHighlightingReconciler.HighlightedPosition> addedPositions,
                                               java.util.List<SemanticHighlightingReconciler.HighlightedPosition> removedPositions)

Create a runnable for updating the presentation.

NOTE: Called from background thread.

Parameters:

textPresentation - the text presentation

addedPositions - the added positions

removedPositions - the removed positions

Returns:

the runnable or null, if reconciliation should be canceled

documentAboutToBeChanged

public void documentAboutToBeChanged(org.eclipse.jface.text.DocumentEvent event)

The manipulation described by the document event will be performed.

Specified by:

documentAboutToBeChanged in interface org.eclipse.jface.text.IDocumentListener

Parameters:

event - the document event describing the document change

documentChanged

public void documentChanged(org.eclipse.jface.text.DocumentEvent event)

The manipulation described by the document event has been performed.

Specified by:

documentChanged in interface org.eclipse.jface.text.IDocumentListener

Parameters:

event - the document event describing the document change

highlightingStyleChanged

public void highlightingStyleChanged(SemanticHighlightingReconciler.HighlightingStyle highlighting)

Invalidate text presentation of positions with the given highlighting.

Parameters:

highlighting - The highlighting

inputDocumentAboutToBeChanged

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

Called before the input document is replaced.

Specified by:

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

Parameters:

oldInput - the text viewer's previous input document

newInput - the text viewer's new input document

inputDocumentChanged

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

Called after the input document has been replaced.

Specified by:

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

Parameters:

oldInput - the text viewer's previous input document

newInput - the text viewer's new input document

install

public void install(JavaSourceViewer sourceViewer,
                    JavaPresentationReconciler backgroundPresentationReconciler)

Install this presenter on the given source viewer and background presentation reconciler.

Parameters:

sourceViewer - the source viewer

backgroundPresentationReconciler - the background presentation reconciler, can be null, in that case createPresentation(List, List) should not be called

isCanceled

public boolean isCanceled()

Test whether the current reconcile is canceled.

Returns:

true iff the current reconcile is canceled.

setCanceled

public void setCanceled(boolean isCanceled)

Set whether or not the current reconcile is canceled.

Parameters:

isCanceled - true iff the current reconcile is canceled

uninstall

public void uninstall()

Uninstall this presenter.

updatePresentation

public void updatePresentation(org.eclipse.jface.text.TextPresentation textPresentation,
                               SemanticHighlightingReconciler.HighlightedPosition[] addedPositions,
                               SemanticHighlightingReconciler.HighlightedPosition[] removedPositions)

Invalidate the presentation of the positions based on the given added positions and the existing deleted positions. Also unregisters the deleted positions from the document and patches the positions of this presenter.

NOTE: Indirectly called from background thread by UI runnable.

Parameters:

textPresentation - the text presentation or null, if the presentation should computed in the UI thread

addedPositions - the added positions

removedPositions - the removed positions