JAL-3056 suppress menu options, and repoint Help, for JalviewJS
[jalview.git] / src / jalview / jbgui / GDesktop.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.jbgui;
22
23 import jalview.api.AlignmentViewPanel;
24 import jalview.bin.Jalview;
25 import jalview.io.FileFormatException;
26 import jalview.util.MessageManager;
27 import jalview.util.Platform;
28
29 import java.awt.FlowLayout;
30 import java.awt.Toolkit;
31 import java.awt.event.ActionEvent;
32 import java.awt.event.ActionListener;
33
34 import javax.swing.JCheckBoxMenuItem;
35 import javax.swing.JFrame;
36 import javax.swing.JMenu;
37 import javax.swing.JMenuBar;
38 import javax.swing.JMenuItem;
39
40 /**
41  * DOCUMENT ME!
42  * 
43  * @author $author$
44  * @version $Revision$
45  */
46 public class GDesktop extends JFrame
47 {
48   protected static JMenu windowMenu = new JMenu();
49
50   JMenuBar desktopMenubar = new JMenuBar();
51
52   JMenu FileMenu = new JMenu();
53
54   JMenu HelpMenu = new JMenu();
55
56   protected JMenu VamsasMenu = new JMenu();
57
58   protected JMenu VamsasStMenu = new JMenu();
59
60   JMenuItem inputLocalFileMenuItem = new JMenuItem();
61
62   JMenuItem inputURLMenuItem = new JMenuItem();
63
64   JMenuItem inputTextboxMenuItem = new JMenuItem();
65
66   JMenuItem quit = new JMenuItem();
67
68   JMenuItem aboutMenuItem = new JMenuItem();
69
70   JMenuItem documentationMenuItem = new JMenuItem();
71
72   FlowLayout flowLayout1 = new FlowLayout();
73
74   protected JMenu toolsMenu = new JMenu();
75
76   JMenuItem preferences = new JMenuItem();
77
78   JMenuItem saveState = new JMenuItem();
79
80   JMenuItem loadState = new JMenuItem();
81
82   JMenu inputMenu = new JMenu();
83
84   protected JMenuItem vamsasStart = new JMenuItem();
85
86   protected JMenuItem vamsasImport = new JMenuItem();
87
88   protected JMenuItem vamsasSave = new JMenuItem();
89
90   JMenuItem inputSequence = new JMenuItem();
91
92   protected JMenuItem vamsasStop = new JMenuItem();
93
94   JMenuItem closeAll = new JMenuItem();
95
96   JMenuItem raiseRelated = new JMenuItem();
97
98   JMenuItem minimizeAssociated = new JMenuItem();
99
100   protected JCheckBoxMenuItem showMemusage = new JCheckBoxMenuItem();
101
102   JMenuItem garbageCollect = new JMenuItem();
103
104   protected JMenuItem groovyShell;
105
106   protected JCheckBoxMenuItem experimentalFeatures;
107
108   protected JCheckBoxMenuItem showConsole = new JCheckBoxMenuItem();
109
110   protected JCheckBoxMenuItem showNews = new JCheckBoxMenuItem();
111
112   protected JMenuItem snapShotWindow = new JMenuItem();
113
114   /**
115    * Creates a new GDesktop object.
116    */
117   public GDesktop()
118   {
119     super();
120     try
121     {
122       jbInit();
123       this.setJMenuBar(desktopMenubar);
124     } catch (Exception e)
125     {
126       e.printStackTrace();
127     }
128
129     if (!Platform.isAMac())
130     {
131       FileMenu.setMnemonic('F');
132       inputLocalFileMenuItem.setMnemonic('L');
133       VamsasMenu.setMnemonic('V');
134       inputURLMenuItem.setMnemonic('U');
135       inputTextboxMenuItem.setMnemonic('C');
136       quit.setMnemonic('Q');
137       saveState.setMnemonic('S');
138       loadState.setMnemonic('L');
139       inputMenu.setMnemonic('I');
140     }
141   }
142
143   /**
144    * DOCUMENT ME!
145    * 
146    * @throws Exception
147    *           DOCUMENT ME!
148    */
149   private void jbInit() throws Exception
150   {
151
152     FileMenu.setText(MessageManager.getString("action.file"));
153     HelpMenu.setText(MessageManager.getString("action.help"));
154     VamsasMenu.setText("Vamsas");
155     VamsasMenu.setToolTipText(MessageManager
156             .getString("label.share_data_vamsas_applications"));
157     VamsasStMenu.setText(MessageManager.getString("label.connect_to"));
158     VamsasStMenu.setToolTipText(
159             MessageManager.getString("label.join_existing_vamsas_session"));
160     inputLocalFileMenuItem
161             .setText(MessageManager.getString("label.load_tree_from_file"));
162     inputLocalFileMenuItem.setAccelerator(
163             javax.swing.KeyStroke.getKeyStroke(java.awt.event.KeyEvent.VK_O,
164                     Toolkit.getDefaultToolkit().getMenuShortcutKeyMask(),
165                     false));
166     inputLocalFileMenuItem
167             .addActionListener(new java.awt.event.ActionListener()
168             {
169               @Override
170               public void actionPerformed(ActionEvent e)
171               {
172                 inputLocalFileMenuItem_actionPerformed(null);
173               }
174             });
175     inputURLMenuItem.setText(MessageManager.getString("label.from_url"));
176     inputURLMenuItem.addActionListener(new java.awt.event.ActionListener()
177     {
178       @Override
179       public void actionPerformed(ActionEvent e)
180       {
181         try
182         {
183           inputURLMenuItem_actionPerformed(null);
184         } catch (FileFormatException e1)
185         {
186           System.err.println("Error loading from URL: " + e1.getMessage());
187         }
188       }
189     });
190     inputTextboxMenuItem
191             .setText(MessageManager.getString("label.from_textbox"));
192     inputTextboxMenuItem
193             .addActionListener(new java.awt.event.ActionListener()
194             {
195               @Override
196               public void actionPerformed(ActionEvent e)
197               {
198                 inputTextboxMenuItem_actionPerformed(null);
199               }
200             });
201     quit.setText(MessageManager.getString("action.quit"));
202     quit.addActionListener(new java.awt.event.ActionListener()
203     {
204       @Override
205       public void actionPerformed(ActionEvent e)
206       {
207         quit();
208       }
209     });
210     aboutMenuItem.setText(MessageManager.getString("label.about"));
211     aboutMenuItem.addActionListener(new java.awt.event.ActionListener()
212     {
213       @Override
214       public void actionPerformed(ActionEvent e)
215       {
216         aboutMenuItem_actionPerformed(e);
217       }
218     });
219     documentationMenuItem
220             .setText(MessageManager.getString("label.documentation"));
221     documentationMenuItem.setAccelerator(javax.swing.KeyStroke
222             .getKeyStroke(java.awt.event.KeyEvent.VK_F1, 0, false));
223     documentationMenuItem
224             .addActionListener(new java.awt.event.ActionListener()
225             {
226               @Override
227               public void actionPerformed(ActionEvent e)
228               {
229                 documentationMenuItem_actionPerformed();
230               }
231             });
232     this.getContentPane().setLayout(flowLayout1);
233     windowMenu.setText(MessageManager.getString("label.window"));
234     preferences.setText(MessageManager.getString("label.preferences"));
235     preferences.addActionListener(new ActionListener()
236     {
237       @Override
238       public void actionPerformed(ActionEvent e)
239       {
240         preferences_actionPerformed(e);
241       }
242     });
243     toolsMenu.setText(MessageManager.getString("label.tools"));
244     saveState.setText(MessageManager.getString("action.save_project"));
245     saveState.addActionListener(new ActionListener()
246     {
247       @Override
248       public void actionPerformed(ActionEvent e)
249       {
250         saveState_actionPerformed();
251       }
252     });
253     loadState.setText(MessageManager.getString("action.load_project"));
254     loadState.addActionListener(new ActionListener()
255     {
256       @Override
257       public void actionPerformed(ActionEvent e)
258       {
259         loadState_actionPerformed();
260       }
261     });
262     inputMenu.setText(MessageManager.getString("label.input_alignment"));
263     vamsasStart
264             .setText(MessageManager.getString("label.new_vamsas_session"));
265     vamsasStart.setVisible(false);
266     vamsasStart.addActionListener(new ActionListener()
267     {
268       @Override
269       public void actionPerformed(ActionEvent e)
270       {
271         vamsasStart_actionPerformed(e);
272       }
273     });
274     vamsasImport.setText(
275             MessageManager.getString("action.load_vamsas_session"));
276     vamsasImport.setVisible(false);
277     vamsasImport.addActionListener(new ActionListener()
278     {
279       @Override
280       public void actionPerformed(ActionEvent e)
281       {
282         vamsasImport_actionPerformed(e);
283       }
284     });
285     vamsasSave.setText(
286             MessageManager.getString("action.save_vamsas_session"));
287     vamsasSave.setVisible(false);
288     vamsasSave.addActionListener(new ActionListener()
289     {
290       @Override
291       public void actionPerformed(ActionEvent e)
292       {
293         vamsasSave_actionPerformed(e);
294       }
295     });
296     inputSequence
297             .setText(MessageManager.getString("action.fetch_sequences"));
298     inputSequence.addActionListener(new ActionListener()
299     {
300       @Override
301       public void actionPerformed(ActionEvent e)
302       {
303         inputSequence_actionPerformed(e);
304       }
305     });
306     vamsasStop
307             .setText(MessageManager.getString("label.stop_vamsas_session"));
308     vamsasStop.setVisible(false);
309     vamsasStop.addActionListener(new ActionListener()
310     {
311       @Override
312       public void actionPerformed(ActionEvent e)
313       {
314         vamsasStop_actionPerformed(e);
315       }
316     });
317     closeAll.setText(MessageManager.getString("action.close_all"));
318     closeAll.addActionListener(new ActionListener()
319     {
320       @Override
321       public void actionPerformed(ActionEvent e)
322       {
323         closeAll_actionPerformed(e);
324       }
325     });
326     raiseRelated.setText(
327             MessageManager.getString("action.raise_associated_windows"));
328     raiseRelated.addActionListener(new ActionListener()
329     {
330       @Override
331       public void actionPerformed(ActionEvent e)
332       {
333         raiseRelated_actionPerformed(e);
334       }
335     });
336     minimizeAssociated.setText(
337             MessageManager.getString("action.minimize_associated_windows"));
338     minimizeAssociated.addActionListener(new ActionListener()
339     {
340       @Override
341       public void actionPerformed(ActionEvent e)
342       {
343         minimizeAssociated_actionPerformed(e);
344       }
345     });
346     garbageCollect
347             .setText(MessageManager.getString("label.collect_garbage"));
348     garbageCollect.addActionListener(new ActionListener()
349     {
350       @Override
351       public void actionPerformed(ActionEvent e)
352       {
353         garbageCollect_actionPerformed(e);
354       }
355     });
356     showMemusage
357             .setText(MessageManager.getString("label.show_memory_usage"));
358     showMemusage.addActionListener(new ActionListener()
359     {
360       @Override
361       public void actionPerformed(ActionEvent e)
362       {
363         showMemusage_actionPerformed(e);
364       }
365     });
366     showConsole
367             .setText(MessageManager.getString("label.show_java_console"));
368     showConsole.addActionListener(new ActionListener()
369     {
370       @Override
371       public void actionPerformed(ActionEvent e)
372       {
373         showConsole_actionPerformed(e);
374       }
375     });
376     showNews.setText(MessageManager.getString("label.show_jalview_news"));
377     showNews.addActionListener(new ActionListener()
378     {
379       @Override
380       public void actionPerformed(ActionEvent e)
381       {
382         showNews_actionPerformed(e);
383       }
384     });
385     groovyShell = new JMenuItem();
386     groovyShell.setText(MessageManager.getString("label.groovy_console"));
387     groovyShell.addActionListener(new ActionListener()
388     {
389       @Override
390       public void actionPerformed(ActionEvent e)
391       {
392         groovyShell_actionPerformed();
393       }
394     });
395     experimentalFeatures = new JCheckBoxMenuItem();
396     experimentalFeatures
397             .setText(MessageManager.getString("label.show_experimental"));
398     experimentalFeatures.setToolTipText(
399             MessageManager.getString("label.show_experimental_tip"));
400     experimentalFeatures.addActionListener(new ActionListener()
401     {
402       @Override
403       public void actionPerformed(ActionEvent e)
404       {
405         showExperimental_actionPerformed(experimentalFeatures.isSelected());
406       }
407     });
408
409     snapShotWindow.setText(MessageManager.getString("label.take_snapshot"));
410     snapShotWindow.addActionListener(new ActionListener()
411     {
412       @Override
413       public void actionPerformed(ActionEvent e)
414       {
415         snapShotWindow_actionPerformed(e);
416       }
417     });
418
419     desktopMenubar.add(FileMenu);
420     desktopMenubar.add(toolsMenu);
421     VamsasMenu.setVisible(false);
422     desktopMenubar.add(VamsasMenu);
423     desktopMenubar.add(HelpMenu);
424     desktopMenubar.add(windowMenu);
425     FileMenu.add(inputMenu);
426     FileMenu.add(inputSequence);
427     if (!Jalview.isJS())
428     {
429       FileMenu.addSeparator();
430       FileMenu.add(saveState);
431       FileMenu.add(loadState);
432     }
433     FileMenu.addSeparator();
434     FileMenu.add(quit);
435     HelpMenu.add(aboutMenuItem);
436     HelpMenu.add(documentationMenuItem);
437     VamsasMenu.add(VamsasStMenu);
438     VamsasStMenu.setVisible(false);
439     VamsasMenu.add(vamsasStart);
440     VamsasMenu.add(vamsasImport);
441     VamsasMenu.add(vamsasSave);
442     VamsasMenu.add(vamsasStop);
443     toolsMenu.add(preferences);
444     if (!Jalview.isJS())
445     {
446       toolsMenu.add(showMemusage);
447       toolsMenu.add(showConsole);
448     }
449     toolsMenu.add(showNews);
450     if (!Jalview.isJS())
451     {
452       toolsMenu.add(garbageCollect);
453       toolsMenu.add(groovyShell);
454     }
455     toolsMenu.add(experimentalFeatures);
456     // toolsMenu.add(snapShotWindow);
457     inputMenu.add(inputLocalFileMenuItem);
458     inputMenu.add(inputURLMenuItem);
459     inputMenu.add(inputTextboxMenuItem);
460     windowMenu.add(closeAll);
461     windowMenu.add(raiseRelated);
462     windowMenu.add(minimizeAssociated);
463     windowMenu.addSeparator();
464     // inputMenu.add(vamsasLoad);
465   }
466
467   protected void showExperimental_actionPerformed(boolean selected)
468   {
469   }
470
471   protected void groovyShell_actionPerformed()
472   {
473   }
474
475   protected void snapShotWindow_actionPerformed(ActionEvent e)
476   {
477     // TODO Auto-generated method stub
478
479   }
480
481   protected void showConsole_actionPerformed(ActionEvent e)
482   {
483     // TODO Auto-generated method stub
484
485   }
486
487   protected void showNews_actionPerformed(ActionEvent e)
488   {
489     // TODO Auto-generated method stub
490
491   }
492
493   protected void showMemusage_actionPerformed(ActionEvent e)
494   {
495     // TODO Auto-generated method stub
496
497   }
498
499   protected void garbageCollect_actionPerformed(ActionEvent e)
500   {
501     // TODO Auto-generated method stub
502
503   }
504
505   protected void vamsasStMenu_actionPerformed()
506   {
507   }
508
509   public void vamsasSave_actionPerformed(ActionEvent e)
510   {
511   }
512
513   /**
514    * DOCUMENT ME!
515    * 
516    * @param e
517    *          DOCUMENT ME!
518    */
519   protected void inputLocalFileMenuItem_actionPerformed(
520           jalview.gui.AlignViewport av)
521   {
522   }
523
524   /**
525    * DOCUMENT ME!
526    * 
527    * @param e
528    *          DOCUMENT ME!
529    * @throws FileFormatException
530    */
531   protected void inputURLMenuItem_actionPerformed(
532           jalview.gui.AlignViewport av) throws FileFormatException
533   {
534   }
535
536   /**
537    * DOCUMENT ME!
538    * 
539    * @param e
540    *          DOCUMENT ME!
541    */
542   protected void inputTextboxMenuItem_actionPerformed(
543           AlignmentViewPanel avp)
544   {
545   }
546
547   /**
548    * DOCUMENT ME!
549    */
550   protected void quit()
551   {
552   }
553
554   /**
555    * DOCUMENT ME!
556    * 
557    * @param e
558    *          DOCUMENT ME!
559    */
560   protected void aboutMenuItem_actionPerformed(ActionEvent e)
561   {
562   }
563
564   protected void documentationMenuItem_actionPerformed()
565   {
566   }
567
568   /**
569    * DOCUMENT ME!
570    * 
571    * @param e
572    *          DOCUMENT ME!
573    */
574   public void SaveState_actionPerformed(ActionEvent e)
575   {
576   }
577
578   /**
579    * DOCUMENT ME!
580    * 
581    * @param e
582    *          DOCUMENT ME!
583    */
584   protected void preferences_actionPerformed(ActionEvent e)
585   {
586   }
587
588   public void saveState_actionPerformed()
589   {
590   }
591
592   public void loadState_actionPerformed()
593   {
594   }
595
596   public void vamsasStart_actionPerformed(ActionEvent e)
597   {
598
599   }
600
601   public void inputSequence_actionPerformed(ActionEvent e)
602   {
603
604   }
605
606   public void vamsasStop_actionPerformed(ActionEvent e)
607   {
608
609   }
610
611   public void closeAll_actionPerformed(ActionEvent e)
612   {
613
614   }
615
616   public void raiseRelated_actionPerformed(ActionEvent e)
617   {
618
619   }
620
621   public void minimizeAssociated_actionPerformed(ActionEvent e)
622   {
623
624   }
625
626   public void vamsasImport_actionPerformed(ActionEvent e)
627   {
628   }
629 }