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