ShowRuleAction.java

package net.sourceforge.pmd.eclipse.ui.views.actions;

import net.sourceforge.pmd.Rule;
import net.sourceforge.pmd.eclipse.plugin.PMDPlugin;
import net.sourceforge.pmd.eclipse.runtime.builder.MarkerUtil;
import net.sourceforge.pmd.eclipse.ui.nls.StringKeys;
import net.sourceforge.pmd.eclipse.ui.preferences.RuleDialog;

import org.eclipse.core.resources.IMarker;
import org.eclipse.jface.viewers.TableViewer;
import org.eclipse.swt.widgets.Shell;

/**
 * Implements the call of the rule dialog to show rule data
 *
 * @author Philippe Herlin
 *
 */
public class ShowRuleAction extends AbstractViolationSelectionAction {

    private Shell shell;

    /**
     * Constructor
     */
    public ShowRuleAction(TableViewer viewer, Shell shell) {
        super(viewer);
    }

 	protected String textId() { return StringKeys.VIEW_ACTION_SHOW_RULE; }
 	
 	protected String imageId() { return null; }
    
    protected String tooltipMsgId() { return StringKeys.VIEW_TOOLTIP_SHOW_RULE; } 
    
    protected boolean canExecute() {
    	return super.canExecute() && allSelectionsDenoteSameRule();
    }
    
    private boolean allSelectionsDenoteSameRule() {
    	
    	IMarker[] markers = getSelectedViolations();
    	return MarkerUtil.commonRuleNameAmong(markers) != null;
    }
    
    /**
     * @see org.eclipse.jface.action.IAction#run()
     */
    public void run() {
        Rule selectedRule = getSelectedViolationRule();
        if (selectedRule != null) {
            RuleDialog ruleDialog = new RuleDialog(shell, selectedRule, false);
            ruleDialog.open();
        }
    }

    /**
     * Returns the rule from the first selected violation
     */
    public Rule getSelectedViolationRule() {
        Rule rule = null;
        try {
            IMarker[] markers = getSelectedViolations();
            if (markers != null) {
                rule = PMDPlugin.getDefault().getPreferencesManager().getRuleSet().getRuleByName(
                        MarkerUtil.ruleNameFor(markers[0])
                        );
            }
        } catch (RuntimeException e) {
        	logErrorByKey(StringKeys.ERROR_RUNTIME_EXCEPTION, e);
        }

        return rule;
    }
}