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