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