JAL-1432 updated copyright notices
[jalview.git] / src / jalview / ws / WSMenuEntryProviderI.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
3  * Copyright (C) 2014 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 of the License, or (at your option) any later version.
10  *  
11  * Jalview is distributed in the hope that it will be useful, but 
12  * WITHOUT ANY WARRANTY; without even the implied warranty 
13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
14  * PURPOSE.  See the GNU General Public License for more details.
15  * 
16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
17  * The Jalview Authors are detailed in the 'AUTHORS' file.
18  */
19 package jalview.ws;
20
21 import jalview.gui.AlignFrame;
22
23 import javax.swing.JMenu;
24
25 public interface WSMenuEntryProviderI
26 {
27   /**
28    * Called by the AlignFrame web service menu constructor to enable a service
29    * instance to add menu entries. Usually, any actionperformed methods
30    * associated with menu items will create new instances of GUI classes to
31    * handle the action in a thread-safe manner.
32    * 
33    * @param wsmenu
34    *          the menu to which any menu entries/sub menus are to be attached
35    * @param alignFrame
36    *          the alignFrame instance that provides input data for the service
37    */
38   public void attachWSMenuEntry(JMenu wsmenu, final AlignFrame alignFrame);
39 }