IActionDelegateWithEvent


1   /*******************************************************************************
2    * Copyright (c) 2000, 2005 IBM Corporation and others.
3    * All rights reserved. This program and the accompanying materials
4    * are made available under the terms of the Eclipse Public License v1.0
5    * which accompanies this distribution, and is available at
6    * http://www.eclipse.org/legal/epl-v10.html
7    *
8    * Contributors:
9    *     IBM Corporation - initial API and implementation
10   *******************************************************************************/
11  package org.eclipse.ui;
12  
13  import org.eclipse.jface.action.IAction;
14  import org.eclipse.swt.widgets.Event;
15  
16  /**
17   * This interface is a mixin interface for action delegates, adding the ability to
18   * examine the triggering SWT event when it is run.
19   * If an action delegate implements this interface, then <code>runWithEvent(IAction, Event)</code>
20   * is called instead of <code>run(IAction)</code>.
21   * <p>
22   * Clients should implement this interface, in addition to <code>IActionDelegate</code> 
23   * (or subinterface), if they need to examine the triggering event.
24   * Otherwise, they should simply implement <code>IActionDelegate</code> (or subinterface).
25   * <p>
26   *
27   * @since 2.0
28   * @deprecated Use org.eclipse.ui.IActionDelegate2 instead.
29   */
30  public interface IActionDelegateWithEvent {
31  
32      /**
33       * Performs this action, passing the SWT event which triggered it.
34       * <p>
35       * This method is called when the delegating action has been triggered.
36       * Implement this method to do the actual work.
37       * If an action delegate implements this interface, this method
38       * is called instead of <code>run(IAction)</code>.
39       * <p>
40       *
41       * @param action the action proxy that handles the presentation portion of the action
42       * @param event the SWT event which triggered this action being run 
43       * @since  2.0
44       * @deprecated Use org.eclipse.ui.IActionDelegate2 instead.
45       */
46      public void runWithEvent(IAction action, Event event);
47  
48  }
49
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags