Code Mining: Example for redraw of end-of-line annotation #1070

This change modifies the code mining example to show the redraw of
end-of-line annotations. A text field is added at the top to change the
label of end-of-line code minings through user input.

Signed-off-by: Martin Jobst <[email protected]>

Author: mx990

examples/org.eclipse.jface.text.examples/src/org/eclipse/jface/text/examples/codemining/CodeMiningDemo.java

@@ -13,6 +13,9 @@
  */
 package org.eclipse.jface.text.examples.codemining;
 
+import java.util.concurrent.atomic.AtomicReference;
+
+import org.eclipse.jface.layout.GridDataFactory;
 import org.eclipse.jface.text.Document;
 import org.eclipse.jface.text.IDocument;
 import org.eclipse.jface.text.IRegion;
@@ -29,9 +32,10 @@
 import org.eclipse.jface.text.source.ISourceViewerExtension5;
 import org.eclipse.jface.text.source.SourceViewer;
 import org.eclipse.swt.SWT;
-import org.eclipse.swt.layout.FillLayout;
+import org.eclipse.swt.layout.GridLayout;
 import org.eclipse.swt.widgets.Display;
 import org.eclipse.swt.widgets.Shell;
+import org.eclipse.swt.widgets.Text;
 
 /**
  * A Code Mining demo with class references and implementations minings.
@@ -43,9 +47,14 @@ public static void main(String[] args) throws Exception {
 
 		Display display = new Display();
 		Shell shell = new Shell(display);
-		shell.setLayout(new FillLayout());
+		shell.setLayout(new GridLayout());
 		shell.setText("Code Mining demo");
 
+		AtomicReference<String> endOfLineString = new AtomicReference<>("End of line");
+		Text endOfLineText = new Text(shell, SWT.NONE);
+		endOfLineText.setText(endOfLineString.get());
+		GridDataFactory.fillDefaults().grab(true, false).applyTo(endOfLineText);
+
 		ISourceViewer sourceViewer = new SourceViewer(shell, null, SWT.V_SCROLL | SWT.BORDER);
 		sourceViewer.setDocument(
 				new Document("// Type class & new keyword and see references CodeMining\n"
@@ -63,6 +72,7 @@ public static void main(String[] args) throws Exception {
 						+ "new 5\n" //
 						+ "new 5\n"),
 				new AnnotationModel());
+		GridDataFactory.fillDefaults().grab(true, true).applyTo(sourceViewer.getTextWidget());
 		// Add AnnotationPainter (required by CodeMining)
 		addAnnotationPainter(sourceViewer);
 		// Initialize codemining providers
@@ -71,7 +81,7 @@ public static void main(String[] args) throws Exception {
 				new ClassImplementationsCodeMiningProvider(), //
 				new ToEchoWithHeaderAndInlineCodeMiningProvider("echo"), //
 				new EmptyLineCodeMiningProvider(), //
-				new EchoAtEndOfLineCodeMiningProvider()});
+				new EchoAtEndOfLineCodeMiningProvider(endOfLineString) });
 		// Execute codemining in a reconciler
 		MonoReconciler reconciler = new MonoReconciler(new IReconcilingStrategy() {
 
@@ -92,6 +102,11 @@ public void reconcile(IRegion partition) {
 		}, false);
 		reconciler.install(sourceViewer);
 
+		endOfLineText.addModifyListener(event -> {
+			endOfLineString.set(endOfLineText.getText());
+			((ISourceViewerExtension5) sourceViewer).updateCodeMinings();
+		});
+
 		shell.open();
 		while (!shell.isDisposed()) {
 			if (!display.readAndDispatch())

examples/org.eclipse.jface.text.examples/src/org/eclipse/jface/text/examples/codemining/EchoAtEndOfLineCodeMiningProvider.java

@@ -13,6 +13,7 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.atomic.AtomicReference;
 import java.util.function.Consumer;
 
 import org.eclipse.core.runtime.IProgressMonitor;
@@ -26,6 +27,12 @@
 
 public class EchoAtEndOfLineCodeMiningProvider extends AbstractCodeMiningProvider {
 
+	private final AtomicReference<String> text;
+
+	public EchoAtEndOfLineCodeMiningProvider(AtomicReference<String> text) {
+		this.text = text;
+	}
+
 	@Override
 	public CompletableFuture<List<? extends ICodeMining>> provideCodeMinings(ITextViewer viewer,
 			IProgressMonitor monitor) {
@@ -37,7 +44,7 @@ public CompletableFuture<List<? extends ICodeMining>> provideCodeMinings(ITextVi
 					res.add(new LineEndCodeMining(document, i, this) {
 						@Override
 						public String getLabel() {
-							return "End of line";
+							return text.get();
 						}
 						@Override
 						public boolean isResolved() {