bundles/org.simantics.browsing.ui.swt/src/org/simantics/browsing/ui/swt/IContextMenuInitializer.java

   1 /*******************************************************************************
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management
   3  * in Industry THTH ry.
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License v1.0
   6  * which accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *     VTT Technical Research Centre of Finland - initial API and implementation
  11  *******************************************************************************/
  12 package org.simantics.browsing.ui.swt;
  13
  14 import org.eclipse.jface.action.IMenuManager;
  15 import org.eclipse.jface.viewers.ISelectionProvider;
  16 import org.eclipse.swt.widgets.Control;
  17 import org.eclipse.ui.IWorkbenchSite;
  18
  19 /**
  20  * An interface for defining an initializer for an SWT context menu with a JFace
  21  * selection provider.
  22  *
  23  * @author Tuukka Lehtonen
  24  * @see ContextMenuInitializer
  25  */
  26 public interface IContextMenuInitializer {
  27
  28     /**
  29      * @param control the explorer component to add a context menu into
  30      * @param selectionProvider a provider for the selection of the specified control
  31      * @param site the workbench site to register the context menu for, may be
  32      *        <code>null</code>
  33      * @return the created context menu manager
  34      */
  35     IMenuManager createContextMenu(
  36             Control control,
  37             ISelectionProvider selectionProvider,
  38             IWorkbenchSite site);
  39
  40 }