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 public class GDesktop extends JFrame
  46 {
  47
  48   public static javax.swing.JTabbedPane createTabbedPane()
  49   {
  50    return new javax.swing.JTabbedPane();
  51   }
  52
  53
  54   protected static JMenu windowMenu = new JMenu();
  55
  56   JMenuBar desktopMenubar = new JMenuBar();
  57
  58   JMenu FileMenu = new JMenu();
  59
  60   JMenu HelpMenu = new JMenu();
  61
  62   protected JMenu VamsasMenu = new JMenu();
  63
  64   protected JMenu VamsasStMenu = new JMenu();
  65
  66   JMenuItem inputLocalFileMenuItem = new JMenuItem();
  67
  68   JMenuItem inputURLMenuItem = new JMenuItem();
  69
  70   JMenuItem inputTextboxMenuItem = new JMenuItem();
  71
  72   JMenuItem quit = new JMenuItem();
  73
  74   JMenuItem aboutMenuItem = new JMenuItem();
  75
  76   JMenuItem documentationMenuItem = new JMenuItem();
  77
  78   FlowLayout flowLayout1 = new FlowLayout();
  79
  80   protected JMenu toolsMenu = new JMenu();
  81
  82   JMenuItem preferences = new JMenuItem();
  83
  84   JMenuItem saveState = new JMenuItem();
  85
  86   JMenuItem loadState = new JMenuItem();
  87
  88   JMenu inputMenu = new JMenu();
  89
  90   protected JMenuItem vamsasStart = new JMenuItem();
  91
  92   protected JMenuItem vamsasImport = new JMenuItem();
  93
  94   protected JMenuItem vamsasSave = new JMenuItem();
  95
  96   JMenuItem inputSequence = new JMenuItem();
  97
  98   protected JMenuItem vamsasStop = new JMenuItem();
  99
 100   JMenuItem closeAll = new JMenuItem();
 101
 102   JMenuItem raiseRelated = new JMenuItem();
 103
 104   JMenuItem minimizeAssociated = new JMenuItem();
 105
 106   protected JCheckBoxMenuItem showMemusage = new JCheckBoxMenuItem();
 107
 108   JMenuItem garbageCollect = new JMenuItem();
 109
 110   protected JMenuItem groovyShell;
 111
 112   protected JCheckBoxMenuItem experimentalFeatures;
 113
 114   protected JCheckBoxMenuItem showConsole = new JCheckBoxMenuItem();
 115
 116   protected JCheckBoxMenuItem showNews = new JCheckBoxMenuItem();
 117
 118   protected JMenuItem snapShotWindow = new JMenuItem();
 119
 120   /**
 121    * Creates a new GDesktop object.
 122    */
 123   public GDesktop()
 124   {
 125     super();
 126     try
 127     {
 128       jbInit();
 129       this.setJMenuBar(desktopMenubar);
 130     } catch (Exception e)
 131     {
 132       e.printStackTrace();
 133     }
 134
 135     if (Platform.allowMnemonics())
 136     {
 137         //BH was !Platform.isAMacAndNotJS()) i.e. "JS or not Mac"
 138         // but here we want just not a Mac, period, right?
 139       FileMenu.setMnemonic('F');
 140       inputLocalFileMenuItem.setMnemonic('L');
 141       VamsasMenu.setMnemonic('V');
 142       inputURLMenuItem.setMnemonic('U');
 143       inputTextboxMenuItem.setMnemonic('C');
 144       quit.setMnemonic('Q');
 145       saveState.setMnemonic('S');
 146       loadState.setMnemonic('L');
 147       inputMenu.setMnemonic('I');
 148     }
 149   }
 150
 151   /**
 152    * DOCUMENT ME!
 153    *
 154    * @throws Exception
 155    *           DOCUMENT ME!
 156    */
 157   private void jbInit() throws Exception
 158   {
 159
 160     FileMenu.setText(MessageManager.getString("action.file"));
 161     HelpMenu.setText(MessageManager.getString("action.help"));
 162     VamsasMenu.setText("Vamsas");
 163     VamsasMenu.setToolTipText(MessageManager
 164             .getString("label.share_data_vamsas_applications"));
 165     VamsasStMenu.setText(MessageManager.getString("label.connect_to"));
 166     VamsasStMenu.setToolTipText(
 167             MessageManager.getString("label.join_existing_vamsas_session"));
 168     inputLocalFileMenuItem
 169             .setText(MessageManager.getString("label.load_tree_from_file"));
 170     inputLocalFileMenuItem.setAccelerator(
 171             javax.swing.KeyStroke.getKeyStroke(java.awt.event.KeyEvent.VK_O,
 172                     Toolkit.getDefaultToolkit().getMenuShortcutKeyMask(),
 173                     false));
 174     inputLocalFileMenuItem
 175             .addActionListener(new java.awt.event.ActionListener()
 176             {
 177               @Override
 178               public void actionPerformed(ActionEvent e)
 179               {
 180                 inputLocalFileMenuItem_actionPerformed(null);
 181               }
 182             });
 183     inputURLMenuItem.setText(MessageManager.getString("label.from_url"));
 184     inputURLMenuItem.addActionListener(new java.awt.event.ActionListener()
 185     {
 186       @Override
 187       public void actionPerformed(ActionEvent e)
 188       {
 189         try
 190         {
 191           inputURLMenuItem_actionPerformed(null);
 192         } catch (FileFormatException e1)
 193         {
 194           System.err.println("Error loading from URL: " + e1.getMessage());
 195         }
 196       }
 197     });
 198     inputTextboxMenuItem
 199             .setText(MessageManager.getString("label.from_textbox"));
 200     inputTextboxMenuItem
 201             .addActionListener(new java.awt.event.ActionListener()
 202             {
 203               @Override
 204               public void actionPerformed(ActionEvent e)
 205               {
 206                 inputTextboxMenuItem_actionPerformed(null);
 207               }
 208             });
 209     quit.setText(MessageManager.getString("action.quit"));
 210     quit.addActionListener(new java.awt.event.ActionListener()
 211     {
 212       @Override
 213       public void actionPerformed(ActionEvent e)
 214       {
 215         quit();
 216       }
 217     });
 218     aboutMenuItem.setText(MessageManager.getString("label.about"));
 219     aboutMenuItem.addActionListener(new java.awt.event.ActionListener()
 220     {
 221       @Override
 222       public void actionPerformed(ActionEvent e)
 223       {
 224         aboutMenuItem_actionPerformed(e);
 225       }
 226     });
 227     documentationMenuItem
 228             .setText(MessageManager.getString("label.documentation"));
 229     documentationMenuItem.setAccelerator(javax.swing.KeyStroke
 230             .getKeyStroke(java.awt.event.KeyEvent.VK_F1, 0, false));
 231     documentationMenuItem
 232             .addActionListener(new java.awt.event.ActionListener()
 233             {
 234               @Override
 235               public void actionPerformed(ActionEvent e)
 236               {
 237                 documentationMenuItem_actionPerformed();
 238               }
 239             });
 240     this.getContentPane().setLayout(flowLayout1);
 241     windowMenu.setText(MessageManager.getString("label.window"));
 242     preferences.setText(MessageManager.getString("label.preferences"));
 243     preferences.addActionListener(new ActionListener()
 244     {
 245       @Override
 246       public void actionPerformed(ActionEvent e)
 247       {
 248         preferences_actionPerformed(e);
 249       }
 250     });
 251     toolsMenu.setText(MessageManager.getString("label.tools"));
 252     saveState.setText(MessageManager.getString("action.save_project"));
 253     saveState.addActionListener(new ActionListener()
 254     {
 255       @Override
 256       public void actionPerformed(ActionEvent e)
 257       {
 258         saveState_actionPerformed(true);
 259       }
 260     });
 261     JMenuItem saveAsJaxb = new JMenuItem("Save Project as JAXB");
 262     saveAsJaxb.addActionListener(new ActionListener()
 263     {
 264       @Override
 265       public void actionPerformed(ActionEvent e)
 266       {
 267         saveState_actionPerformed(false);
 268       }
 269     });
 270     loadState.setText(MessageManager.getString("action.load_project"));
 271     loadState.addActionListener(new ActionListener()
 272     {
 273       @Override
 274       public void actionPerformed(ActionEvent e)
 275       {
 276         loadState_actionPerformed(true);
 277       }
 278     });
 279     JMenuItem loadAsJaxb = new JMenuItem("Load Project as JAXB");
 280     loadAsJaxb.addActionListener(new ActionListener()
 281     {
 282       @Override
 283       public void actionPerformed(ActionEvent e)
 284       {
 285         loadState_actionPerformed(false);
 286       }
 287     });
 288     inputMenu.setText(MessageManager.getString("label.input_alignment"));
 289     vamsasStart
 290             .setText(MessageManager.getString("label.new_vamsas_session"));
 291     vamsasStart.setVisible(false);
 292     vamsasStart.addActionListener(new ActionListener()
 293     {
 294       @Override
 295       public void actionPerformed(ActionEvent e)
 296       {
 297         vamsasStart_actionPerformed(e);
 298       }
 299     });
 300     vamsasImport.setText(
 301             MessageManager.getString("action.load_vamsas_session"));
 302     vamsasImport.setVisible(false);
 303     vamsasImport.addActionListener(new ActionListener()
 304     {
 305       @Override
 306       public void actionPerformed(ActionEvent e)
 307       {
 308         vamsasImport_actionPerformed(e);
 309       }
 310     });
 311     vamsasSave.setText(
 312             MessageManager.getString("action.save_vamsas_session"));
 313     vamsasSave.setVisible(false);
 314     vamsasSave.addActionListener(new ActionListener()
 315     {
 316       @Override
 317       public void actionPerformed(ActionEvent e)
 318       {
 319         vamsasSave_actionPerformed(e);
 320       }
 321     });
 322     inputSequence
 323             .setText(MessageManager.getString("action.fetch_sequences"));
 324     inputSequence.addActionListener(new ActionListener()
 325     {
 326       @Override
 327       public void actionPerformed(ActionEvent e)
 328       {
 329         inputSequence_actionPerformed(e);
 330       }
 331     });
 332     vamsasStop
 333             .setText(MessageManager.getString("label.stop_vamsas_session"));
 334     vamsasStop.setVisible(false);
 335     vamsasStop.addActionListener(new ActionListener()
 336     {
 337       @Override
 338       public void actionPerformed(ActionEvent e)
 339       {
 340         vamsasStop_actionPerformed(e);
 341       }
 342     });
 343     closeAll.setText(MessageManager.getString("action.close_all"));
 344     closeAll.addActionListener(new ActionListener()
 345     {
 346       @Override
 347       public void actionPerformed(ActionEvent e)
 348       {
 349         closeAll_actionPerformed(e);
 350       }
 351     });
 352     raiseRelated.setText(
 353             MessageManager.getString("action.raise_associated_windows"));
 354     raiseRelated.addActionListener(new ActionListener()
 355     {
 356       @Override
 357       public void actionPerformed(ActionEvent e)
 358       {
 359         raiseRelated_actionPerformed(e);
 360       }
 361     });
 362     minimizeAssociated.setText(
 363             MessageManager.getString("action.minimize_associated_windows"));
 364     minimizeAssociated.addActionListener(new ActionListener()
 365     {
 366       @Override
 367       public void actionPerformed(ActionEvent e)
 368       {
 369         minimizeAssociated_actionPerformed(e);
 370       }
 371     });
 372     garbageCollect
 373             .setText(MessageManager.getString("label.collect_garbage"));
 374     garbageCollect.addActionListener(new ActionListener()
 375     {
 376       @Override
 377       public void actionPerformed(ActionEvent e)
 378       {
 379         garbageCollect_actionPerformed(e);
 380       }
 381     });
 382     showMemusage
 383             .setText(MessageManager.getString("label.show_memory_usage"));
 384     showMemusage.addActionListener(new ActionListener()
 385     {
 386       @Override
 387       public void actionPerformed(ActionEvent e)
 388       {
 389         showMemusage_actionPerformed(e);
 390       }
 391     });
 392     showConsole
 393             .setText(MessageManager.getString("label.show_java_console"));
 394     showConsole.addActionListener(new ActionListener()
 395     {
 396       @Override
 397       public void actionPerformed(ActionEvent e)
 398       {
 399         showConsole_actionPerformed(e);
 400       }
 401     });
 402     showNews.setText(MessageManager.getString("label.show_jalview_news"));
 403     showNews.addActionListener(new ActionListener()
 404     {
 405       @Override
 406       public void actionPerformed(ActionEvent e)
 407       {
 408         showNews_actionPerformed(e);
 409       }
 410     });
 411     groovyShell = new JMenuItem();
 412     groovyShell.setText(MessageManager.getString("label.groovy_console"));
 413     groovyShell.addActionListener(new ActionListener()
 414     {
 415       @Override
 416       public void actionPerformed(ActionEvent e)
 417       {
 418         groovyShell_actionPerformed();
 419       }
 420     });
 421     experimentalFeatures = new JCheckBoxMenuItem();
 422     experimentalFeatures
 423             .setText(MessageManager.getString("label.show_experimental"));
 424     experimentalFeatures.setToolTipText(
 425             MessageManager.getString("label.show_experimental_tip"));
 426     experimentalFeatures.addActionListener(new ActionListener()
 427     {
 428       @Override
 429       public void actionPerformed(ActionEvent e)
 430       {
 431         showExperimental_actionPerformed(experimentalFeatures.isSelected());
 432       }
 433     });
 434
 435     snapShotWindow.setText(MessageManager.getString("label.take_snapshot"));
 436     snapShotWindow.addActionListener(new ActionListener()
 437     {
 438       @Override
 439       public void actionPerformed(ActionEvent e)
 440       {
 441         snapShotWindow_actionPerformed(e);
 442       }
 443     });
 444
 445     desktopMenubar.add(FileMenu);
 446     desktopMenubar.add(toolsMenu);
 447     VamsasMenu.setVisible(false);
 448     desktopMenubar.add(VamsasMenu);
 449     desktopMenubar.add(HelpMenu);
 450     desktopMenubar.add(windowMenu);
 451     FileMenu.add(inputMenu);
 452     FileMenu.add(inputSequence);
 453     FileMenu.addSeparator();
 454     FileMenu.add(saveAsJaxb);
 455     FileMenu.add(loadAsJaxb);
 456     if (!Platform.isJS())
 457     {
 458       FileMenu.add(saveState);
 459       FileMenu.add(loadState);
 460     }
 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   public void SaveState_actionPerformed(ActionEvent e)
 603   {
 604   }
 605
 606   /**
 607    * DOCUMENT ME!
 608    *
 609    * @param e
 610    *          DOCUMENT ME!
 611    */
 612   protected void preferences_actionPerformed(ActionEvent e)
 613   {
 614   }
 615
 616   /**
 617    * DOCUMENT ME!
 618    *
 619    * @param e
 620    *          DOCUMENT ME!
 621    */
 622   public void saveState_actionPerformed(boolean asCastor)
 623   {
 624   }
 625
 626   /**
 627    * DOCUMENT ME!
 628    *
 629    * @param e
 630    *          DOCUMENT ME!
 631    */
 632   public void loadState_actionPerformed(boolean asCastor)
 633   {
 634   }
 635
 636   /**
 637    * DOCUMENT ME!
 638    *
 639    * @param e
 640    *          DOCUMENT ME!
 641    */
 642   public void loadJalviewAlign_actionPerformed(ActionEvent e)
 643   {
 644   }
 645
 646   public void vamsasStart_actionPerformed(ActionEvent e)
 647   {
 648
 649   }
 650
 651   public void inputSequence_actionPerformed(ActionEvent e)
 652   {
 653
 654   }
 655
 656   public void vamsasStop_actionPerformed(ActionEvent e)
 657   {
 658
 659   }
 660
 661   public void closeAll_actionPerformed(ActionEvent e)
 662   {
 663
 664   }
 665
 666   public void raiseRelated_actionPerformed(ActionEvent e)
 667   {
 668
 669   }
 670
 671   public void minimizeAssociated_actionPerformed(ActionEvent e)
 672   {
 673
 674   }
 675
 676   public void vamsasImport_actionPerformed(ActionEvent e)
 677   {
 678   }
 679 }