ConfigureActionInvocationHandler.java

/*
 * Copyright (C) Heavy Lifting Software 2007.
 *
 * This file is part of MouseFeed.
 *
 * MouseFeed is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MouseFeed is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with MouseFeed.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.mousefeed.eclipse.commands;

import static org.apache.commons.lang.Validate.notNull;

import com.mousefeed.client.Messages;
import com.mousefeed.client.collector.AbstractActionDesc;
import com.mousefeed.client.collector.Collector;
import com.mousefeed.eclipse.Activator;
import java.util.Map;
import org.eclipse.core.commands.AbstractHandler;
import org.eclipse.core.commands.ExecutionEvent;
import org.eclipse.core.commands.ExecutionException;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.commands.IElementUpdater;
import org.eclipse.ui.handlers.HandlerUtil;
import org.eclipse.ui.menus.UIElement;

/**
 * Configures invocation mode for the last called action.
 * @author Andriy Palamarchuk
 */
public class ConfigureActionInvocationHandler extends AbstractHandler
        implements IElementUpdater {
    /**
     * Provides messages text.
     */
    private static final Messages MESSAGES =
            new Messages(ConfigureActionInvocationHandler.class);

    /**
     * The user activity data collector.
     */
    private final Collector collector =
        Activator.getDefault().getCollector();

    /**
     * Default constructor does nothing.
     */
    public ConfigureActionInvocationHandler() {
    }
    
    // see base
    public Object execute(final ExecutionEvent event) throws ExecutionException {
        if (getLastAction() == null) {
            return null;
        }
        final IWorkbenchWindow window =
                HandlerUtil.getActiveWorkbenchWindowChecked(event);
        final ConfigureActionInvocationDialog dlg =
                new ConfigureActionInvocationDialog(
                        window.getShell(), getLastAction());
        dlg.open();
        return null;
    }


    /**
     * Expected to be called after each detected user action.
     * @param element presents the Last Action Invocation menu item.
     * Not <code>null</code>.
     * @param parameters not used.
     */
    @SuppressWarnings("rawtypes")
    public void updateElement(final UIElement element, final Map parameters) {
        notNull(element);
        if (getLastAction() != null)
            element.setText(MESSAGES.get("menuItem.lastActionInvocation.label",
                getLastAction().getLabel()));
    }

    /**
     * The last action called by the user.
     * @return the last action. <code>null</code> if there was no action
     * called before since Eclipse started.
     */
    private AbstractActionDesc getLastAction() {
        return collector.getLastAction();
    }
}