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.jbgui.PDBDocFieldPreferences.PreferenceSource;
  28 import jalview.util.MessageManager;
  29
  30 import java.awt.BorderLayout;
  31 import java.awt.CardLayout;
  32 import java.awt.Dimension;
  33 import java.awt.FlowLayout;
  34 import java.awt.event.ActionEvent;
  35 import java.awt.event.ItemEvent;
  36 import java.awt.event.ItemListener;
  37 import java.awt.event.MouseAdapter;
  38 import java.awt.event.MouseEvent;
  39
  40 import javax.swing.ImageIcon;
  41 import javax.swing.JButton;
  42 import javax.swing.JCheckBox;
  43 import javax.swing.JComboBox;
  44 import javax.swing.JFrame;
  45 import javax.swing.JInternalFrame;
  46 import javax.swing.JLabel;
  47 import javax.swing.JPanel;
  48 import javax.swing.JScrollPane;
  49 import javax.swing.JTabbedPane;
  50 import javax.swing.JTable;
  51 import javax.swing.JTextField;
  52 import javax.swing.event.ChangeEvent;
  53 import javax.swing.event.ChangeListener;
  54 import javax.swing.event.DocumentEvent;
  55 import javax.swing.event.DocumentListener;
  56
  57 @SuppressWarnings("serial")
  58 /**
  59  * GUI layout for structure chooser
  60  * @author tcnofoegbu
  61  *
  62  */
  63 public abstract class GStructureChooser extends JPanel implements
  64         ItemListener
  65 {
  66   protected String frameTitle = MessageManager
  67           .getString("label.structure_chooser");
  68
  69   protected JInternalFrame mainFrame = new JInternalFrame(frameTitle);
  70
  71   protected JComboBox<FilterOption> cmb_filterOption = new JComboBox<FilterOption>();
  72
  73   protected AlignmentPanel ap;
  74
  75   protected StringBuilder errorWarning = new StringBuilder();
  76
  77   protected JLabel lbl_result = new JLabel(
  78           MessageManager.getString("label.select"));
  79
  80   protected JButton btn_view = new JButton();
  81
  82   protected JButton btn_cancel = new JButton();
  83
  84   protected JButton btn_pdbFromFile = new JButton();
  85
  86   protected JTextField txt_search = new JTextField(14);
  87
  88   private JPanel pnl_actions = new JPanel();
  89
  90   private JPanel pnl_main = new JPanel();
  91
  92   private JPanel pnl_idInput = new JPanel(new FlowLayout());
  93
  94   private JPanel pnl_fileChooser = new JPanel(new FlowLayout());
  95
  96   private JPanel pnl_idInputBL = new JPanel(new BorderLayout());
  97
  98   private JPanel pnl_fileChooserBL = new JPanel(new BorderLayout());
  99
 100   private JPanel pnl_locPDB = new JPanel(new BorderLayout());
 101
 102   protected JPanel pnl_switchableViews = new JPanel(new CardLayout());
 103
 104   protected CardLayout layout_switchableViews = (CardLayout) (pnl_switchableViews
 105           .getLayout());
 106
 107   private BorderLayout mainLayout = new BorderLayout();
 108
 109   protected JCheckBox chk_rememberSettings = new JCheckBox(
 110           MessageManager.getString("label.dont_ask_me_again"));
 111
 112   protected JCheckBox chk_invertFilter = new JCheckBox(
 113           MessageManager.getString("label.invert"));
 114
 115   protected ImageIcon loadingImage = new ImageIcon(getClass().getResource(
 116           "/images/loading.gif"));
 117
 118   protected ImageIcon goodImage = new ImageIcon(getClass().getResource(
 119           "/images/good.png"));
 120
 121   protected ImageIcon errorImage = new ImageIcon(getClass().getResource(
 122           "/images/error.png"));
 123
 124   protected ImageIcon warningImage = new ImageIcon(getClass().getResource(
 125           "/images/warning.gif"));
 126
 127   protected JLabel lbl_warning = new JLabel(warningImage);
 128
 129   protected JLabel lbl_loading = new JLabel(loadingImage);
 130
 131   protected JLabel lbl_pdbManualFetchStatus = new JLabel(errorImage);
 132
 133   protected JLabel lbl_fromFileStatus = new JLabel(errorImage);
 134
 135
 136   protected AssciateSeqPanel idInputAssSeqPanel = new AssciateSeqPanel();
 137
 138   protected AssciateSeqPanel fileChooserAssSeqPanel = new AssciateSeqPanel();
 139
 140   protected static final String VIEWS_FILTER = "VIEWS_FILTER";
 141
 142   protected static final String VIEWS_FROM_FILE = "VIEWS_FROM_FILE";
 143
 144   protected static final String VIEWS_ENTER_ID = "VIEWS_ENTER_ID";
 145
 146   protected static final String VIEWS_LOCAL_PDB = "VIEWS_LOCAL_PDB";
 147
 148   protected JTable tbl_summary = new JTable();
 149
 150   protected JScrollPane scrl_foundStructures = new JScrollPane(
 151           tbl_summary);
 152
 153   protected JTable tbl_local_pdb = new JTable();
 154
 155   protected JScrollPane scrl_localPDB = new JScrollPane(tbl_local_pdb);
 156
 157   private JTabbedPane pnl_filter = new JTabbedPane();
 158
 159   private PDBDocFieldPreferences pdbDocFieldPrefs = new PDBDocFieldPreferences(
 160           PreferenceSource.STRUCTURE_CHOOSER);
 161
 162   public GStructureChooser()
 163   {
 164     try
 165     {
 166       jbInit();
 167       mainFrame.setVisible(false);
 168       mainFrame.invalidate();
 169       mainFrame.pack();
 170     } catch (Exception e)
 171     {
 172       e.printStackTrace();
 173     }
 174   }
 175
 176   /**
 177    * Initializes the GUI default properties
 178    *
 179    * @throws Exception
 180    */
 181   private void jbInit() throws Exception
 182   {
 183     tbl_summary.setAutoCreateRowSorter(true);
 184     tbl_local_pdb.setAutoCreateRowSorter(true);
 185     tbl_local_pdb.addMouseListener(new MouseAdapter()
 186     {
 187       public void mouseClicked(MouseEvent e)
 188       {
 189         updateCurrentView();
 190       }
 191
 192       public void mouseReleased(MouseEvent e)
 193       {
 194         updateCurrentView();
 195       }
 196     });
 197
 198     btn_view.setFont(new java.awt.Font("Verdana", 0, 12));
 199     btn_view.setText(MessageManager.getString("action.view"));
 200     btn_view.addActionListener(new java.awt.event.ActionListener()
 201     {
 202       public void actionPerformed(ActionEvent e)
 203       {
 204         ok_ActionPerformed();
 205       }
 206     });
 207     btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
 208     btn_cancel.setText(MessageManager.getString("action.cancel"));
 209     btn_cancel.addActionListener(new java.awt.event.ActionListener()
 210     {
 211       public void actionPerformed(ActionEvent e)
 212       {
 213         mainFrame.dispose();
 214       }
 215     });
 216
 217     btn_pdbFromFile.setFont(new java.awt.Font("Verdana", 0, 12));
 218     String btn_title = MessageManager.getString("label.select_pdb_file");
 219     btn_pdbFromFile.setText(btn_title + "              ");
 220     btn_pdbFromFile.addActionListener(new java.awt.event.ActionListener()
 221     {
 222       public void actionPerformed(ActionEvent e)
 223       {
 224         pdbFromFile_actionPerformed();
 225       }
 226     });
 227
 228     scrl_foundStructures.setPreferredSize(new Dimension(500, 300));
 229     scrl_foundStructures
 230             .setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
 231
 232     scrl_localPDB.setPreferredSize(new Dimension(500, 300));
 233     scrl_localPDB
 234             .setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
 235
 236     cmb_filterOption.setFont(new java.awt.Font("Verdana", 0, 12));
 237     chk_invertFilter.setFont(new java.awt.Font("Verdana", 0, 12));
 238     chk_rememberSettings.setFont(new java.awt.Font("Verdana", 0, 12));
 239
 240
 241     txt_search.setToolTipText(MessageManager
 242             .getString("label.enter_pdb_id"));
 243     cmb_filterOption.setToolTipText(MessageManager
 244             .getString("info.select_filter_option"));
 245     txt_search.getDocument().addDocumentListener(new DocumentListener()
 246     {
 247       @Override
 248       public void insertUpdate(DocumentEvent e)
 249       {
 250         txt_search_ActionPerformed();
 251       }
 252
 253       @Override
 254       public void removeUpdate(DocumentEvent e)
 255       {
 256         txt_search_ActionPerformed();
 257       }
 258
 259       @Override
 260       public void changedUpdate(DocumentEvent e)
 261       {
 262         txt_search_ActionPerformed();
 263       }
 264     });
 265
 266     cmb_filterOption.addItemListener(this);
 267     chk_invertFilter.addItemListener(this);
 268
 269     pnl_actions.add(chk_rememberSettings);
 270     pnl_actions.add(btn_view);
 271     pnl_actions.add(btn_cancel);
 272
 273     // pnl_filter.add(lbl_result);
 274     pnl_main.add(cmb_filterOption);
 275     pnl_main.add(lbl_loading);
 276     pnl_main.add(chk_invertFilter);
 277     lbl_loading.setVisible(false);
 278
 279
 280     pnl_fileChooser.add(btn_pdbFromFile);
 281     pnl_fileChooser.add(lbl_fromFileStatus);
 282     pnl_fileChooserBL.add(fileChooserAssSeqPanel, BorderLayout.NORTH);
 283     pnl_fileChooserBL.add(pnl_fileChooser, BorderLayout.CENTER);
 284
 285     pnl_idInput.add(txt_search);
 286     pnl_idInput.add(lbl_pdbManualFetchStatus);
 287     pnl_idInputBL.add(idInputAssSeqPanel, BorderLayout.NORTH);
 288     pnl_idInputBL.add(pnl_idInput, BorderLayout.CENTER);
 289
 290     final String foundStructureSummary = MessageManager
 291             .getString("label.found_structures_summary");
 292
 293     ChangeListener changeListener = new ChangeListener()
 294     {
 295       public void stateChanged(ChangeEvent changeEvent)
 296       {
 297         JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
 298                 .getSource();
 299         int index = sourceTabbedPane.getSelectedIndex();
 300         if (sourceTabbedPane.getTitleAt(index)
 301                 .equals(foundStructureSummary))
 302         {
 303           tabRefresh();
 304         }
 305       }
 306     };
 307     pnl_filter.addChangeListener(changeListener);
 308     pnl_filter.setPreferredSize(new Dimension(500, 300));
 309     pnl_filter.add(foundStructureSummary, scrl_foundStructures);
 310     pnl_filter.add(
 311             MessageManager.getString("label.configure_displayed_columns"),
 312             pdbDocFieldPrefs);
 313
 314     pnl_locPDB.add(scrl_localPDB);
 315
 316     pnl_switchableViews.add(pnl_fileChooserBL, VIEWS_FROM_FILE);
 317     pnl_switchableViews.add(pnl_idInputBL, VIEWS_ENTER_ID);
 318     pnl_switchableViews.add(pnl_filter, VIEWS_FILTER);
 319     pnl_switchableViews.add(pnl_locPDB, VIEWS_LOCAL_PDB);
 320
 321     this.setLayout(mainLayout);
 322     this.add(pnl_main, java.awt.BorderLayout.NORTH);
 323     this.add(pnl_switchableViews, java.awt.BorderLayout.CENTER);
 324     this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
 325
 326     mainFrame.setVisible(true);
 327     mainFrame.setContentPane(this);
 328     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
 329     Desktop.addInternalFrame(mainFrame, frameTitle, 800, 400);
 330   }
 331
 332
 333   @Override
 334   /**
 335    * Event listener for the 'filter' combo-box and 'invert' check-box
 336    */
 337   public void itemStateChanged(ItemEvent e)
 338   {
 339     stateChanged(e);
 340   }
 341
 342   /**
 343    * This inner class provides the data model for the structure filter combo-box
 344    *
 345    * @author tcnofoegbu
 346    *
 347    */
 348   public class FilterOption
 349   {
 350     private String name;
 351
 352     private String value;
 353
 354     private String view;
 355
 356     public FilterOption(String name, String value, String view)
 357     {
 358       this.name = name;
 359       this.value = value;
 360       this.view = view;
 361     }
 362
 363     public String getName()
 364     {
 365       return name;
 366     }
 367
 368     public void setName(String name)
 369     {
 370       this.name = name;
 371     }
 372
 373     public String getValue()
 374     {
 375       return value;
 376     }
 377
 378     public void setValue(String value)
 379     {
 380       this.value = value;
 381     }
 382
 383     public String getView()
 384     {
 385       return view;
 386     }
 387
 388     public void setView(String view)
 389     {
 390       this.view = view;
 391     }
 392
 393     public String toString()
 394     {
 395       return this.name;
 396     }
 397   }
 398
 399   /**
 400    * This inner class provides the provides the data model for associate
 401    * sequence combo-box - cmb_assSeq
 402    *
 403    * @author tcnofoegbu
 404    *
 405    */
 406   public class AssociateSeqOptions
 407   {
 408     private SequenceI sequence;
 409     private String name;
 410
 411     public AssociateSeqOptions(SequenceI seq)
 412     {
 413       this.sequence = seq;
 414       this.name = (seq.getName().length() >= 23) ? seq.getName().substring(
 415               0, 23) : seq.getName();
 416     }
 417
 418     public AssociateSeqOptions(String name, SequenceI seq)
 419     {
 420       this.name = name;
 421       this.sequence = seq;
 422     }
 423
 424     public String toString()
 425     {
 426       return name;
 427     }
 428
 429     public String getName()
 430     {
 431       return name;
 432     }
 433
 434     public void setName(String name)
 435     {
 436       this.name = name;
 437     }
 438
 439     public SequenceI getSequence()
 440     {
 441       return sequence;
 442     }
 443
 444     public void setSequence(SequenceI sequence)
 445     {
 446       this.sequence = sequence;
 447     }
 448
 449   }
 450
 451   /**
 452    * This inner class holds the Layout and configuration of the panel which
 453    * handles association of manually fetched structures to a unique sequence
 454    * when more than one sequence selection is made
 455    *
 456    * @author tcnofoegbu
 457    *
 458    */
 459   public class AssciateSeqPanel extends JPanel implements ItemListener
 460   {
 461     private JComboBox<AssociateSeqOptions> cmb_assSeq = new JComboBox<AssociateSeqOptions>();
 462
 463     private JLabel lbl_associateSeq = new JLabel();
 464
 465     public AssciateSeqPanel()
 466     {
 467       this.setLayout(new FlowLayout());
 468       this.add(cmb_assSeq);
 469       this.add(lbl_associateSeq);
 470       cmb_assSeq.setToolTipText(MessageManager
 471               .getString("info.associate_wit_sequence"));
 472       cmb_assSeq.addItemListener(this);
 473     }
 474
 475     public void loadCmbAssSeq()
 476     {
 477       populateCmbAssociateSeqOptions(cmb_assSeq, lbl_associateSeq);
 478     }
 479
 480     public JComboBox<AssociateSeqOptions> getCmb_assSeq()
 481     {
 482       return cmb_assSeq;
 483     }
 484
 485     public void setCmb_assSeq(JComboBox<AssociateSeqOptions> cmb_assSeq)
 486     {
 487       this.cmb_assSeq = cmb_assSeq;
 488     }
 489
 490     @Override
 491     public void itemStateChanged(ItemEvent e)
 492     {
 493       if (e.getStateChange() == ItemEvent.SELECTED)
 494       {
 495         cmbAssSeqStateChanged();
 496       }
 497     }
 498   }
 499
 500   public JComboBox<FilterOption> getCmbFilterOption()
 501   {
 502     return cmb_filterOption;
 503   }
 504
 505   protected abstract void stateChanged(ItemEvent e);
 506
 507   protected abstract void updateCurrentView();
 508
 509   protected abstract void populateFilterComboBox();
 510
 511   protected abstract void ok_ActionPerformed();
 512
 513   protected abstract void pdbFromFile_actionPerformed();
 514
 515   protected abstract void txt_search_ActionPerformed();
 516
 517   public abstract void populateCmbAssociateSeqOptions(
 518           JComboBox<AssociateSeqOptions> cmb_assSeq, JLabel lbl_associateSeq);
 519
 520   public abstract void cmbAssSeqStateChanged();
 521
 522   public abstract void tabRefresh();
 523 }