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