src/jalview/jbgui/GPDBSearchPanel.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.gui.Desktop;
  25 import jalview.gui.JvSwingUtils;
  26 import jalview.jbgui.PDBDocFieldPreferences.PreferenceSource;
  27 import jalview.util.MessageManager;
  28 import jalview.ws.dbsources.PDBRestClient.PDBDocField;
  29
  30 import java.awt.BorderLayout;
  31 import java.awt.Dimension;
  32 import java.awt.event.ActionEvent;
  33 import java.awt.event.ActionListener;
  34 import java.awt.event.KeyAdapter;
  35 import java.awt.event.KeyEvent;
  36 import java.awt.event.MouseAdapter;
  37 import java.awt.event.MouseEvent;
  38 import java.util.Arrays;
  39
  40 import javax.swing.ImageIcon;
  41 import javax.swing.JButton;
  42 import javax.swing.JComboBox;
  43 import javax.swing.JFrame;
  44 import javax.swing.JInternalFrame;
  45 import javax.swing.JLabel;
  46 import javax.swing.JPanel;
  47 import javax.swing.JScrollPane;
  48 import javax.swing.JTabbedPane;
  49 import javax.swing.JTable;
  50 import javax.swing.JTextField;
  51 import javax.swing.event.ChangeEvent;
  52 import javax.swing.event.ChangeListener;
  53 import javax.swing.event.DocumentEvent;
  54 import javax.swing.event.DocumentListener;
  55
  56 /**
  57  * GUI layout for PDB Fetch Panel
  58  *
  59  * @author tcnofoegbu
  60  *
  61  */
  62 @SuppressWarnings("serial")
  63 public abstract class GPDBSearchPanel extends JPanel
  64 {
  65   protected String frameTitle = MessageManager
  66           .getString("label.pdb_sequence_getcher");
  67
  68   protected JInternalFrame mainFrame = new JInternalFrame(frameTitle);
  69
  70   protected JComboBox<PDBDocField> cmb_searchTarget = new JComboBox<PDBDocField>();
  71
  72   protected JButton btn_ok = new JButton();
  73
  74   protected JButton btn_back = new JButton();
  75
  76   protected JButton btn_cancel = new JButton();
  77
  78   protected JTextField txt_search = new JTextField(20);
  79
  80   protected JTable tbl_summary = new JTable()
  81   {
  82     public String getToolTipText(MouseEvent evt)
  83     {
  84       String toolTipText = null;
  85       java.awt.Point pnt = evt.getPoint();
  86       int rowIndex = rowAtPoint(pnt);
  87       int colIndex = columnAtPoint(pnt);
  88
  89       try
  90       {
  91         toolTipText = getValueAt(rowIndex, colIndex).toString();
  92       } catch (Exception e)
  93       {
  94         e.printStackTrace();
  95       }
  96       toolTipText = (toolTipText == null ? null
  97               : (toolTipText.length() > 500 ? JvSwingUtils.wrapTooltip(
  98                       true, toolTipText.subSequence(0, 500) + "...")
  99                       : JvSwingUtils.wrapTooltip(true, toolTipText)));
 100
 101       return toolTipText;
 102     }
 103   };
 104
 105   protected StringBuilder errorWarning = new StringBuilder();
 106
 107   protected JScrollPane scrl_searchResult = new JScrollPane(tbl_summary);
 108
 109   protected ImageIcon warningImage = new ImageIcon(getClass().getResource(
 110           "/images/warning.gif"));
 111
 112   protected ImageIcon loadingImage = new ImageIcon(getClass().getResource(
 113           "/images/loading.gif"));
 114
 115   protected JLabel lbl_warning = new JLabel(warningImage);
 116
 117   protected JLabel lbl_loading = new JLabel(loadingImage);
 118
 119   private JTabbedPane tabbedPane = new JTabbedPane();
 120
 121   private PDBDocFieldPreferences pdbDocFieldPrefs = new PDBDocFieldPreferences(
 122           PreferenceSource.SEARCH_SUMMARY);
 123
 124   private JPanel pnl_actions = new JPanel();
 125
 126   private JPanel pnl_results = new JPanel();
 127
 128   private JPanel pnl_inputs = new JPanel();
 129
 130   private BorderLayout mainLayout = new BorderLayout();
 131
 132   protected PDBDocField[] previousWantedFields;
 133
 134   public GPDBSearchPanel()
 135   {
 136     try
 137     {
 138       jbInit();
 139       mainFrame.invalidate();
 140       mainFrame.pack();
 141     } catch (Exception e)
 142     {
 143       e.printStackTrace();
 144     }
 145   }
 146
 147   /**
 148    * Initializes the GUI default properties
 149    *
 150    * @throws Exception
 151    */
 152   private void jbInit() throws Exception
 153   {
 154     lbl_warning.setVisible(false);
 155     lbl_warning.setFont(new java.awt.Font("Verdana", 0, 12));
 156     lbl_loading.setVisible(false);
 157     lbl_loading.setFont(new java.awt.Font("Verdana", 0, 12));
 158
 159     tbl_summary.setAutoCreateRowSorter(true);
 160     tbl_summary.getTableHeader().setReorderingAllowed(false);
 161     tbl_summary.addMouseListener(new MouseAdapter()
 162     {
 163       public void mouseClicked(MouseEvent e)
 164       {
 165         validateSelection();
 166       }
 167
 168       public void mouseReleased(MouseEvent e)
 169       {
 170         validateSelection();
 171       }
 172     });
 173
 174     btn_back.setFont(new java.awt.Font("Verdana", 0, 12));
 175     btn_back.setText(MessageManager.getString("action.back"));
 176     btn_back.addActionListener(new java.awt.event.ActionListener()
 177     {
 178       public void actionPerformed(ActionEvent e)
 179       {
 180         btn_back_ActionPerformed();
 181       }
 182     });
 183
 184     btn_ok.setEnabled(false);
 185     btn_ok.setFont(new java.awt.Font("Verdana", 0, 12));
 186     btn_ok.setText(MessageManager.getString("action.ok"));
 187     btn_ok.addActionListener(new java.awt.event.ActionListener()
 188     {
 189       public void actionPerformed(ActionEvent e)
 190       {
 191         btn_ok_ActionPerformed();
 192       }
 193     });
 194     btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
 195     btn_cancel.setText(MessageManager.getString("action.cancel"));
 196     btn_cancel.addActionListener(new java.awt.event.ActionListener()
 197     {
 198       public void actionPerformed(ActionEvent e)
 199       {
 200         btn_cancel_ActionPerformed();
 201       }
 202     });
 203
 204     scrl_searchResult.setPreferredSize(new Dimension(500, 300));
 205     scrl_searchResult
 206             .setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
 207
 208     cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
 209     cmb_searchTarget.addActionListener(new ActionListener()
 210     {
 211       @Override
 212       public void actionPerformed(ActionEvent e)
 213       {
 214         String tooltipText;
 215         if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
 216                 .toString()))
 217         {
 218           tooltipText = MessageManager.getString("label.search_all");
 219         }
 220         else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
 221                 .getSelectedItem().toString()))
 222         {
 223           tooltipText = MessageManager
 224                   .getString("label.separate_multiple_accession_ids");
 225         }
 226         else
 227         {
 228           tooltipText = MessageManager.formatMessage(
 229                   "label.separate_multiple_query_values",
 230                   new Object[] { getCmbSearchTarget().getSelectedItem()
 231                           .toString() });
 232         }
 233         txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
 234                 tooltipText));
 235         txt_search_ActionPerformed();
 236       }
 237     });
 238
 239     populateCmbSearchTargetOptions();
 240
 241     txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
 242
 243     txt_search.addKeyListener(new KeyAdapter()
 244     {
 245       @Override
 246       public void keyPressed(KeyEvent e)
 247       {
 248         if (e.getKeyCode() == KeyEvent.VK_ENTER)
 249         {
 250           if (txt_search.getText() == null
 251                   || txt_search.getText().isEmpty())
 252           {
 253             return;
 254           }
 255           if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
 256                   .getSelectedItem().toString()))
 257           {
 258             transferToSequenceFetcher(txt_search.getText());
 259           }
 260         }
 261       }
 262     });
 263
 264     txt_search.getDocument().addDocumentListener(new DocumentListener()
 265     {
 266       @Override
 267       public void insertUpdate(DocumentEvent e)
 268       {
 269         txt_search_ActionPerformed();
 270       }
 271
 272       @Override
 273       public void removeUpdate(DocumentEvent e)
 274       {
 275         txt_search_ActionPerformed();
 276       }
 277
 278       @Override
 279       public void changedUpdate(DocumentEvent e)
 280       {
 281         txt_search_ActionPerformed();
 282       }
 283     });
 284
 285     final String searchTabTitle = MessageManager
 286             .getString("label.search_result");
 287     final String configureCols = MessageManager
 288             .getString("label.configure_displayed_columns");
 289     ChangeListener changeListener = new ChangeListener()
 290     {
 291       public void stateChanged(ChangeEvent changeEvent)
 292       {
 293         JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
 294                 .getSource();
 295         int index = sourceTabbedPane.getSelectedIndex();
 296         if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
 297         {
 298           btn_back.setEnabled(false);
 299           btn_cancel.setEnabled(false);
 300           btn_ok.setEnabled(false);
 301           previousWantedFields = PDBDocFieldPreferences
 302                   .getSearchSummaryFields().toArray(new PDBDocField[0]);
 303         }
 304         if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
 305         {
 306           btn_back.setEnabled(true);
 307           btn_cancel.setEnabled(true);
 308           if (wantedFieldsUpdated())
 309           {
 310             txt_search_ActionPerformed();
 311           }
 312           else
 313           {
 314             validateSelection();
 315           }
 316         }
 317       }
 318     };
 319     tabbedPane.addChangeListener(changeListener);
 320     tabbedPane.setPreferredSize(new Dimension(500, 300));
 321     tabbedPane.add(searchTabTitle, scrl_searchResult);
 322     tabbedPane.add(configureCols, pdbDocFieldPrefs);
 323
 324     pnl_actions.add(btn_back);
 325     pnl_actions.add(btn_ok);
 326     pnl_actions.add(btn_cancel);
 327
 328     pnl_results.add(tabbedPane);
 329     pnl_inputs.add(cmb_searchTarget);
 330     pnl_inputs.add(txt_search);
 331     pnl_inputs.add(lbl_loading);
 332     pnl_inputs.add(lbl_warning);
 333
 334     this.setLayout(mainLayout);
 335     this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
 336     this.add(pnl_results, java.awt.BorderLayout.CENTER);
 337     this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
 338     mainFrame.setVisible(true);
 339     mainFrame.setContentPane(this);
 340     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
 341     Desktop.addInternalFrame(mainFrame, frameTitle, 800, 400);
 342   }
 343
 344   public boolean wantedFieldsUpdated()
 345   {
 346     if (previousWantedFields == null)
 347     {
 348       return true;
 349     }
 350
 351     return Arrays.equals(PDBDocFieldPreferences.getSearchSummaryFields()
 352             .toArray(new PDBDocField[0]), previousWantedFields) ? false
 353             : true;
 354
 355   }
 356
 357   public void validateSelection()
 358   {
 359     if (tbl_summary.getSelectedRows().length > 0)
 360     {
 361       btn_ok.setEnabled(true);
 362     }
 363     else
 364     {
 365       btn_ok.setEnabled(false);
 366     }
 367   }
 368
 369   public JComboBox<PDBDocField> getCmbSearchTarget()
 370   {
 371     return cmb_searchTarget;
 372   }
 373
 374   public JTextField getTxtSearch()
 375   {
 376     return txt_search;
 377   }
 378
 379   public JInternalFrame getMainFrame()
 380   {
 381     return mainFrame;
 382   }
 383
 384   public abstract void transferToSequenceFetcher(String ids);
 385
 386   public abstract void txt_search_ActionPerformed();
 387
 388   public abstract void btn_ok_ActionPerformed();
 389
 390   public abstract void btn_back_ActionPerformed();
 391
 392   public abstract void btn_cancel_ActionPerformed();
 393
 394   public abstract void populateCmbSearchTargetOptions();
 395
 396 }