/*******************************************************************************
* 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
* Zend Technologies
*******************************************************************************/
/**
*
*/
package org.eclipse.php.internal.ui.editor;
import java.util.Iterator;
import java.util.ResourceBundle;
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.ISourceViewer;
import org.eclipse.jface.text.source.IVerticalRulerInfo;
import org.eclipse.php.internal.ui.PHPUiPlugin;
import org.eclipse.php.internal.ui.preferences.PreferenceConstants;
import org.eclipse.php.internal.ui.text.correction.PHPCorrectionProcessor;
import org.eclipse.php.internal.ui.text.correction.QuickAssistLightBulbUpdater.AssistAnnotation;
import org.eclipse.swt.widgets.Event;
import org.eclipse.ui.editors.text.EditorsUI;
import org.eclipse.ui.texteditor.*;
/**
* Action which gets triggered when selecting (annotations) in the vertical
* ruler.
*
* <p>
* Was originally called >code>JavaSelectMarkerRulerAction</code>.
* </p>
*/
public class PhpSelectAnnotationRulerAction extends SelectMarkerRulerAction {
private ITextEditor fTextEditor;
private Position fPosition;
private Annotation fAnnotation;
private AnnotationPreferenceLookup fAnnotationPreferenceLookup;
private IPreferenceStore fStore;
private boolean fHasCorrection;
private ResourceBundle fBundle;
public PhpSelectAnnotationRulerAction(ResourceBundle bundle, String prefix,
ITextEditor editor, IVerticalRulerInfo ruler) {
super(bundle, prefix, editor, ruler);
fBundle = bundle;
fTextEditor = editor;
fAnnotationPreferenceLookup = EditorsUI.getAnnotationPreferenceLookup();
fStore = PHPUiPlugin.getDefault().getPreferenceStore();
// HELP - PlatformUI.getWorkbench().getHelpSystem().setHelp(this,
// IJavaHelpContextIds.JAVA_SELECT_MARKER_RULER_ACTION);
}
/*
* (non-Javadoc)
*
* @see org.eclipse.ui.texteditor.SelectMarkerRulerAction#run()
*/
public void run() {
if (fStore.getBoolean(PreferenceConstants.EDITOR_ANNOTATION_ROLL_OVER)) {
return;
}
runWithEvent(null);
}
/*
* @see
* org.eclipse.jface.action.IAction#runWithEvent(org.eclipse.swt.widgets
* .Event)
*
* @since 3.2
*/
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();
}
/*
* (non-Javadoc)
*
* @see org.eclipse.ui.texteditor.SelectMarkerRulerAction#update()
*/
public void update() {
findPhpAnnotation();
setEnabled(true); // super.update() might change this later
if (fAnnotation instanceof OverrideIndicatorManager.OverrideIndicator) {
initialize(fBundle,
"PhpSelectAnnotationRulerAction_OpenSuperImplementation_"); //$NON-NLS-1$
return;
}
if (fHasCorrection) {
if (fAnnotation instanceof AssistAnnotation)
initialize(fBundle,
"PhpSelectAnnotationRulerAction_QuickAssist_"); //$NON-NLS-1$
else
initialize(fBundle, "PhpSelectAnnotationRulerAction_QuickFix_"); //$NON-NLS-1$
return;
}
initialize(fBundle, "PhpSelectAnnotationRulerAction_GotoAnnotation_"); //$NON-NLS-1$;
super.update();
}
private void findPhpAnnotation() {
fPosition = null;
fAnnotation = null;
fHasCorrection = false;
AbstractMarkerAnnotationModel model = getAnnotationModel();
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();
if (!isReadOnly
&& (((hasAssistLightbulb && annotation instanceof AssistAnnotation) || PHPCorrectionProcessor
.hasCorrections(annotation)))) {
fPosition = position;
fAnnotation = annotation;
fHasCorrection = true;
layer = annotationLayer;
continue;
} else if (!fHasCorrection) {
AnnotationPreference preference = fAnnotationPreferenceLookup
.getAnnotationPreference(annotation);
if (preference == null)
continue;
String key = preference.getVerticalRulerPreferenceKey();
if (key == null)
continue;
// if (fStore.getBoolean(key)) {
if (annotation instanceof OverrideIndicatorManager.OverrideIndicator) {
fPosition = position;
fAnnotation = annotation;
fHasCorrection = false;
layer = annotationLayer;
}
}
}
}
}