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