org.eclipse.ui.IActionDelegate2 Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2000, 2015 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.ui;
import org.eclipse.jface.action.IAction;
import org.eclipse.swt.widgets.Event;
/**
* Interface extension to IActionDelegate adding lifecycle methods.
* In addition, a runWithEvent method that includes the triggering
* SWT event.
*
* An action delegate that implements this interface will have its
* runWithEvent(IAction, Event) called instead of its
* run(IAction) method.
*
*
* Clients should implement this interface, in addition to
* IActionDelegate or sub-interfaces, if interested in the
* triggering event or in the lifecycle of the delegate object.
*
*
* Clients can choose to subclass the provided abstract implementation
* org. eclipse. ui. actions. ActionDelegate or implement the
* interface directly.
*
*
* @see org.eclipse.ui.actions.ActionDelegate
* @see org.eclipse.ui.IActionDelegate
* @since 2.1
*/
public interface IActionDelegate2 extends IActionDelegate {
/**
* Allows the action delegate to initialize itself after being created by the
* proxy action. This lifecycle method is called after the action delegate has
* been created and before any other method of the action delegate is called.
*
* @param action the proxy action that handles the presentation portion of the
* action.
*/
void init(IAction action);
/**
* Allows the action delegate to clean up. This lifecycle method is called when
* the proxy action is done with this action delegate. This is the last method
* called.
*/
void dispose();
/**
* Performs this action, passing the SWT event which triggered it. This method
* is called by the proxy action when the action has been triggered. Implement
* this method to do the actual work.
*
* Note: This method is called instead of run(IAction).
*
*
* @param action the action proxy that handles the presentation portion of the
* action
* @param event the SWT event which triggered this action being run
* @since 2.0
*/
void runWithEvent(IAction action, Event event);
}