Attachment #149357 for bug #275890

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.




import org.eclipse.ui.internal.editors.text.RefreshEditorAction;
import org.eclipse.ui.internal.texteditor.AnnotationColumn;
import org.eclipse.ui.internal.texteditor.BooleanPreferenceToggleAction;
import org.eclipse.ui.internal.texteditor.FocusedInformationPresenter;
import org.eclipse.ui.internal.texteditor.LineNumberColumn;
import org.eclipse.ui.internal.texteditor.TextChangeHover;
import org.eclipse.ui.keys.IBindingService;

public abstract class AbstractDecoratedTextEditor extends StatusTextEditor {

	/**
	 * Command ID of the command to display a sticky ruler hover for the current caret location.
	 * Value <code>"org.eclipse.ui.edit.text.showChangeRulerInformation"</code>).
	 * 
	 * @since 3.5
	 */
	//TODO: move to ITextEditorActionDefinitionIds and make API
	private static final String SHOW_CHANGE_RULER_INFORMATION_ID= "org.eclipse.ui.edit.text.showChangeRulerInformation"; //$NON-NLS-1$
	
	/**
	 * Name of the action displaying a sticky ruler hover for the current caret location.
	 *
	 * Value: <code>"ShowChangeRulerInformation"</code>
	 * @since 3.5
	 */
	//TODO: move to ITextEditorActionConstants and make API
	private static final String SHOW_CHANGE_RULER_INFORMATION= "ShowChangeRulerInformation"; //$NON-NLS-1$
	
	/**
	 * Preference key for showing the line number ruler.
	 */
	private final static String LINE_NUMBER_RULER= AbstractDecoratedTextEditorPreferenceConstants.EDITOR_LINE_NUMBER_RULER;

				showChangeRulerInformation();
			}
		};
		action.setActionDefinitionId(ITextEditorActionDefinitionIds.SHOW_CHANGE_RULER_INFORMATION_ID);
		setAction(ITextEditorActionConstants.SHOW_CHANGE_RULER_INFORMATION, action);
	}

	/**




/*******************************************************************************
 * Copyright (c) 2009 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.ui.texteditor;

import org.eclipse.swt.widgets.Shell;

import org.eclipse.jface.text.AbstractInformationControlManager;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.DefaultInformationControl;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.IInformationControl;
import org.eclipse.jface.text.IInformationControlCreator;
import org.eclipse.jface.text.IRegion;
import org.eclipse.jface.text.ITextViewer;
import org.eclipse.jface.text.Region;
import org.eclipse.jface.text.TextUtilities;
import org.eclipse.jface.text.information.IInformationProvider;
import org.eclipse.jface.text.information.IInformationProviderExtension;
import org.eclipse.jface.text.information.IInformationProviderExtension2;
import org.eclipse.jface.text.information.InformationPresenter;
import org.eclipse.jface.text.source.IAnnotationHover;
import org.eclipse.jface.text.source.IAnnotationHoverExtension;
import org.eclipse.jface.text.source.ILineRange;
import org.eclipse.jface.text.source.ISourceViewer;
import org.eclipse.jface.text.source.SourceViewerConfiguration;

/**
 * Information presenter used to present focused ("sticky") information shells.
 * 
 * @since 3.5
 */
class FocusedInformationPresenter extends InformationPresenter {

	/**
	 * Information provider used to present focused information shells.
	 */
	public final static class InformationProvider implements IInformationProvider, IInformationProviderExtension, IInformationProviderExtension2 {

		private IRegion fHoverRegion;
		private Object fHoverInfo;
		private IInformationControlCreator fControlCreator;

		public InformationProvider(IRegion hoverRegion, Object hoverInfo, IInformationControlCreator controlCreator) {
			fHoverRegion= hoverRegion;
			fHoverInfo= hoverInfo;
			fControlCreator= controlCreator;
		}
		/*
		 * @see org.eclipse.jface.text.information.IInformationProvider#getSubject(org.eclipse.jface.text.ITextViewer, int)
		 */
		public IRegion getSubject(ITextViewer textViewer, int invocationOffset) {
			return fHoverRegion;
		}
		/**
		 * {@inheritDoc}
		 *
		 * @deprecated As of 2.1, replaced by {@link IInformationProviderExtension#getInformation2(ITextViewer, IRegion)}
		 */
		public String getInformation(ITextViewer textViewer, IRegion subject) {
			return fHoverInfo == null ? null : fHoverInfo.toString();
		}
		/*
		 * @see org.eclipse.jface.text.information.IInformationProviderExtension#getInformation2(org.eclipse.jface.text.ITextViewer, org.eclipse.jface.text.IRegion)
		 * @since 3.2
		 */
		public Object getInformation2(ITextViewer textViewer, IRegion subject) {
			return fHoverInfo;
		}
		/*
		 * @see org.eclipse.jface.text.information.IInformationProviderExtension2#getInformationPresenterControlCreator()
		 */
		public IInformationControlCreator getInformationPresenterControlCreator() {
			return fControlCreator;
		}
	}
	
	/**
	 * The default information control creator.
	 */
	private static class DefaultInformationControlCreator implements IInformationControlCreator {
		public IInformationControl createInformationControl(Shell shell) {
			return new DefaultInformationControl(shell, true);
		}
	}
	
	/**
	 * The source viewer.
	 */
	private final ISourceViewer fSourceViewer;
	/**
	 * The source viewer configuration.
	 */
	private final SourceViewerConfiguration fSourceViewerConfiguration;

	/**
	 * Creates a new focused information presenter and installs it on the given source viewer
	 * 
	 * @param sourceViewer the source viewer
	 * @param sourceViewerConfiguration the viewer configuration
	 */
	public FocusedInformationPresenter(ISourceViewer sourceViewer, SourceViewerConfiguration sourceViewerConfiguration) {
		super(new DefaultInformationControlCreator());
		fSourceViewer= sourceViewer;
		fSourceViewerConfiguration= sourceViewerConfiguration;
		
		// sizes: see org.eclipse.jface.text.TextViewer.TEXT_HOVER_*_CHARS
		setSizeConstraints(100, 12, true, true);
		install(sourceViewer);
		setDocumentPartitioning(sourceViewerConfiguration.getConfiguredDocumentPartitioning(sourceViewer));
	}

	/**
	 * Tries to show a focused ("sticky") annotation hover.
	 *
	 * @param annotationHover the annotation hover to show
	 * @param line the line for which to show the hover
	 * @return <code>true</code> if successful, <code>false</code> otherwise
	 */
	public boolean openFocusedAnnotationHover(IAnnotationHover annotationHover, int line) {
		
		try {
			// compute the hover information
			Object hoverInfo;
			if (annotationHover instanceof IAnnotationHoverExtension) {
				IAnnotationHoverExtension extension= (IAnnotationHoverExtension) annotationHover;
				ILineRange hoverLineRange= extension.getHoverLineRange(fSourceViewer, line);
				if (hoverLineRange == null)
					return false;
				final int maxVisibleLines= Integer.MAX_VALUE; // allow any number of lines being displayed, as we support scrolling
				hoverInfo= extension.getHoverInfo(fSourceViewer, hoverLineRange, maxVisibleLines);
			} else {
				hoverInfo= annotationHover.getHoverInfo(fSourceViewer, line);
			}

			// hover region: the beginning of the concerned line to place the control right over the line
			IDocument document= fSourceViewer.getDocument();
			int offset= document.getLineOffset(line);
			String contentType= TextUtilities.getContentType(document, fSourceViewerConfiguration.getConfiguredDocumentPartitioning(fSourceViewer), offset, true);

			IInformationControlCreator controlCreator= null;
			if (annotationHover instanceof IInformationProviderExtension2) // this is undocumented, but left here for backwards compatibility
				controlCreator= ((IInformationProviderExtension2) annotationHover).getInformationPresenterControlCreator();
			else if (annotationHover instanceof IAnnotationHoverExtension)
				controlCreator= ((IAnnotationHoverExtension) annotationHover).getHoverControlCreator();

			IInformationProvider informationProvider= new InformationProvider(new Region(offset, 0), hoverInfo, controlCreator);

			setOffset(offset);
			setAnchor(AbstractInformationControlManager.ANCHOR_RIGHT);
			setMargins(4, 0); // AnnotationBarHoverManager sets (5,0), minus SourceViewer.GAP_SIZE_1
			setInformationProvider(informationProvider, contentType);
			showInformation();

			return true;

		} catch (BadLocationException e) {
			return false;
		}
	}
}



Lines 9-15 Link Here

(-)META-INF/MANIFEST.MF (-1 / +1 lines)
9	Bundle-Localization: plugin	9	Bundle-Localization: plugin
10	Export-Package:	10	Export-Package:
11	org.eclipse.ui.contentassist,	11	org.eclipse.ui.contentassist,
12	org.eclipse.ui.internal.texteditor;x-internal:=true; texteditor="split"; mandatory:="texteditor",	12	org.eclipse.ui.internal.texteditor; texteditor="split"; mandatory:="texteditor"; x-friends:="org.eclipse.ui.editors",
13	org.eclipse.ui.internal.texteditor.quickdiff;x-internal:=true,	13	org.eclipse.ui.internal.texteditor.quickdiff;x-internal:=true,
14	org.eclipse.ui.internal.texteditor.quickdiff.compare.equivalence;x-internal:=true,	14	org.eclipse.ui.internal.texteditor.quickdiff.compare.equivalence;x-internal:=true,
15	org.eclipse.ui.internal.texteditor.rulers;x-internal:=true,	15	org.eclipse.ui.internal.texteditor.rulers;x-internal:=true,




/*******************************************************************************
 * Copyright (c) 2009 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.ui.internal.texteditor;

import org.eclipse.swt.widgets.Shell;

import org.eclipse.jface.text.AbstractInformationControlManager;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.DefaultInformationControl;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.IInformationControl;
import org.eclipse.jface.text.IInformationControlCreator;
import org.eclipse.jface.text.IRegion;
import org.eclipse.jface.text.ITextViewer;
import org.eclipse.jface.text.Region;
import org.eclipse.jface.text.TextUtilities;
import org.eclipse.jface.text.information.IInformationProvider;
import org.eclipse.jface.text.information.IInformationProviderExtension;
import org.eclipse.jface.text.information.IInformationProviderExtension2;
import org.eclipse.jface.text.information.InformationPresenter;
import org.eclipse.jface.text.source.IAnnotationHover;
import org.eclipse.jface.text.source.IAnnotationHoverExtension;
import org.eclipse.jface.text.source.ILineRange;
import org.eclipse.jface.text.source.ISourceViewer;
import org.eclipse.jface.text.source.SourceViewerConfiguration;

/**
 * Information presenter used to present focused ("sticky") information shells.
 * 
 * @since 3.5
 */
public class FocusedInformationPresenter extends InformationPresenter {

	/**
	 * Information provider used to present focused information shells.
	 */
	public final static class InformationProvider implements IInformationProvider, IInformationProviderExtension, IInformationProviderExtension2 {

		private IRegion fHoverRegion;
		private Object fHoverInfo;
		private IInformationControlCreator fControlCreator;

		public InformationProvider(IRegion hoverRegion, Object hoverInfo, IInformationControlCreator controlCreator) {
			fHoverRegion= hoverRegion;
			fHoverInfo= hoverInfo;
			fControlCreator= controlCreator;
		}
		/*
		 * @see org.eclipse.jface.text.information.IInformationProvider#getSubject(org.eclipse.jface.text.ITextViewer, int)
		 */
		public IRegion getSubject(ITextViewer textViewer, int invocationOffset) {
			return fHoverRegion;
		}
		/**
		 * {@inheritDoc}
		 *
		 * @deprecated As of 2.1, replaced by {@link IInformationProviderExtension#getInformation2(ITextViewer, IRegion)}
		 */
		public String getInformation(ITextViewer textViewer, IRegion subject) {
			return fHoverInfo == null ? null : fHoverInfo.toString();
		}
		/*
		 * @see org.eclipse.jface.text.information.IInformationProviderExtension#getInformation2(org.eclipse.jface.text.ITextViewer, org.eclipse.jface.text.IRegion)
		 * @since 3.2
		 */
		public Object getInformation2(ITextViewer textViewer, IRegion subject) {
			return fHoverInfo;
		}
		/*
		 * @see org.eclipse.jface.text.information.IInformationProviderExtension2#getInformationPresenterControlCreator()
		 */
		public IInformationControlCreator getInformationPresenterControlCreator() {
			return fControlCreator;
		}
	}
	
	/**
	 * The default information control creator.
	 */
	private static class DefaultInformationControlCreator implements IInformationControlCreator {
		public IInformationControl createInformationControl(Shell shell) {
			return new DefaultInformationControl(shell, true);
		}
	}
	
	
	private final ISourceViewer fSourceViewer;
	private final SourceViewerConfiguration fSourceViewerConfiguration;

	/**
	 * Creates a focused information presenter and installs it on the source viewer.
	 * 
	 * @param sourceViewer the source viewer
	 * @param sourceViewerConfiguration the configuration
	 */
	public FocusedInformationPresenter(ISourceViewer sourceViewer, SourceViewerConfiguration sourceViewerConfiguration) {
		super(new DefaultInformationControlCreator());
		fSourceViewer= sourceViewer;
		fSourceViewerConfiguration= sourceViewerConfiguration;
		
		// sizes: see org.eclipse.jface.text.TextViewer.TEXT_HOVER_*_CHARS
		setSizeConstraints(100, 12, true, true);
		install(sourceViewer);
		setDocumentPartitioning(sourceViewerConfiguration.getConfiguredDocumentPartitioning(sourceViewer));
	}

	/**
	 * Tries show a focused ("sticky") annotation hover.
	 *
	 * @param annotationHover the annotation hover to show
	 * @param line the line for which to show the hover
	 * @return <code>true</code> if successful, <code>false</code> otherwise
	 */
	public boolean openFocusedAnnotationHover(IAnnotationHover annotationHover, int line) {
		
		try {
			// compute the hover information
			Object hoverInfo;
			if (annotationHover instanceof IAnnotationHoverExtension) {
				IAnnotationHoverExtension extension= (IAnnotationHoverExtension) annotationHover;
				ILineRange hoverLineRange= extension.getHoverLineRange(fSourceViewer, line);
				if (hoverLineRange == null)
					return false;
				final int maxVisibleLines= Integer.MAX_VALUE; // allow any number of lines being displayed, as we support scrolling
				hoverInfo= extension.getHoverInfo(fSourceViewer, hoverLineRange, maxVisibleLines);
			} else {
				hoverInfo= annotationHover.getHoverInfo(fSourceViewer, line);
			}

			// hover region: the beginning of the concerned line to place the control right over the line
			IDocument document= fSourceViewer.getDocument();
			int offset= document.getLineOffset(line);
			String contentType= TextUtilities.getContentType(document, fSourceViewerConfiguration.getConfiguredDocumentPartitioning(fSourceViewer), offset, true);

			IInformationControlCreator controlCreator= null;
			if (annotationHover instanceof IInformationProviderExtension2) // this is undocumented, but left here for backwards compatibility
				controlCreator= ((IInformationProviderExtension2) annotationHover).getInformationPresenterControlCreator();
			else if (annotationHover instanceof IAnnotationHoverExtension)
				controlCreator= ((IAnnotationHoverExtension) annotationHover).getHoverControlCreator();

			IInformationProvider informationProvider= new InformationProvider(new Region(offset, 0), hoverInfo, controlCreator);

			setOffset(offset);
			setAnchor(AbstractInformationControlManager.ANCHOR_RIGHT);
			setMargins(4, 0); // AnnotationBarHoverManager sets (5,0), minus SourceViewer.GAP_SIZE_1
			setInformationProvider(informationProvider, contentType);
			showInformation();

			return true;

		} catch (BadLocationException e) {
			return false;
		}
	}
}







import org.eclipse.jface.text.AbstractInformationControlManager;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.DefaultInformationControl;
import org.eclipse.jface.text.DefaultLineTracker;
import org.eclipse.jface.text.DocumentEvent;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.IDocumentListener;
import org.eclipse.jface.text.IFindReplaceTarget;
import org.eclipse.jface.text.IFindReplaceTargetExtension;
import org.eclipse.jface.text.IInformationControl;
import org.eclipse.jface.text.IInformationControlCreator;
import org.eclipse.jface.text.IMarkRegionTarget;
import org.eclipse.jface.text.IRegion;

import org.eclipse.jface.text.ITextViewer;
import org.eclipse.jface.text.ITextViewerExtension;
import org.eclipse.jface.text.ITextViewerExtension2;
import org.eclipse.jface.text.ITextViewerExtension4;
import org.eclipse.jface.text.ITextViewerExtension5;
import org.eclipse.jface.text.ITextViewerExtension6;
import org.eclipse.jface.text.ITextViewerExtension7;

import org.eclipse.jface.text.ITextViewerExtension8.EnrichMode;
import org.eclipse.jface.text.hyperlink.IHyperlinkDetector;
import org.eclipse.jface.text.information.IInformationProvider;
import org.eclipse.jface.text.information.IInformationProviderExtension;
import org.eclipse.jface.text.information.IInformationProviderExtension2;
import org.eclipse.jface.text.information.InformationPresenter;
import org.eclipse.jface.text.link.LinkedModeModel;
import org.eclipse.jface.text.link.LinkedPosition;
import org.eclipse.jface.text.quickassist.IQuickAssistAssistant;

import org.eclipse.jface.text.source.Annotation;
import org.eclipse.jface.text.source.CompositeRuler;
import org.eclipse.jface.text.source.IAnnotationHover;
import org.eclipse.jface.text.source.IAnnotationHoverExtension;
import org.eclipse.jface.text.source.IAnnotationModel;
import org.eclipse.jface.text.source.ILineRange;
import org.eclipse.jface.text.source.ISourceViewer;
import org.eclipse.jface.text.source.ISourceViewerExtension3;
import org.eclipse.jface.text.source.ISourceViewerExtension4;

import org.eclipse.ui.dialogs.PropertyDialogAction;
import org.eclipse.ui.dnd.IDragAndDropService;
import org.eclipse.ui.internal.texteditor.EditPosition;
import org.eclipse.ui.internal.texteditor.FocusedInformationPresenter;
import org.eclipse.ui.internal.texteditor.NLSUtility;
import org.eclipse.ui.internal.texteditor.TextEditorPlugin;
import org.eclipse.ui.internal.texteditor.rulers.StringSetSerializer;



	/**
	 * Information provider used to present focusable information shells.
	 *
	 * @since 3.3
	 */
	private static final class InformationProvider implements IInformationProvider, IInformationProviderExtension, IInformationProviderExtension2 {

		private IRegion fHoverRegion;
		private Object fHoverInfo;
		private IInformationControlCreator fControlCreator;

		InformationProvider(IRegion hoverRegion, Object hoverInfo, IInformationControlCreator controlCreator) {
			fHoverRegion= hoverRegion;
			fHoverInfo= hoverInfo;
			fControlCreator= controlCreator;
		}
		/*
		 * @see org.eclipse.jface.text.information.IInformationProvider#getSubject(org.eclipse.jface.text.ITextViewer, int)
		 */
		public IRegion getSubject(ITextViewer textViewer, int invocationOffset) {
			return fHoverRegion;
		}
		/**
		 * {@inheritDoc}
		 *
		 * @deprecated As of 2.1, replaced by {@link IInformationProviderExtension#getInformation2(ITextViewer, IRegion)}
		 */
		public String getInformation(ITextViewer textViewer, IRegion subject) {
			return fHoverInfo == null ? null : fHoverInfo.toString();
		}
		/*
		 * @see org.eclipse.jface.text.information.IInformationProviderExtension#getInformation2(org.eclipse.jface.text.ITextViewer, org.eclipse.jface.text.IRegion)
		 * @since 3.2
		 */
		public Object getInformation2(ITextViewer textViewer, IRegion subject) {
			return fHoverInfo;
		}
		/*
		 * @see org.eclipse.jface.text.information.IInformationProviderExtension2#getInformationPresenterControlCreator()
		 */
		public IInformationControlCreator getInformationPresenterControlCreator() {
			return fControlCreator;
		}
	}

	/**
	 * This action behaves in two different ways: If there is no current text
	 * hover, the javadoc is displayed using information presenter. If there is
	 * a current text hover, it is converted into a information presenter in

				return;
			}

//			if (sourceViewer instanceof ITextViewerExtension4)  {
//				ITextViewerExtension4 extension4= (ITextViewerExtension4) sourceViewer;
//				if (extension4.moveFocusToWidgetToken())
//					return;
//			}

			if (sourceViewer instanceof ITextViewerExtension2) {
				// does a text hover exist?

			if (sourceViewer instanceof ISourceViewerExtension3) {
				// does an annotation hover exist?
				IAnnotationHover annotationHover= ((ISourceViewerExtension3) sourceViewer).getCurrentAnnotationHover();
				if (annotationHover != null && makeAnnotationHoverFocusable(annotationHover))
					return;
			}


				if (textHover instanceof IInformationProviderExtension2) // this is conceptually wrong, but left here for backwards compatibility
					controlCreator= ((IInformationProviderExtension2)textHover).getInformationPresenterControlCreator();

				IInformationProvider informationProvider= new FocusedInformationPresenter.InformationProvider(hoverRegion, hoverInfo, controlCreator);

				FocusedInformationPresenter informationPresenter= getInformationPresenter();
				informationPresenter.setOffset(offset);
				informationPresenter.setAnchor(AbstractInformationControlManager.ANCHOR_BOTTOM);
				informationPresenter.setMargins(6, 6); // default values from AbstractInformationControlManager
				String contentType= TextUtilities.getContentType(sourceViewer.getDocument(), getSourceViewerConfiguration().getConfiguredDocumentPartitioning(getSourceViewer()), offset, true);
				informationPresenter.setInformationProvider(informationProvider, contentType);
				informationPresenter.showInformation();

				return true;


		/**
		 * Tries to make an annotation hover focusable (or "sticky").
		 *
		 * @param sourceViewer the source viewer to display the hover over
		 * @param annotationHover the hover to make focusable
		 * @return <code>true</code> if successful, <code>false</code> otherwise
		 */
		private boolean makeAnnotationHoverFocusable(IAnnotationHover annotationHover) {
			IVerticalRulerInfo info= getVerticalRuler();
			int line= info.getLineOfLastMouseButtonActivity();
			if (line == -1)
				return false;

			return getInformationPresenter().openFocusedAnnotationHover(annotationHover, line);

				// compute the hover information
				Object hoverInfo;
				if (annotationHover instanceof IAnnotationHoverExtension) {
					IAnnotationHoverExtension extension= (IAnnotationHoverExtension) annotationHover;
					ILineRange hoverLineRange= extension.getHoverLineRange(sourceViewer, line);
					if (hoverLineRange == null)
						return false;
					final int maxVisibleLines= Integer.MAX_VALUE; // allow any number of lines being displayed, as we support scrolling
					hoverInfo= extension.getHoverInfo(sourceViewer, hoverLineRange, maxVisibleLines);
				} else {
					hoverInfo= annotationHover.getHoverInfo(sourceViewer, line);
				}

				// hover region: the beginning of the concerned line to place the control right over the line
				IDocument document= sourceViewer.getDocument();
				int offset= document.getLineOffset(line);
				String contentType= TextUtilities.getContentType(document, getSourceViewerConfiguration().getConfiguredDocumentPartitioning(getSourceViewer()), offset, true);

				IInformationControlCreator controlCreator= null;
				if (annotationHover instanceof IInformationProviderExtension2) // this is undocumented, but left here for backwards compatibility
					controlCreator= ((IInformationProviderExtension2) annotationHover).getInformationPresenterControlCreator();
				else if (annotationHover instanceof IAnnotationHoverExtension)
					controlCreator= ((IAnnotationHoverExtension) annotationHover).getHoverControlCreator();

				IInformationProvider informationProvider= new InformationProvider(new Region(offset, 0), hoverInfo, controlCreator);

				fInformationPresenter.setOffset(offset);
				fInformationPresenter.setAnchor(AbstractInformationControlManager.ANCHOR_RIGHT);
				fInformationPresenter.setMargins(4, 0); // AnnotationBarHoverManager sets (5,0), minus SourceViewer.GAP_SIZE_1
				fInformationPresenter.setInformationProvider(informationProvider, contentType);
				fInformationPresenter.showInformation();

				return true;

			} catch (BadLocationException e) {
				return false;
			}
        }
		
		/**
		 * Returns the information presenter (creates it if necessary).
		 * 
		 * @return the information presenter
		 * @since 3.6
		 */
		private FocusedInformationPresenter getInformationPresenter() {
			if (fInformationPresenter == null) {
				fInformationPresenter= new FocusedInformationPresenter(getSourceViewer(), getSourceViewerConfiguration());
			}
			return fInformationPresenter;
		}

		// modified version from TextViewer
		private int computeOffsetAtLocation(ITextViewer textViewer, int x, int y) {

			} catch (IllegalArgumentException e) {
				return -1;
			}

		}
	}


	 */
	private Object fTextDragAndDropToken;
	/**
	 * The information presenter, may be <code>null</code>.
	 * @since 3.3
	 */
	private FocusedInformationPresenter fInformationPresenter;

	/**
	 * Tells whether this editor has been activated at least once.

		IVerticalRuler ruler= getVerticalRuler();
		if (ruler instanceof CompositeRuler)
			updateContributedRulerColumns((CompositeRuler) ruler);

		IInformationControlCreator informationControlCreator= new IInformationControlCreator() {
			public IInformationControl createInformationControl(Shell shell) {
				return new DefaultInformationControl(shell, true);
			}
		};

		fInformationPresenter= new InformationPresenter(informationControlCreator);
		// sizes: see org.eclipse.jface.text.TextViewer.TEXT_HOVER_*_CHARS
		fInformationPresenter.setSizeConstraints(100, 12, true, true);
		fInformationPresenter.install(getSourceViewer());
		fInformationPresenter.setDocumentPartitioning(getSourceViewerConfiguration().getConfiguredDocumentPartitioning(getSourceViewer()));

	}

	/**

			fKeyBindingSupportForQuickAssistant.dispose();
			fKeyBindingSupportForQuickAssistant= null;
		}
		
		if (fInformationPresenter != null) {
			fInformationPresenter.uninstall();
			fInformationPresenter= null;
		}

		super.dispose();
	}

Lines 672-675 Link Here

(-)src/org/eclipse/ui/texteditor/ITextEditorActionConstants.java (+8 lines)
672	* @since 3.5	672	* @since 3.5
673	*/	673	*/
674	String BLOCK_SELECTION_MODE= "BlockSelectionMode"; //$NON-NLS-1$	674	String BLOCK_SELECTION_MODE= "BlockSelectionMode"; //$NON-NLS-1$
		675
		676	/**
		677	* Name of the action displaying a sticky ruler hover for the current caret location.
		678	*
		679	* Value: <code>"ShowChangeRulerInformation"</code>
		680	* @since 3.6
		681	*/
		682	public static final String SHOW_CHANGE_RULER_INFORMATION= "ShowChangeRulerInformation"; //$NON-NLS-1$
675	}	683	}

Lines 577-580 Link Here

(-)src/org/eclipse/ui/texteditor/ITextEditorActionDefinitionIds.java (+8 lines)
577	* @since 3.5	577	* @since 3.5
578	*/	578	*/
579	String BLOCK_SELECTION_MODE= "org.eclipse.ui.edit.text.toggleBlockSelectionMode"; //$NON-NLS-1$	579	String BLOCK_SELECTION_MODE= "org.eclipse.ui.edit.text.toggleBlockSelectionMode"; //$NON-NLS-1$
		580
		581	/**
		582	* Command ID of the command to display a sticky ruler hover for the current caret location.
		583	* Value <code>"org.eclipse.ui.edit.text.showChangeRulerInformation"</code>.
		584	*
		585	* @since 3.6
		586	*/
		587	public static final String SHOW_CHANGE_RULER_INFORMATION_ID= "org.eclipse.ui.edit.text.showChangeRulerInformation"; //$NON-NLS-1$
580	}	588	}

Return to bug 275890

Lines 126-131 Link Here

(-)src/org/eclipse/ui/texteditor/AbstractDecoratedTextEditor.java (-20 / +3 lines)
126	import org.eclipse.ui.internal.editors.text.RefreshEditorAction;	126	import org.eclipse.ui.internal.editors.text.RefreshEditorAction;
127	import org.eclipse.ui.internal.texteditor.AnnotationColumn;	127	import org.eclipse.ui.internal.texteditor.AnnotationColumn;
128	import org.eclipse.ui.internal.texteditor.BooleanPreferenceToggleAction;	128	import org.eclipse.ui.internal.texteditor.BooleanPreferenceToggleAction;
		129	import org.eclipse.ui.internal.texteditor.FocusedInformationPresenter;
129	import org.eclipse.ui.internal.texteditor.LineNumberColumn;	130	import org.eclipse.ui.internal.texteditor.LineNumberColumn;
130	import org.eclipse.ui.internal.texteditor.TextChangeHover;	131	import org.eclipse.ui.internal.texteditor.TextChangeHover;
131	import org.eclipse.ui.keys.IBindingService;	132	import org.eclipse.ui.keys.IBindingService;
Lines 157-180 Link Here
157	public abstract class AbstractDecoratedTextEditor extends StatusTextEditor {	158	public abstract class AbstractDecoratedTextEditor extends StatusTextEditor {
158		159
159	/**	160	/**
160	* Command ID of the command to display a sticky ruler hover for the current caret location.
161	* Value <code>"org.eclipse.ui.edit.text.showChangeRulerInformation"</code>).
162	*
163	* @since 3.5
164	*/
165	//TODO: move to ITextEditorActionDefinitionIds and make API
166	private static final String SHOW_CHANGE_RULER_INFORMATION_ID= "org.eclipse.ui.edit.text.showChangeRulerInformation"; //$NON-NLS-1$
167
168	/**
169	* Name of the action displaying a sticky ruler hover for the current caret location.
170	*
171	* Value: <code>"ShowChangeRulerInformation"</code>
172	* @since 3.5
173	*/
174	//TODO: move to ITextEditorActionConstants and make API
175	private static final String SHOW_CHANGE_RULER_INFORMATION= "ShowChangeRulerInformation"; //$NON-NLS-1$
176
177	/**
178	* Preference key for showing the line number ruler.	161	* Preference key for showing the line number ruler.
179	*/	162	*/
180	private final static String LINE_NUMBER_RULER= AbstractDecoratedTextEditorPreferenceConstants.EDITOR_LINE_NUMBER_RULER;	163	private final static String LINE_NUMBER_RULER= AbstractDecoratedTextEditorPreferenceConstants.EDITOR_LINE_NUMBER_RULER;
Lines 1252-1259 Link Here
1252	showChangeRulerInformation();	1235	showChangeRulerInformation();
1253	}	1236	}
1254	};	1237	};
1255	action.setActionDefinitionId(SHOW_CHANGE_RULER_INFORMATION_ID);	1238	action.setActionDefinitionId(ITextEditorActionDefinitionIds.SHOW_CHANGE_RULER_INFORMATION_ID);
1256	setAction(SHOW_CHANGE_RULER_INFORMATION, action);	1239	setAction(ITextEditorActionConstants.SHOW_CHANGE_RULER_INFORMATION, action);
1257	}	1240	}
1258		1241
1259	/**	1242	/**

Removed Link Here

(-)src/org/eclipse/ui/texteditor/FocusedInformationPresenter.java (-170 lines)
1	/*******************************************************************************
2	* Copyright (c) 2009 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.ui.texteditor;
12
13	import org.eclipse.swt.widgets.Shell;
14
15	import org.eclipse.jface.text.AbstractInformationControlManager;
16	import org.eclipse.jface.text.BadLocationException;
17	import org.eclipse.jface.text.DefaultInformationControl;
18	import org.eclipse.jface.text.IDocument;
19	import org.eclipse.jface.text.IInformationControl;
20	import org.eclipse.jface.text.IInformationControlCreator;
21	import org.eclipse.jface.text.IRegion;
22	import org.eclipse.jface.text.ITextViewer;
23	import org.eclipse.jface.text.Region;
24	import org.eclipse.jface.text.TextUtilities;
25	import org.eclipse.jface.text.information.IInformationProvider;
26	import org.eclipse.jface.text.information.IInformationProviderExtension;
27	import org.eclipse.jface.text.information.IInformationProviderExtension2;
28	import org.eclipse.jface.text.information.InformationPresenter;
29	import org.eclipse.jface.text.source.IAnnotationHover;
30	import org.eclipse.jface.text.source.IAnnotationHoverExtension;
31	import org.eclipse.jface.text.source.ILineRange;
32	import org.eclipse.jface.text.source.ISourceViewer;
33	import org.eclipse.jface.text.source.SourceViewerConfiguration;
34
35	/**
36	* Information presenter used to present focused ("sticky") information shells.
37	*
38	* @since 3.5
39	*/
40	class FocusedInformationPresenter extends InformationPresenter {
41
42	/**
43	* Information provider used to present focused information shells.
44	*/
45	public final static class InformationProvider implements IInformationProvider, IInformationProviderExtension, IInformationProviderExtension2 {
46
47	private IRegion fHoverRegion;
48	private Object fHoverInfo;
49	private IInformationControlCreator fControlCreator;
50
51	public InformationProvider(IRegion hoverRegion, Object hoverInfo, IInformationControlCreator controlCreator) {
52	fHoverRegion= hoverRegion;
53	fHoverInfo= hoverInfo;
54	fControlCreator= controlCreator;
55	}
56	/*
57	* @see org.eclipse.jface.text.information.IInformationProvider#getSubject(org.eclipse.jface.text.ITextViewer, int)
58	*/
59	public IRegion getSubject(ITextViewer textViewer, int invocationOffset) {
60	return fHoverRegion;
61	}
62	/**
63	* {@inheritDoc}
64	*
65	* @deprecated As of 2.1, replaced by {@link IInformationProviderExtension#getInformation2(ITextViewer, IRegion)}
66	*/
67	public String getInformation(ITextViewer textViewer, IRegion subject) {
68	return fHoverInfo == null ? null : fHoverInfo.toString();
69	}
70	/*
71	* @see org.eclipse.jface.text.information.IInformationProviderExtension#getInformation2(org.eclipse.jface.text.ITextViewer, org.eclipse.jface.text.IRegion)
72	* @since 3.2
73	*/
74	public Object getInformation2(ITextViewer textViewer, IRegion subject) {
75	return fHoverInfo;
76	}
77	/*
78	* @see org.eclipse.jface.text.information.IInformationProviderExtension2#getInformationPresenterControlCreator()
79	*/
80	public IInformationControlCreator getInformationPresenterControlCreator() {
81	return fControlCreator;
82	}
83	}
84
85	/**
86	* The default information control creator.
87	*/
88	private static class DefaultInformationControlCreator implements IInformationControlCreator {
89	public IInformationControl createInformationControl(Shell shell) {
90	return new DefaultInformationControl(shell, true);
91	}
92	}
93
94	/**
95	* The source viewer.
96	*/
97	private final ISourceViewer fSourceViewer;
98	/**
99	* The source viewer configuration.
100	*/
101	private final SourceViewerConfiguration fSourceViewerConfiguration;
102
103	/**
104	* Creates a new focused information presenter and installs it on the given source viewer
105	*
106	* @param sourceViewer the source viewer
107	* @param sourceViewerConfiguration the viewer configuration
108	*/
109	public FocusedInformationPresenter(ISourceViewer sourceViewer, SourceViewerConfiguration sourceViewerConfiguration) {
110	super(new DefaultInformationControlCreator());
111	fSourceViewer= sourceViewer;
112	fSourceViewerConfiguration= sourceViewerConfiguration;
113
114	// sizes: see org.eclipse.jface.text.TextViewer.TEXT_HOVER_*_CHARS
115	setSizeConstraints(100, 12, true, true);
116	install(sourceViewer);
117	setDocumentPartitioning(sourceViewerConfiguration.getConfiguredDocumentPartitioning(sourceViewer));
118	}
119
120	/**
121	* Tries to show a focused ("sticky") annotation hover.
122	*
123	* @param annotationHover the annotation hover to show
124	* @param line the line for which to show the hover
125	* @return <code>true</code> if successful, <code>false</code> otherwise
126	*/
127	public boolean openFocusedAnnotationHover(IAnnotationHover annotationHover, int line) {
128
129	try {
130	// compute the hover information
131	Object hoverInfo;
132	if (annotationHover instanceof IAnnotationHoverExtension) {
133	IAnnotationHoverExtension extension= (IAnnotationHoverExtension) annotationHover;
134	ILineRange hoverLineRange= extension.getHoverLineRange(fSourceViewer, line);
135	if (hoverLineRange == null)
136	return false;
137	final int maxVisibleLines= Integer.MAX_VALUE; // allow any number of lines being displayed, as we support scrolling
138	hoverInfo= extension.getHoverInfo(fSourceViewer, hoverLineRange, maxVisibleLines);
139	} else {
140	hoverInfo= annotationHover.getHoverInfo(fSourceViewer, line);
141	}
142
143	// hover region: the beginning of the concerned line to place the control right over the line
144	IDocument document= fSourceViewer.getDocument();
145	int offset= document.getLineOffset(line);
146	String contentType= TextUtilities.getContentType(document, fSourceViewerConfiguration.getConfiguredDocumentPartitioning(fSourceViewer), offset, true);
147
148	IInformationControlCreator controlCreator= null;
149	if (annotationHover instanceof IInformationProviderExtension2) // this is undocumented, but left here for backwards compatibility
150	controlCreator= ((IInformationProviderExtension2) annotationHover).getInformationPresenterControlCreator();
151	else if (annotationHover instanceof IAnnotationHoverExtension)
152	controlCreator= ((IAnnotationHoverExtension) annotationHover).getHoverControlCreator();
153
154	IInformationProvider informationProvider= new InformationProvider(new Region(offset, 0), hoverInfo, controlCreator);
155
156	setOffset(offset);
157	setAnchor(AbstractInformationControlManager.ANCHOR_RIGHT);
158	setMargins(4, 0); // AnnotationBarHoverManager sets (5,0), minus SourceViewer.GAP_SIZE_1
159	setInformationProvider(informationProvider, contentType);
160	showInformation();
161
162	return true;
163
164	} catch (BadLocationException e) {
165	return false;
166	}
167	}
168	}
169
170

Added Link Here

(-)src/org/eclipse/ui/internal/texteditor/FocusedInformationPresenter.java (+165 lines)
1	/*******************************************************************************
2	* Copyright (c) 2009 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.ui.internal.texteditor;
12
13	import org.eclipse.swt.widgets.Shell;
14
15	import org.eclipse.jface.text.AbstractInformationControlManager;
16	import org.eclipse.jface.text.BadLocationException;
17	import org.eclipse.jface.text.DefaultInformationControl;
18	import org.eclipse.jface.text.IDocument;
19	import org.eclipse.jface.text.IInformationControl;
20	import org.eclipse.jface.text.IInformationControlCreator;
21	import org.eclipse.jface.text.IRegion;
22	import org.eclipse.jface.text.ITextViewer;
23	import org.eclipse.jface.text.Region;
24	import org.eclipse.jface.text.TextUtilities;
25	import org.eclipse.jface.text.information.IInformationProvider;
26	import org.eclipse.jface.text.information.IInformationProviderExtension;
27	import org.eclipse.jface.text.information.IInformationProviderExtension2;
28	import org.eclipse.jface.text.information.InformationPresenter;
29	import org.eclipse.jface.text.source.IAnnotationHover;
30	import org.eclipse.jface.text.source.IAnnotationHoverExtension;
31	import org.eclipse.jface.text.source.ILineRange;
32	import org.eclipse.jface.text.source.ISourceViewer;
33	import org.eclipse.jface.text.source.SourceViewerConfiguration;
34
35	/**
36	* Information presenter used to present focused ("sticky") information shells.
37	*
38	* @since 3.5
39	*/
40	public class FocusedInformationPresenter extends InformationPresenter {
41
42	/**
43	* Information provider used to present focused information shells.
44	*/
45	public final static class InformationProvider implements IInformationProvider, IInformationProviderExtension, IInformationProviderExtension2 {
46
47	private IRegion fHoverRegion;
48	private Object fHoverInfo;
49	private IInformationControlCreator fControlCreator;
50
51	public InformationProvider(IRegion hoverRegion, Object hoverInfo, IInformationControlCreator controlCreator) {
52	fHoverRegion= hoverRegion;
53	fHoverInfo= hoverInfo;
54	fControlCreator= controlCreator;
55	}
56	/*
57	* @see org.eclipse.jface.text.information.IInformationProvider#getSubject(org.eclipse.jface.text.ITextViewer, int)
58	*/
59	public IRegion getSubject(ITextViewer textViewer, int invocationOffset) {
60	return fHoverRegion;
61	}
62	/**
63	* {@inheritDoc}
64	*
65	* @deprecated As of 2.1, replaced by {@link IInformationProviderExtension#getInformation2(ITextViewer, IRegion)}
66	*/
67	public String getInformation(ITextViewer textViewer, IRegion subject) {
68	return fHoverInfo == null ? null : fHoverInfo.toString();
69	}
70	/*
71	* @see org.eclipse.jface.text.information.IInformationProviderExtension#getInformation2(org.eclipse.jface.text.ITextViewer, org.eclipse.jface.text.IRegion)
72	* @since 3.2
73	*/
74	public Object getInformation2(ITextViewer textViewer, IRegion subject) {
75	return fHoverInfo;
76	}
77	/*
78	* @see org.eclipse.jface.text.information.IInformationProviderExtension2#getInformationPresenterControlCreator()
79	*/
80	public IInformationControlCreator getInformationPresenterControlCreator() {
81	return fControlCreator;
82	}
83	}
84
85	/**
86	* The default information control creator.
87	*/
88	private static class DefaultInformationControlCreator implements IInformationControlCreator {
89	public IInformationControl createInformationControl(Shell shell) {
90	return new DefaultInformationControl(shell, true);
91	}
92	}
93
94
95	private final ISourceViewer fSourceViewer;
96	private final SourceViewerConfiguration fSourceViewerConfiguration;
97
98	/**
99	* Creates a focused information presenter and installs it on the source viewer.
100	*
101	* @param sourceViewer the source viewer
102	* @param sourceViewerConfiguration the configuration
103	*/
104	public FocusedInformationPresenter(ISourceViewer sourceViewer, SourceViewerConfiguration sourceViewerConfiguration) {
105	super(new DefaultInformationControlCreator());
106	fSourceViewer= sourceViewer;
107	fSourceViewerConfiguration= sourceViewerConfiguration;
108
109	// sizes: see org.eclipse.jface.text.TextViewer.TEXT_HOVER_*_CHARS
110	setSizeConstraints(100, 12, true, true);
111	install(sourceViewer);
112	setDocumentPartitioning(sourceViewerConfiguration.getConfiguredDocumentPartitioning(sourceViewer));
113	}
114
115	/**
116	* Tries show a focused ("sticky") annotation hover.
117	*
118	* @param annotationHover the annotation hover to show
119	* @param line the line for which to show the hover
120	* @return <code>true</code> if successful, <code>false</code> otherwise
121	*/
122	public boolean openFocusedAnnotationHover(IAnnotationHover annotationHover, int line) {
123
124	try {
125	// compute the hover information
126	Object hoverInfo;
127	if (annotationHover instanceof IAnnotationHoverExtension) {
128	IAnnotationHoverExtension extension= (IAnnotationHoverExtension) annotationHover;
129	ILineRange hoverLineRange= extension.getHoverLineRange(fSourceViewer, line);
130	if (hoverLineRange == null)
131	return false;
132	final int maxVisibleLines= Integer.MAX_VALUE; // allow any number of lines being displayed, as we support scrolling
133	hoverInfo= extension.getHoverInfo(fSourceViewer, hoverLineRange, maxVisibleLines);
134	} else {
135	hoverInfo= annotationHover.getHoverInfo(fSourceViewer, line);
136	}
137
138	// hover region: the beginning of the concerned line to place the control right over the line
139	IDocument document= fSourceViewer.getDocument();
140	int offset= document.getLineOffset(line);
141	String contentType= TextUtilities.getContentType(document, fSourceViewerConfiguration.getConfiguredDocumentPartitioning(fSourceViewer), offset, true);
142
143	IInformationControlCreator controlCreator= null;
144	if (annotationHover instanceof IInformationProviderExtension2) // this is undocumented, but left here for backwards compatibility
145	controlCreator= ((IInformationProviderExtension2) annotationHover).getInformationPresenterControlCreator();
146	else if (annotationHover instanceof IAnnotationHoverExtension)
147	controlCreator= ((IAnnotationHoverExtension) annotationHover).getHoverControlCreator();
148
149	IInformationProvider informationProvider= new InformationProvider(new Region(offset, 0), hoverInfo, controlCreator);
150
151	setOffset(offset);
152	setAnchor(AbstractInformationControlManager.ANCHOR_RIGHT);
153	setMargins(4, 0); // AnnotationBarHoverManager sets (5,0), minus SourceViewer.GAP_SIZE_1
154	setInformationProvider(informationProvider, contentType);
155	showInformation();
156
157	return true;
158
159	} catch (BadLocationException e) {
160	return false;
161	}
162	}
163	}
164
165