src/jalview/jbgui/GStructureChooser.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
   3  * Copyright (C) 2014 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
  22 package jalview.jbgui;
  23
  24 import jalview.datamodel.SequenceI;
  25 import jalview.gui.AlignmentPanel;
  26 import jalview.gui.Desktop;
  27 import jalview.gui.JvSwingUtils;
  28 import jalview.jbgui.PDBDocFieldPreferences.PreferenceSource;
  29 import jalview.util.MessageManager;
  30 import jalview.ws.dbsources.PDBRestClient;
  31 import jalview.ws.dbsources.PDBRestClient.PDBDocField;
  32
  33 import java.awt.BorderLayout;
  34 import java.awt.CardLayout;
  35 import java.awt.Dimension;
  36 import java.awt.FlowLayout;
  37 import java.awt.event.ActionEvent;
  38 import java.awt.event.ItemEvent;
  39 import java.awt.event.ItemListener;
  40 import java.awt.event.KeyAdapter;
  41 import java.awt.event.KeyEvent;
  42 import java.awt.event.MouseAdapter;
  43 import java.awt.event.MouseEvent;
  44 import java.util.Arrays;
  45
  46 import javax.swing.ImageIcon;
  47 import javax.swing.JButton;
  48 import javax.swing.JCheckBox;
  49 import javax.swing.JComboBox;
  50 import javax.swing.JFrame;
  51 import javax.swing.JInternalFrame;
  52 import javax.swing.JLabel;
  53 import javax.swing.JPanel;
  54 import javax.swing.JScrollPane;
  55 import javax.swing.JTabbedPane;
  56 import javax.swing.JTable;
  57 import javax.swing.JTextField;
  58 import javax.swing.event.ChangeEvent;
  59 import javax.swing.event.ChangeListener;
  60 import javax.swing.event.DocumentEvent;
  61 import javax.swing.event.DocumentListener;
  62
  63 @SuppressWarnings("serial")
  64 /**
  65  * GUI layout for structure chooser
  66  * @author tcnofoegbu
  67  *
  68  */
  69 public abstract class GStructureChooser extends JPanel implements
  70         ItemListener
  71 {
  72   protected String frameTitle = MessageManager
  73           .getString("label.structure_chooser");
  74
  75   protected JInternalFrame mainFrame = new JInternalFrame(frameTitle);
  76
  77   protected JComboBox<FilterOption> cmb_filterOption = new JComboBox<FilterOption>();
  78
  79   protected AlignmentPanel ap;
  80
  81   protected StringBuilder errorWarning = new StringBuilder();
  82
  83   protected JLabel lbl_result = new JLabel(
  84           MessageManager.getString("label.select"));
  85
  86   protected JButton btn_view = new JButton();
  87
  88   protected JButton btn_cancel = new JButton();
  89
  90   protected JButton btn_pdbFromFile = new JButton();
  91
  92   protected JTextField txt_search = new JTextField(14);
  93
  94   private JPanel pnl_actions = new JPanel();
  95
  96   private JPanel pnl_main = new JPanel();
  97
  98   private JPanel pnl_idInput = new JPanel(new FlowLayout());
  99
 100   private JPanel pnl_fileChooser = new JPanel(new FlowLayout());
 101
 102   private JPanel pnl_idInputBL = new JPanel(new BorderLayout());
 103
 104   private JPanel pnl_fileChooserBL = new JPanel(new BorderLayout());
 105
 106   private JPanel pnl_locPDB = new JPanel(new BorderLayout());
 107
 108   protected JPanel pnl_switchableViews = new JPanel(new CardLayout());
 109
 110   protected CardLayout layout_switchableViews = (CardLayout) (pnl_switchableViews
 111           .getLayout());
 112
 113   private BorderLayout mainLayout = new BorderLayout();
 114
 115   protected JCheckBox chk_rememberSettings = new JCheckBox(
 116           MessageManager.getString("label.dont_ask_me_again"));
 117
 118   protected JCheckBox chk_invertFilter = new JCheckBox(
 119           MessageManager.getString("label.invert"));
 120
 121   protected ImageIcon loadingImage = new ImageIcon(getClass().getResource(
 122           "/images/loading.gif"));
 123
 124   protected ImageIcon goodImage = new ImageIcon(getClass().getResource(
 125           "/images/good.png"));
 126
 127   protected ImageIcon errorImage = new ImageIcon(getClass().getResource(
 128           "/images/error.png"));
 129
 130   protected ImageIcon warningImage = new ImageIcon(getClass().getResource(
 131           "/images/warning.gif"));
 132
 133   protected JLabel lbl_warning = new JLabel(warningImage);
 134
 135   protected JLabel lbl_loading = new JLabel(loadingImage);
 136
 137   protected JLabel lbl_pdbManualFetchStatus = new JLabel(errorImage);
 138
 139   protected JLabel lbl_fromFileStatus = new JLabel(errorImage);
 140
 141   protected AssciateSeqPanel idInputAssSeqPanel = new AssciateSeqPanel();
 142
 143   protected AssciateSeqPanel fileChooserAssSeqPanel = new AssciateSeqPanel();
 144
 145   protected static final String VIEWS_FILTER = "VIEWS_FILTER";
 146
 147   protected static final String VIEWS_FROM_FILE = "VIEWS_FROM_FILE";
 148
 149   protected static final String VIEWS_ENTER_ID = "VIEWS_ENTER_ID";
 150
 151   protected static final String VIEWS_LOCAL_PDB = "VIEWS_LOCAL_PDB";
 152
 153   protected JTable tbl_summary = new JTable()
 154   {
 155     public String getToolTipText(MouseEvent evt)
 156     {
 157       String toolTipText = null;
 158       java.awt.Point pnt = evt.getPoint();
 159       int rowIndex = rowAtPoint(pnt);
 160       int colIndex = columnAtPoint(pnt);
 161
 162       try
 163       {
 164         toolTipText = getValueAt(rowIndex, colIndex).toString();
 165       } catch (Exception e)
 166       {
 167         e.printStackTrace();
 168       }
 169       toolTipText = (toolTipText == null ? null
 170               : (toolTipText.length() > 500 ? JvSwingUtils.wrapTooltip(
 171                       true, "\"" + toolTipText.subSequence(0, 500)
 172                               + "...\"") : JvSwingUtils.wrapTooltip(true,
 173                       toolTipText)));
 174       return toolTipText;
 175     }
 176   };
 177
 178   protected JScrollPane scrl_foundStructures = new JScrollPane(tbl_summary);
 179
 180   protected JTable tbl_local_pdb = new JTable();
 181
 182   protected JScrollPane scrl_localPDB = new JScrollPane(tbl_local_pdb);
 183
 184   private JTabbedPane pnl_filter = new JTabbedPane();
 185
 186   private PDBDocFieldPreferences pdbDocFieldPrefs = new PDBDocFieldPreferences(
 187           PreferenceSource.STRUCTURE_CHOOSER);
 188
 189   protected PDBDocField[] previousWantedFields;
 190
 191   public GStructureChooser()
 192   {
 193     try
 194     {
 195       jbInit();
 196       mainFrame.setVisible(false);
 197       mainFrame.invalidate();
 198       mainFrame.pack();
 199     } catch (Exception e)
 200     {
 201       e.printStackTrace();
 202     }
 203   }
 204
 205   /**
 206    * Initializes the GUI default properties
 207    *
 208    * @throws Exception
 209    */
 210   private void jbInit() throws Exception
 211   {
 212     tbl_summary.setAutoCreateRowSorter(true);
 213     tbl_summary.getTableHeader().setReorderingAllowed(false);
 214     tbl_summary.addMouseListener(new MouseAdapter()
 215     {
 216       public void mouseClicked(MouseEvent e)
 217       {
 218         validateSelections();
 219       }
 220
 221       public void mouseReleased(MouseEvent e)
 222       {
 223         validateSelections();
 224       }
 225     });
 226     tbl_summary.addKeyListener(new KeyAdapter()
 227     {
 228       @Override
 229       public void keyPressed(KeyEvent evt)
 230       {
 231         validateSelections();
 232         switch (evt.getKeyCode())
 233         {
 234         case KeyEvent.VK_ESCAPE: // escape key
 235           mainFrame.dispose();
 236           break;
 237         case KeyEvent.VK_ENTER: // enter key
 238           if (btn_view.isEnabled())
 239           {
 240             ok_ActionPerformed();
 241           }
 242           break;
 243         case KeyEvent.VK_TAB: // tab key
 244           if (evt.isShiftDown())
 245           {
 246             chk_invertFilter.requestFocus();
 247           }
 248           else
 249           {
 250             btn_view.requestFocus();
 251           }
 252           break;
 253         default:
 254           return;
 255         }
 256       }
 257     });
 258     tbl_local_pdb.setAutoCreateRowSorter(true);
 259     tbl_local_pdb.getTableHeader().setReorderingAllowed(false);
 260     tbl_local_pdb.addMouseListener(new MouseAdapter()
 261     {
 262       public void mouseClicked(MouseEvent e)
 263       {
 264         validateSelections();
 265       }
 266
 267       public void mouseReleased(MouseEvent e)
 268       {
 269         validateSelections();
 270       }
 271     });
 272     tbl_local_pdb.addKeyListener(new KeyAdapter()
 273     {
 274       @Override
 275       public void keyPressed(KeyEvent evt)
 276       {
 277         validateSelections();
 278         switch (evt.getKeyCode())
 279         {
 280         case KeyEvent.VK_ESCAPE: // escape key
 281           mainFrame.dispose();
 282           break;
 283         case KeyEvent.VK_ENTER: // enter key
 284           if (btn_view.isEnabled())
 285           {
 286             ok_ActionPerformed();
 287           }
 288           break;
 289         case KeyEvent.VK_TAB: // tab key
 290           if (evt.isShiftDown())
 291           {
 292             cmb_filterOption.requestFocus();
 293           }
 294           else
 295           {
 296             btn_view.requestFocus();
 297           }
 298
 299         default:
 300           return;
 301         }
 302       }
 303     });
 304     btn_view.setFont(new java.awt.Font("Verdana", 0, 12));
 305     btn_view.setText(MessageManager.getString("action.view"));
 306     btn_view.addActionListener(new java.awt.event.ActionListener()
 307     {
 308       public void actionPerformed(ActionEvent e)
 309       {
 310         ok_ActionPerformed();
 311       }
 312     });
 313     btn_view.addKeyListener(new KeyAdapter()
 314     {
 315       @Override
 316       public void keyPressed(KeyEvent evt)
 317       {
 318         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 319         {
 320           ok_ActionPerformed();
 321         }
 322       }
 323     });
 324
 325     btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
 326     btn_cancel.setText(MessageManager.getString("action.cancel"));
 327     btn_cancel.addActionListener(new java.awt.event.ActionListener()
 328     {
 329       public void actionPerformed(ActionEvent e)
 330       {
 331         mainFrame.dispose();
 332       }
 333     });
 334     btn_cancel.addKeyListener(new KeyAdapter()
 335     {
 336       @Override
 337       public void keyPressed(KeyEvent evt)
 338       {
 339         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 340         {
 341           mainFrame.dispose();
 342         }
 343       }
 344     });
 345
 346     btn_pdbFromFile.setFont(new java.awt.Font("Verdana", 0, 12));
 347     String btn_title = MessageManager.getString("label.select_pdb_file");
 348     btn_pdbFromFile.setText(btn_title + "              ");
 349     btn_pdbFromFile.addActionListener(new java.awt.event.ActionListener()
 350     {
 351       public void actionPerformed(ActionEvent e)
 352       {
 353         pdbFromFile_actionPerformed();
 354       }
 355     });
 356     btn_pdbFromFile.addKeyListener(new KeyAdapter()
 357     {
 358       @Override
 359       public void keyPressed(KeyEvent evt)
 360       {
 361         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 362         {
 363           pdbFromFile_actionPerformed();
 364         }
 365       }
 366     });
 367
 368     scrl_foundStructures.setPreferredSize(new Dimension(500, 300));
 369     scrl_foundStructures
 370             .setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
 371
 372     scrl_localPDB.setPreferredSize(new Dimension(500, 300));
 373     scrl_localPDB
 374             .setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
 375
 376     cmb_filterOption.setFont(new java.awt.Font("Verdana", 0, 12));
 377     chk_invertFilter.setFont(new java.awt.Font("Verdana", 0, 12));
 378     chk_rememberSettings.setFont(new java.awt.Font("Verdana", 0, 12));
 379     chk_rememberSettings.setVisible(false);
 380
 381     txt_search.setToolTipText(MessageManager
 382             .getString("label.enter_pdb_id"));
 383     cmb_filterOption.setToolTipText(MessageManager
 384             .getString("info.select_filter_option"));
 385     txt_search.getDocument().addDocumentListener(new DocumentListener()
 386     {
 387       @Override
 388       public void insertUpdate(DocumentEvent e)
 389       {
 390         txt_search_ActionPerformed();
 391       }
 392
 393       @Override
 394       public void removeUpdate(DocumentEvent e)
 395       {
 396         txt_search_ActionPerformed();
 397       }
 398
 399       @Override
 400       public void changedUpdate(DocumentEvent e)
 401       {
 402         txt_search_ActionPerformed();
 403       }
 404     });
 405
 406     cmb_filterOption.addItemListener(this);
 407     chk_invertFilter.addItemListener(this);
 408
 409     pnl_actions.add(chk_rememberSettings);
 410     pnl_actions.add(btn_view);
 411     pnl_actions.add(btn_cancel);
 412
 413     // pnl_filter.add(lbl_result);
 414     pnl_main.add(cmb_filterOption);
 415     pnl_main.add(lbl_loading);
 416     pnl_main.add(chk_invertFilter);
 417     lbl_loading.setVisible(false);
 418
 419     pnl_fileChooser.add(btn_pdbFromFile);
 420     pnl_fileChooser.add(lbl_fromFileStatus);
 421     pnl_fileChooserBL.add(fileChooserAssSeqPanel, BorderLayout.NORTH);
 422     pnl_fileChooserBL.add(pnl_fileChooser, BorderLayout.CENTER);
 423
 424     pnl_idInput.add(txt_search);
 425     pnl_idInput.add(lbl_pdbManualFetchStatus);
 426     pnl_idInputBL.add(idInputAssSeqPanel, BorderLayout.NORTH);
 427     pnl_idInputBL.add(pnl_idInput, BorderLayout.CENTER);
 428
 429     final String foundStructureSummary = MessageManager
 430             .getString("label.found_structures_summary");
 431     final String configureCols = MessageManager
 432             .getString("label.configure_displayed_columns");
 433     ChangeListener changeListener = new ChangeListener()
 434     {
 435       public void stateChanged(ChangeEvent changeEvent)
 436       {
 437         JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
 438                 .getSource();
 439         int index = sourceTabbedPane.getSelectedIndex();
 440         if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
 441         {
 442           btn_view.setEnabled(false);
 443           btn_cancel.setEnabled(false);
 444           previousWantedFields = PDBDocFieldPreferences
 445                   .getStructureSummaryFields().toArray(
 446                           new PDBRestClient.PDBDocField[0]);
 447         }
 448         if (sourceTabbedPane.getTitleAt(index)
 449                 .equals(foundStructureSummary))
 450         {
 451           btn_cancel.setEnabled(true);
 452           if (wantedFieldsUpdated())
 453           {
 454             tabRefresh();
 455           }
 456           else
 457           {
 458             validateSelections();
 459           }
 460         }
 461       }
 462     };
 463     pnl_filter.addChangeListener(changeListener);
 464     pnl_filter.setPreferredSize(new Dimension(500, 300));
 465     pnl_filter.add(foundStructureSummary, scrl_foundStructures);
 466     pnl_filter.add(configureCols, pdbDocFieldPrefs);
 467
 468     pnl_locPDB.add(scrl_localPDB);
 469
 470     pnl_switchableViews.add(pnl_fileChooserBL, VIEWS_FROM_FILE);
 471     pnl_switchableViews.add(pnl_idInputBL, VIEWS_ENTER_ID);
 472     pnl_switchableViews.add(pnl_filter, VIEWS_FILTER);
 473     pnl_switchableViews.add(pnl_locPDB, VIEWS_LOCAL_PDB);
 474
 475     this.setLayout(mainLayout);
 476     this.add(pnl_main, java.awt.BorderLayout.NORTH);
 477     this.add(pnl_switchableViews, java.awt.BorderLayout.CENTER);
 478     this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
 479
 480     mainFrame.setVisible(true);
 481     mainFrame.setContentPane(this);
 482     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
 483     Desktop.addInternalFrame(mainFrame, frameTitle, 800, 400);
 484   }
 485
 486   public boolean wantedFieldsUpdated()
 487   {
 488     if (previousWantedFields == null)
 489     {
 490       return true;
 491     }
 492
 493     return Arrays.equals(PDBDocFieldPreferences.getStructureSummaryFields()
 494             .toArray(new PDBRestClient.PDBDocField[0]),
 495             previousWantedFields) ? false : true;
 496
 497   }
 498
 499   @Override
 500   /**
 501    * Event listener for the 'filter' combo-box and 'invert' check-box
 502    */
 503   public void itemStateChanged(ItemEvent e)
 504   {
 505     stateChanged(e);
 506   }
 507
 508   /**
 509    * This inner class provides the data model for the structure filter combo-box
 510    *
 511    * @author tcnofoegbu
 512    *
 513    */
 514   public class FilterOption
 515   {
 516     private String name;
 517
 518     private String value;
 519
 520     private String view;
 521
 522     public FilterOption(String name, String value, String view)
 523     {
 524       this.name = name;
 525       this.value = value;
 526       this.view = view;
 527     }
 528
 529     public String getName()
 530     {
 531       return name;
 532     }
 533
 534     public void setName(String name)
 535     {
 536       this.name = name;
 537     }
 538
 539     public String getValue()
 540     {
 541       return value;
 542     }
 543
 544     public void setValue(String value)
 545     {
 546       this.value = value;
 547     }
 548
 549     public String getView()
 550     {
 551       return view;
 552     }
 553
 554     public void setView(String view)
 555     {
 556       this.view = view;
 557     }
 558
 559     public String toString()
 560     {
 561       return this.name;
 562     }
 563   }
 564
 565   /**
 566    * This inner class provides the provides the data model for associate
 567    * sequence combo-box - cmb_assSeq
 568    *
 569    * @author tcnofoegbu
 570    *
 571    */
 572   public class AssociateSeqOptions
 573   {
 574     private SequenceI sequence;
 575
 576     private String name;
 577
 578     public AssociateSeqOptions(SequenceI seq)
 579     {
 580       this.sequence = seq;
 581       this.name = (seq.getName().length() >= 23) ? seq.getName().substring(
 582               0, 23) : seq.getName();
 583     }
 584
 585     public AssociateSeqOptions(String name, SequenceI seq)
 586     {
 587       this.name = name;
 588       this.sequence = seq;
 589     }
 590
 591     public String toString()
 592     {
 593       return name;
 594     }
 595
 596     public String getName()
 597     {
 598       return name;
 599     }
 600
 601     public void setName(String name)
 602     {
 603       this.name = name;
 604     }
 605
 606     public SequenceI getSequence()
 607     {
 608       return sequence;
 609     }
 610
 611     public void setSequence(SequenceI sequence)
 612     {
 613       this.sequence = sequence;
 614     }
 615
 616   }
 617
 618   /**
 619    * This inner class holds the Layout and configuration of the panel which
 620    * handles association of manually fetched structures to a unique sequence
 621    * when more than one sequence selection is made
 622    *
 623    * @author tcnofoegbu
 624    *
 625    */
 626   public class AssciateSeqPanel extends JPanel implements ItemListener
 627   {
 628     private JComboBox<AssociateSeqOptions> cmb_assSeq = new JComboBox<AssociateSeqOptions>();
 629
 630     private JLabel lbl_associateSeq = new JLabel();
 631
 632     public AssciateSeqPanel()
 633     {
 634       this.setLayout(new FlowLayout());
 635       this.add(cmb_assSeq);
 636       this.add(lbl_associateSeq);
 637       cmb_assSeq.setToolTipText(MessageManager
 638               .getString("info.associate_wit_sequence"));
 639       cmb_assSeq.addItemListener(this);
 640     }
 641
 642     public void loadCmbAssSeq()
 643     {
 644       populateCmbAssociateSeqOptions(cmb_assSeq, lbl_associateSeq);
 645     }
 646
 647     public JComboBox<AssociateSeqOptions> getCmb_assSeq()
 648     {
 649       return cmb_assSeq;
 650     }
 651
 652     public void setCmb_assSeq(JComboBox<AssociateSeqOptions> cmb_assSeq)
 653     {
 654       this.cmb_assSeq = cmb_assSeq;
 655     }
 656
 657     @Override
 658     public void itemStateChanged(ItemEvent e)
 659     {
 660       if (e.getStateChange() == ItemEvent.SELECTED)
 661       {
 662         cmbAssSeqStateChanged();
 663       }
 664     }
 665   }
 666
 667   public JComboBox<FilterOption> getCmbFilterOption()
 668   {
 669     return cmb_filterOption;
 670   }
 671
 672   protected abstract void stateChanged(ItemEvent e);
 673
 674   protected abstract void updateCurrentView();
 675
 676   protected abstract void populateFilterComboBox();
 677
 678   protected abstract void ok_ActionPerformed();
 679
 680   protected abstract void pdbFromFile_actionPerformed();
 681
 682   protected abstract void txt_search_ActionPerformed();
 683
 684   public abstract void populateCmbAssociateSeqOptions(
 685           JComboBox<AssociateSeqOptions> cmb_assSeq, JLabel lbl_associateSeq);
 686
 687   public abstract void cmbAssSeqStateChanged();
 688
 689   public abstract void tabRefresh();
 690
 691   public abstract void validateSelections();
 692 }