refactory: added UI removed from core plugin.
[phpeclipse.git] / net.sourceforge.phpeclipse.ui / src / net / sourceforge / phpdt / internal / ui / text / java / hover / AnnotationHover.java
diff --git a/net.sourceforge.phpeclipse.ui/src/net/sourceforge/phpdt/internal/ui/text/java/hover/AnnotationHover.java b/net.sourceforge.phpeclipse.ui/src/net/sourceforge/phpdt/internal/ui/text/java/hover/AnnotationHover.java
new file mode 100644 (file)
index 0000000..d18653e
--- /dev/null
@@ -0,0 +1,160 @@
+/*******************************************************************************
+ * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * All rights reserved. This program and the accompanying materials 
+ * are made available under the terms of the Common Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/cpl-v10.html
+ * 
+ * Contributors:
+ *     IBM Corporation - initial API and implementation
+ *******************************************************************************/
+
+package net.sourceforge.phpdt.internal.ui.text.java.hover;
+
+import java.util.Iterator;
+
+import net.sourceforge.phpdt.internal.ui.text.HTMLPrinter;
+import net.sourceforge.phpdt.ui.PreferenceConstants;
+//import net.sourceforge.phpeclipse.PHPeclipsePlugin;
+import net.sourceforge.phpeclipse.phpeditor.JavaAnnotationIterator;
+import net.sourceforge.phpeclipse.phpeditor.PHPTextHover;
+import net.sourceforge.phpeclipse.phpeditor.PHPUnitEditor;
+import net.sourceforge.phpeclipse.ui.WebUI;
+
+import org.eclipse.core.resources.IFile;
+import org.eclipse.jface.preference.IPreferenceStore;
+import org.eclipse.jface.text.IRegion;
+import org.eclipse.jface.text.ITextViewer;
+import org.eclipse.jface.text.Position;
+import org.eclipse.jface.text.source.Annotation;
+import org.eclipse.jface.text.source.IAnnotationModel;
+import org.eclipse.ui.IEditorInput;
+import org.eclipse.ui.IEditorPart;
+import org.eclipse.ui.IFileEditorInput;
+import org.eclipse.ui.editors.text.EditorsUI;
+import org.eclipse.ui.texteditor.AnnotationPreference;
+import org.eclipse.ui.texteditor.DefaultMarkerAnnotationAccess;
+import org.eclipse.ui.texteditor.IDocumentProvider;
+
+public class AnnotationHover extends AbstractJavaEditorTextHover {
+
+       // private IPreferenceStore fStore =
+       // PHPeclipsePlugin.getDefault().getPreferenceStore();
+       private IPreferenceStore fStore = EditorsUI.getPreferenceStore();
+
+       private DefaultMarkerAnnotationAccess fAnnotationAccess = new DefaultMarkerAnnotationAccess();
+
+       private PHPTextHover fPHPTextHover = null;
+
+       /*
+        * Formats a message as HTML text.
+        */
+       private String formatMessage(String message) {
+               StringBuffer buffer = new StringBuffer();
+               HTMLPrinter.addPageProlog(buffer);
+               HTMLPrinter.addParagraph(buffer, message); // HTMLPrinter.convertToHTMLContent(message));
+               HTMLPrinter.addPageEpilog(buffer);
+               return buffer.toString();
+       }
+
+       /*
+        * @see ITextHover#getHoverInfo(ITextViewer, IRegion)
+        */
+       public String getHoverInfo(ITextViewer textViewer, IRegion hoverRegion) {
+
+               if (getEditor() == null)
+                       return null;
+
+               IDocumentProvider provider = WebUI.getDefault()
+                               .getCompilationUnitDocumentProvider();
+               IAnnotationModel model = provider.getAnnotationModel(getEditor()
+                               .getEditorInput());
+               String message = null;
+               if (model != null) {
+                       Iterator e = new JavaAnnotationIterator(model, true);
+                       int layer = -1;
+
+                       while (e.hasNext()) {
+                               Annotation a = (Annotation) e.next();
+
+                               AnnotationPreference preference = getAnnotationPreference(a);
+                               if (preference == null
+                                               || !(fStore.getBoolean(preference
+                                                               .getTextPreferenceKey()) || (preference
+                                                               .getHighlightPreferenceKey() != null && fStore
+                                                               .getBoolean(preference
+                                                                               .getHighlightPreferenceKey()))))
+                                       continue;
+
+                               Position p = model.getPosition(a);
+
+                               int l = fAnnotationAccess.getLayer(a);
+
+                               if (l > layer
+                                               && p != null
+                                               && p.overlapsWith(hoverRegion.getOffset(), hoverRegion
+                                                               .getLength())) {
+                                       String msg = a.getText();
+                                       if (msg != null && msg.trim().length() > 0) {
+                                               message = msg;
+                                               layer = l;
+                                       }
+                               }
+                       }
+                       if (layer > -1)
+                               return formatMessage(message);
+               }
+               // Added as long as the above doesn't work
+               if (fPHPTextHover != null) {
+                       message = fPHPTextHover.getHoverInfo(textViewer, hoverRegion);
+                       if (message != null) {
+                               return formatMessage(message);
+                       }
+               }
+               return null;
+       }
+
+       /*
+        * @see IJavaEditorTextHover#setEditor(IEditorPart)
+        */
+       public void setEditor(IEditorPart editor) {
+               if (editor instanceof PHPUnitEditor) {
+                       super.setEditor(editor);
+                       if (editor != null) {
+                               IEditorInput editorInput = editor.getEditorInput();
+                               if (editorInput instanceof IFileEditorInput) {
+                                       try {
+                                               IFile f = ((IFileEditorInput) editorInput).getFile();
+                                               fPHPTextHover = new PHPTextHover(f.getProject());
+                                               return;
+                                       } catch (NullPointerException e) {
+                                               // this exception occurs, if getTextHover is called by
+                                               // preference pages !
+                                       }
+                               }
+                       }
+                       fPHPTextHover = new PHPTextHover(null);
+               } else {
+                       super.setEditor(null);
+               }
+       }
+
+       /**
+        * Returns the annotation preference for the given annotation.
+        * 
+        * @param annotation
+        *            the annotation
+        * @return the annotation preference or <code>null</code> if none
+        */
+       private AnnotationPreference getAnnotationPreference(Annotation annotation) {
+
+               if (annotation.isMarkedDeleted())
+                       return null;
+               return EditorsUI.getAnnotationPreferenceLookup()
+                               .getAnnotationPreference(annotation);
+       }
+
+       static boolean isJavaProblemHover(String id) {
+               return PreferenceConstants.ID_PROBLEM_HOVER.equals(id);
+       }
+}