File: IActionDelegateWithEvent.java

package info (click to toggle)
eclipse-platform-ui 4.10-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 71,188 kB
  • sloc: java: 611,660; xml: 21,221; sh: 602; makefile: 5
file content (52 lines) | stat: -rw-r--r-- 2,030 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
/*******************************************************************************
 * 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;

/**
 * This interface is a mixin interface for action delegates, adding the ability to
 * examine the triggering SWT event when it is run.
 * If an action delegate implements this interface, then <code>runWithEvent(IAction, Event)</code>
 * is called instead of <code>run(IAction)</code>.
 * <p>
 * Clients should implement this interface, in addition to <code>IActionDelegate</code>
 * (or subinterface), if they need to examine the triggering event.
 * Otherwise, they should simply implement <code>IActionDelegate</code> (or subinterface).
 * <p>
 *
 * @since 2.0
 * @deprecated Use org.eclipse.ui.IActionDelegate2 instead.
 */
@Deprecated
public interface IActionDelegateWithEvent {

    /**
     * Performs this action, passing the SWT event which triggered it.
     * <p>
     * This method is called when the delegating action has been triggered.
     * Implement this method to do the actual work.
     * If an action delegate implements this interface, this method
     * is called instead of <code>run(IAction)</code>.
     * <p>
     *
     * @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
     * @deprecated Use org.eclipse.ui.IActionDelegate2 instead.
     */
    @Deprecated void runWithEvent(IAction action, Event event);

}