JavaSelectAnnotationRulerAction.java example

Explorer
eclipse3-master
/*
 * Copyright (c) 2012, the Dart project authors.
 * 
 * Licensed under the Eclipse Public License v1.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 * 
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package com.google.dart.tools.ui.internal.text.editor;

import com.google.dart.tools.ui.DartToolsPlugin;
import com.google.dart.tools.ui.PreferenceConstants;
import com.google.dart.tools.ui.internal.text.DartHelpContextIds;

import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.ITextOperationTarget;
import org.eclipse.jface.text.Position;
import org.eclipse.jface.text.source.Annotation;
import org.eclipse.jface.text.source.IAnnotationAccessExtension;
import org.eclipse.jface.text.source.IAnnotationModel;
import org.eclipse.jface.text.source.ISourceViewer;
import org.eclipse.jface.text.source.IVerticalRulerInfo;
import org.eclipse.swt.widgets.Event;
import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.editors.text.EditorsUI;
import org.eclipse.ui.texteditor.AnnotationPreference;
import org.eclipse.ui.texteditor.AnnotationPreferenceLookup;
import org.eclipse.ui.texteditor.IDocumentProvider;
import org.eclipse.ui.texteditor.ITextEditor;
import org.eclipse.ui.texteditor.SelectMarkerRulerAction;

import java.util.Iterator;
import java.util.ResourceBundle;

/**
 * Action which gets triggered when selecting (annotations) in the vertical ruler.
 * <p>
 * Was originally called >code>JavaSelectMarkerRulerAction</code>.
 * </p>
 */
public class JavaSelectAnnotationRulerAction extends SelectMarkerRulerAction {

  private ITextEditor fTextEditor;
  private Position fPosition;
  private Annotation fAnnotation;
  private AnnotationPreferenceLookup fAnnotationPreferenceLookup;
  private IPreferenceStore fStore;
  private boolean fHasCorrection;
  private ResourceBundle fBundle;

  public JavaSelectAnnotationRulerAction(ResourceBundle bundle, String prefix, ITextEditor editor,
      IVerticalRulerInfo ruler) {
    super(bundle, prefix, editor, ruler);
    fBundle = bundle;
    fTextEditor = editor;

    fAnnotationPreferenceLookup = EditorsUI.getAnnotationPreferenceLookup();
    fStore = DartToolsPlugin.getDefault().getCombinedPreferenceStore();

    PlatformUI.getWorkbench().getHelpSystem().setHelp(
        this,
        DartHelpContextIds.JAVA_SELECT_MARKER_RULER_ACTION);
  }

  @Override
  public void run() {
    if (fStore.getBoolean(PreferenceConstants.EDITOR_ANNOTATION_ROLL_OVER)) {
      return;
    }

    runWithEvent(null);
  }

  @Override
  public void runWithEvent(Event event) {
    if (fAnnotation instanceof OverrideIndicatorManager.OverrideIndicator) {
      ((OverrideIndicatorManager.OverrideIndicator) fAnnotation).open();
      return;
    }

    if (fHasCorrection) {
      ITextOperationTarget operation = (ITextOperationTarget) fTextEditor.getAdapter(ITextOperationTarget.class);
      final int opCode = ISourceViewer.QUICK_ASSIST;
      if (operation != null && operation.canDoOperation(opCode)) {
        fTextEditor.selectAndReveal(fPosition.getOffset(), fPosition.getLength());
        operation.doOperation(opCode);
      }
      return;
    }

    super.run();
  }

  @Override
  public void update() {
    findJavaAnnotation();
    setEnabled(true); // super.update() might change this later

    if (fAnnotation instanceof OverrideIndicatorManager.OverrideIndicator) {
      initialize(fBundle, "JavaSelectAnnotationRulerAction.OpenSuperImplementation."); //$NON-NLS-1$
      return;
    }
//    if (fHasCorrection) {
//      DartX.todo();
////      if (false /* fAnnotation instanceof AssistAnnotation */) {
////        initialize(fBundle, "JavaSelectAnnotationRulerAction.QuickAssist."); //$NON-NLS-1$
////      } else
//      {
//        initialize(fBundle, "JavaSelectAnnotationRulerAction.QuickFix."); //$NON-NLS-1$
//      }
//      return;
//    }
//
//    initialize(fBundle, "JavaSelectAnnotationRulerAction.GotoAnnotation."); //$NON-NLS-1$;
    super.update();
  }

  private void findJavaAnnotation() {
    fPosition = null;
    fAnnotation = null;
    fHasCorrection = false;

    IAnnotationModel model = getAnyAnnotationModel();
    IAnnotationAccessExtension annotationAccess = getAnnotationAccessExtension();

    IDocument document = getDocument();
    if (model == null) {
      return;
    }

//    boolean hasAssistLightbulb = fStore.getBoolean(PreferenceConstants.EDITOR_QUICKASSIST_LIGHTBULB);

    Iterator<?> iter = model.getAnnotationIterator();
    int layer = Integer.MIN_VALUE;

    while (iter.hasNext()) {
      Annotation annotation = (Annotation) iter.next();
      if (annotation.isMarkedDeleted()) {
        continue;
      }

      int annotationLayer = layer;
      if (annotationAccess != null) {
        annotationLayer = annotationAccess.getLayer(annotation);
        if (annotationLayer < layer) {
          continue;
        }
      }

      Position position = model.getPosition(annotation);
      if (!includesRulerLine(position, document)) {
        continue;
      }

//      boolean isReadOnly = fTextEditor instanceof ITextEditorExtension
//          && ((ITextEditorExtension) fTextEditor).isEditorInputReadOnly();
//      DartX.todo();
//      if (!isReadOnly && ((
//                (hasAssistLightbulb && annotation instanceof AssistAnnotation) ||
//          DartCorrectionProcessor.hasCorrections(annotation)
//      false))) {
//        fPosition = position;
//        fAnnotation = annotation;
//        fHasCorrection = true;
//        layer = annotationLayer;
//        continue;
//      } else {
      AnnotationPreference preference = fAnnotationPreferenceLookup.getAnnotationPreference(annotation);
      if (preference == null) {
        continue;
      }

      String key = preference.getVerticalRulerPreferenceKey();
      if (key == null) {
        continue;
      }

      if (fStore.getBoolean(key)) {
        fPosition = position;
        fAnnotation = annotation;
        fHasCorrection = false;
        layer = annotationLayer;
      }
//      }
    }
  }

  /**
   * @return the {@link IAnnotationModel} or <code>null</code> if there's none. In contrast to
   *         {@link #getAnnotationModel()} does not enforce and specific type of the model.
   */
  private IAnnotationModel getAnyAnnotationModel() {
    IDocumentProvider provider = fTextEditor.getDocumentProvider();
    IEditorInput input = fTextEditor.getEditorInput();
    return provider.getAnnotationModel(input);
  }
}