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