src/jalview/ws/WSMenuEntryProviderI.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.ws;
  22
  23 import jalview.gui.AlignFrame;
  24
  25 import javax.swing.JMenu;
  26
  27 public interface WSMenuEntryProviderI
  28 {
  29   /**
  30    * Called by the AlignFrame web service menu constructor to enable a service
  31    * instance to add menu entries. Usually, any actionperformed methods
  32    * associated with menu items will create new instances of GUI classes to
  33    * handle the action in a thread-safe manner.
  34    *
  35    * @param wsmenu
  36    *          the menu to which any menu entries/sub menus are to be attached
  37    * @param alignFrame
  38    *          the alignFrame instance that provides input data for the service
  39    */
  40   public void attachWSMenuEntry(JMenu wsmenu, final AlignFrame alignFrame);
  41 }