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           ok_ActionPerformed();
 239           break;
 240         case KeyEvent.VK_TAB: // tab key
 241           btn_cancel.requestFocus();
 242         default:
 243           return;
 244         }
 245       }
 246     });
 247     tbl_local_pdb.setAutoCreateRowSorter(true);
 248     tbl_local_pdb.getTableHeader().setReorderingAllowed(false);
 249     tbl_local_pdb.addMouseListener(new MouseAdapter()
 250     {
 251       public void mouseClicked(MouseEvent e)
 252       {
 253         validateSelections();
 254       }
 255
 256       public void mouseReleased(MouseEvent e)
 257       {
 258         validateSelections();
 259       }
 260     });
 261     tbl_local_pdb.addKeyListener(new KeyAdapter()
 262     {
 263       @Override
 264       public void keyPressed(KeyEvent evt)
 265       {
 266         validateSelections();
 267         switch (evt.getKeyCode())
 268         {
 269         case KeyEvent.VK_ESCAPE: // escape key
 270           mainFrame.dispose();
 271           break;
 272         case KeyEvent.VK_ENTER: // enter key
 273           ok_ActionPerformed();
 274           break;
 275         case KeyEvent.VK_TAB: // tab key
 276           btn_cancel.requestFocus();
 277         default:
 278           return;
 279         }
 280       }
 281     });
 282     btn_view.setFont(new java.awt.Font("Verdana", 0, 12));
 283     btn_view.setText(MessageManager.getString("action.view"));
 284     btn_view.addActionListener(new java.awt.event.ActionListener()
 285     {
 286       public void actionPerformed(ActionEvent e)
 287       {
 288         ok_ActionPerformed();
 289       }
 290     });
 291     btn_view.addKeyListener(new KeyAdapter()
 292     {
 293       @Override
 294       public void keyPressed(KeyEvent evt)
 295       {
 296         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 297         {
 298           ok_ActionPerformed();
 299         }
 300       }
 301     });
 302
 303     btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
 304     btn_cancel.setText(MessageManager.getString("action.cancel"));
 305     btn_cancel.addActionListener(new java.awt.event.ActionListener()
 306     {
 307       public void actionPerformed(ActionEvent e)
 308       {
 309         mainFrame.dispose();
 310       }
 311     });
 312     btn_cancel.addKeyListener(new KeyAdapter()
 313     {
 314       @Override
 315       public void keyPressed(KeyEvent evt)
 316       {
 317         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 318         {
 319           mainFrame.dispose();
 320         }
 321       }
 322     });
 323
 324     btn_pdbFromFile.setFont(new java.awt.Font("Verdana", 0, 12));
 325     String btn_title = MessageManager.getString("label.select_pdb_file");
 326     btn_pdbFromFile.setText(btn_title + "              ");
 327     btn_pdbFromFile.addActionListener(new java.awt.event.ActionListener()
 328     {
 329       public void actionPerformed(ActionEvent e)
 330       {
 331         pdbFromFile_actionPerformed();
 332       }
 333     });
 334     btn_pdbFromFile.addKeyListener(new KeyAdapter()
 335     {
 336       @Override
 337       public void keyPressed(KeyEvent evt)
 338       {
 339         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 340         {
 341           pdbFromFile_actionPerformed();
 342         }
 343       }
 344     });
 345
 346     scrl_foundStructures.setPreferredSize(new Dimension(500, 300));
 347     scrl_foundStructures
 348             .setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
 349
 350     scrl_localPDB.setPreferredSize(new Dimension(500, 300));
 351     scrl_localPDB
 352             .setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
 353
 354     cmb_filterOption.setFont(new java.awt.Font("Verdana", 0, 12));
 355     chk_invertFilter.setFont(new java.awt.Font("Verdana", 0, 12));
 356     chk_rememberSettings.setFont(new java.awt.Font("Verdana", 0, 12));
 357     chk_rememberSettings.setVisible(false);
 358
 359     txt_search.setToolTipText(MessageManager
 360             .getString("label.enter_pdb_id"));
 361     cmb_filterOption.setToolTipText(MessageManager
 362             .getString("info.select_filter_option"));
 363     txt_search.getDocument().addDocumentListener(new DocumentListener()
 364     {
 365       @Override
 366       public void insertUpdate(DocumentEvent e)
 367       {
 368         txt_search_ActionPerformed();
 369       }
 370
 371       @Override
 372       public void removeUpdate(DocumentEvent e)
 373       {
 374         txt_search_ActionPerformed();
 375       }
 376
 377       @Override
 378       public void changedUpdate(DocumentEvent e)
 379       {
 380         txt_search_ActionPerformed();
 381       }
 382     });
 383
 384     cmb_filterOption.addItemListener(this);
 385     chk_invertFilter.addItemListener(this);
 386
 387     pnl_actions.add(chk_rememberSettings);
 388     pnl_actions.add(btn_view);
 389     pnl_actions.add(btn_cancel);
 390
 391     // pnl_filter.add(lbl_result);
 392     pnl_main.add(cmb_filterOption);
 393     pnl_main.add(lbl_loading);
 394     pnl_main.add(chk_invertFilter);
 395     lbl_loading.setVisible(false);
 396
 397     pnl_fileChooser.add(btn_pdbFromFile);
 398     pnl_fileChooser.add(lbl_fromFileStatus);
 399     pnl_fileChooserBL.add(fileChooserAssSeqPanel, BorderLayout.NORTH);
 400     pnl_fileChooserBL.add(pnl_fileChooser, BorderLayout.CENTER);
 401
 402     pnl_idInput.add(txt_search);
 403     pnl_idInput.add(lbl_pdbManualFetchStatus);
 404     pnl_idInputBL.add(idInputAssSeqPanel, BorderLayout.NORTH);
 405     pnl_idInputBL.add(pnl_idInput, BorderLayout.CENTER);
 406
 407     final String foundStructureSummary = MessageManager
 408             .getString("label.found_structures_summary");
 409     final String configureCols = MessageManager
 410             .getString("label.configure_displayed_columns");
 411     ChangeListener changeListener = new ChangeListener()
 412     {
 413       public void stateChanged(ChangeEvent changeEvent)
 414       {
 415         JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
 416                 .getSource();
 417         int index = sourceTabbedPane.getSelectedIndex();
 418         if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
 419         {
 420           btn_view.setEnabled(false);
 421           btn_cancel.setEnabled(false);
 422           previousWantedFields = PDBDocFieldPreferences
 423                   .getStructureSummaryFields().toArray(
 424                           new PDBRestClient.PDBDocField[0]);
 425         }
 426         if (sourceTabbedPane.getTitleAt(index)
 427                 .equals(foundStructureSummary))
 428         {
 429           btn_cancel.setEnabled(true);
 430           if (wantedFieldsUpdated())
 431           {
 432             tabRefresh();
 433           }
 434           else
 435           {
 436             validateSelections();
 437           }
 438         }
 439       }
 440     };
 441     pnl_filter.addChangeListener(changeListener);
 442     pnl_filter.setPreferredSize(new Dimension(500, 300));
 443     pnl_filter.add(foundStructureSummary, scrl_foundStructures);
 444     pnl_filter.add(configureCols, pdbDocFieldPrefs);
 445
 446     pnl_locPDB.add(scrl_localPDB);
 447
 448     pnl_switchableViews.add(pnl_fileChooserBL, VIEWS_FROM_FILE);
 449     pnl_switchableViews.add(pnl_idInputBL, VIEWS_ENTER_ID);
 450     pnl_switchableViews.add(pnl_filter, VIEWS_FILTER);
 451     pnl_switchableViews.add(pnl_locPDB, VIEWS_LOCAL_PDB);
 452
 453     this.setLayout(mainLayout);
 454     this.add(pnl_main, java.awt.BorderLayout.NORTH);
 455     this.add(pnl_switchableViews, java.awt.BorderLayout.CENTER);
 456     this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
 457
 458     mainFrame.setVisible(true);
 459     mainFrame.setContentPane(this);
 460     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
 461     Desktop.addInternalFrame(mainFrame, frameTitle, 800, 400);
 462   }
 463
 464   public boolean wantedFieldsUpdated()
 465   {
 466     if (previousWantedFields == null)
 467     {
 468       return true;
 469     }
 470
 471     return Arrays.equals(PDBDocFieldPreferences.getStructureSummaryFields()
 472             .toArray(new PDBRestClient.PDBDocField[0]),
 473             previousWantedFields) ? false : true;
 474
 475   }
 476
 477   @Override
 478   /**
 479    * Event listener for the 'filter' combo-box and 'invert' check-box
 480    */
 481   public void itemStateChanged(ItemEvent e)
 482   {
 483     stateChanged(e);
 484   }
 485
 486   /**
 487    * This inner class provides the data model for the structure filter combo-box
 488    *
 489    * @author tcnofoegbu
 490    *
 491    */
 492   public class FilterOption
 493   {
 494     private String name;
 495
 496     private String value;
 497
 498     private String view;
 499
 500     public FilterOption(String name, String value, String view)
 501     {
 502       this.name = name;
 503       this.value = value;
 504       this.view = view;
 505     }
 506
 507     public String getName()
 508     {
 509       return name;
 510     }
 511
 512     public void setName(String name)
 513     {
 514       this.name = name;
 515     }
 516
 517     public String getValue()
 518     {
 519       return value;
 520     }
 521
 522     public void setValue(String value)
 523     {
 524       this.value = value;
 525     }
 526
 527     public String getView()
 528     {
 529       return view;
 530     }
 531
 532     public void setView(String view)
 533     {
 534       this.view = view;
 535     }
 536
 537     public String toString()
 538     {
 539       return this.name;
 540     }
 541   }
 542
 543   /**
 544    * This inner class provides the provides the data model for associate
 545    * sequence combo-box - cmb_assSeq
 546    *
 547    * @author tcnofoegbu
 548    *
 549    */
 550   public class AssociateSeqOptions
 551   {
 552     private SequenceI sequence;
 553
 554     private String name;
 555
 556     public AssociateSeqOptions(SequenceI seq)
 557     {
 558       this.sequence = seq;
 559       this.name = (seq.getName().length() >= 23) ? seq.getName().substring(
 560               0, 23) : seq.getName();
 561     }
 562
 563     public AssociateSeqOptions(String name, SequenceI seq)
 564     {
 565       this.name = name;
 566       this.sequence = seq;
 567     }
 568
 569     public String toString()
 570     {
 571       return name;
 572     }
 573
 574     public String getName()
 575     {
 576       return name;
 577     }
 578
 579     public void setName(String name)
 580     {
 581       this.name = name;
 582     }
 583
 584     public SequenceI getSequence()
 585     {
 586       return sequence;
 587     }
 588
 589     public void setSequence(SequenceI sequence)
 590     {
 591       this.sequence = sequence;
 592     }
 593
 594   }
 595
 596   /**
 597    * This inner class holds the Layout and configuration of the panel which
 598    * handles association of manually fetched structures to a unique sequence
 599    * when more than one sequence selection is made
 600    *
 601    * @author tcnofoegbu
 602    *
 603    */
 604   public class AssciateSeqPanel extends JPanel implements ItemListener
 605   {
 606     private JComboBox<AssociateSeqOptions> cmb_assSeq = new JComboBox<AssociateSeqOptions>();
 607
 608     private JLabel lbl_associateSeq = new JLabel();
 609
 610     public AssciateSeqPanel()
 611     {
 612       this.setLayout(new FlowLayout());
 613       this.add(cmb_assSeq);
 614       this.add(lbl_associateSeq);
 615       cmb_assSeq.setToolTipText(MessageManager
 616               .getString("info.associate_wit_sequence"));
 617       cmb_assSeq.addItemListener(this);
 618     }
 619
 620     public void loadCmbAssSeq()
 621     {
 622       populateCmbAssociateSeqOptions(cmb_assSeq, lbl_associateSeq);
 623     }
 624
 625     public JComboBox<AssociateSeqOptions> getCmb_assSeq()
 626     {
 627       return cmb_assSeq;
 628     }
 629
 630     public void setCmb_assSeq(JComboBox<AssociateSeqOptions> cmb_assSeq)
 631     {
 632       this.cmb_assSeq = cmb_assSeq;
 633     }
 634
 635     @Override
 636     public void itemStateChanged(ItemEvent e)
 637     {
 638       if (e.getStateChange() == ItemEvent.SELECTED)
 639       {
 640         cmbAssSeqStateChanged();
 641       }
 642     }
 643   }
 644
 645   public JComboBox<FilterOption> getCmbFilterOption()
 646   {
 647     return cmb_filterOption;
 648   }
 649
 650   protected abstract void stateChanged(ItemEvent e);
 651
 652   protected abstract void updateCurrentView();
 653
 654   protected abstract void populateFilterComboBox();
 655
 656   protected abstract void ok_ActionPerformed();
 657
 658   protected abstract void pdbFromFile_actionPerformed();
 659
 660   protected abstract void txt_search_ActionPerformed();
 661
 662   public abstract void populateCmbAssociateSeqOptions(
 663           JComboBox<AssociateSeqOptions> cmb_assSeq, JLabel lbl_associateSeq);
 664
 665   public abstract void cmbAssSeqStateChanged();
 666
 667   public abstract void tabRefresh();
 668
 669   public abstract void validateSelections();
 670 }