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  + "...")
 100                       : JvSwingUtils.wrapTooltip(true,
 101                       toolTipText)));
 102
 103       return toolTipText;
 104     }
 105   };
 106
 107   protected StringBuilder errorWarning = new StringBuilder();
 108
 109   protected JScrollPane scrl_searchResult = new JScrollPane(
 110 tbl_summary);
 111
 112   protected ImageIcon warningImage = new ImageIcon(getClass().getResource(
 113           "/images/warning.gif"));
 114
 115   protected ImageIcon loadingImage = new ImageIcon(getClass().getResource(
 116           "/images/loading.gif"));
 117   protected JLabel lbl_warning = new JLabel(warningImage);
 118
 119   protected JLabel lbl_loading = new JLabel(loadingImage);
 120
 121   private JTabbedPane tabbedPane = new JTabbedPane();
 122
 123   private PDBDocFieldPreferences pdbDocFieldPrefs = new PDBDocFieldPreferences(
 124           PreferenceSource.SEARCH_SUMMARY);
 125
 126   private JPanel pnl_actions = new JPanel();
 127
 128   private JPanel pnl_results = new JPanel();
 129
 130   private JPanel pnl_inputs = new JPanel();
 131
 132   private BorderLayout mainLayout = new BorderLayout();
 133
 134   protected PDBDocField[] previousWantedFields;
 135
 136   public GPDBSearchPanel()
 137   {
 138     try
 139     {
 140       jbInit();
 141       mainFrame.invalidate();
 142       mainFrame.pack();
 143     } catch (Exception e)
 144     {
 145       e.printStackTrace();
 146     }
 147   }
 148
 149   /**
 150    * Initializes the GUI default properties
 151    *
 152    * @throws Exception
 153    */
 154   private void jbInit() throws Exception
 155   {
 156     lbl_warning.setVisible(false);
 157     lbl_warning.setFont(new java.awt.Font("Verdana", 0, 12));
 158     lbl_loading.setVisible(false);
 159     lbl_loading.setFont(new java.awt.Font("Verdana", 0, 12));
 160
 161     tbl_summary.setAutoCreateRowSorter(true);
 162     tbl_summary.getTableHeader().setReorderingAllowed(false);
 163     tbl_summary.addMouseListener(new MouseAdapter()
 164     {
 165       public void mouseClicked(MouseEvent e)
 166       {
 167         validateSelection();
 168       }
 169       public void mouseReleased(MouseEvent e)
 170       {
 171         validateSelection();
 172       }
 173     });
 174
 175     btn_back.setFont(new java.awt.Font("Verdana", 0, 12));
 176     btn_back.setText(MessageManager.getString("action.back"));
 177     btn_back.addActionListener(new java.awt.event.ActionListener()
 178     {
 179       public void actionPerformed(ActionEvent e)
 180       {
 181         btn_back_ActionPerformed();
 182       }
 183     });
 184
 185     btn_ok.setEnabled(false);
 186     btn_ok.setFont(new java.awt.Font("Verdana", 0, 12));
 187     btn_ok.setText(MessageManager.getString("action.ok"));
 188     btn_ok.addActionListener(new java.awt.event.ActionListener()
 189     {
 190       public void actionPerformed(ActionEvent e)
 191       {
 192         btn_ok_ActionPerformed();
 193       }
 194     });
 195     btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
 196     btn_cancel.setText(MessageManager.getString("action.cancel"));
 197     btn_cancel.addActionListener(new java.awt.event.ActionListener()
 198     {
 199       public void actionPerformed(ActionEvent e)
 200       {
 201         btn_cancel_ActionPerformed();
 202       }
 203     });
 204
 205
 206     scrl_searchResult.setPreferredSize(new Dimension(500, 300));
 207     scrl_searchResult
 208             .setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
 209
 210     cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
 211     cmb_searchTarget.addActionListener(new ActionListener()
 212     {
 213       @Override
 214       public void actionPerformed(ActionEvent e)
 215       {
 216         String tooltipText;
 217         if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
 218                 .toString()))
 219         {
 220           tooltipText = MessageManager.getString("label.search_all");
 221         }
 222         else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
 223                 .getSelectedItem().toString()))
 224         {
 225           tooltipText = MessageManager
 226                   .getString("label.separate_multiple_accession_ids");
 227         }
 228         else
 229         {
 230           tooltipText = MessageManager.formatMessage(
 231                   "label.separate_multiple_query_values", new Object[]
 232                   { getCmbSearchTarget().getSelectedItem().toString() });
 233         }
 234         txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
 235                 tooltipText));
 236         txt_search_ActionPerformed();
 237       }
 238     });
 239
 240     populateCmbSearchTargetOptions();
 241
 242
 243     txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
 244
 245     txt_search.addKeyListener(new KeyAdapter()
 246     {
 247       @Override
 248       public void keyPressed(KeyEvent e)
 249       {
 250         if (e.getKeyCode() == KeyEvent.VK_ENTER)
 251         {
 252           if (txt_search.getText() == null
 253                   || txt_search.getText().isEmpty())
 254           {
 255             return;
 256           }
 257           if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
 258                   .getSelectedItem().toString()))
 259           {
 260             transferToSequenceFetcher(txt_search.getText());
 261           }
 262         }
 263       }
 264     });
 265
 266     txt_search.getDocument().addDocumentListener(new DocumentListener()
 267     {
 268       @Override
 269       public void insertUpdate(DocumentEvent e)
 270       {
 271         txt_search_ActionPerformed();
 272       }
 273
 274       @Override
 275       public void removeUpdate(DocumentEvent e)
 276       {
 277         txt_search_ActionPerformed();
 278       }
 279
 280       @Override
 281       public void changedUpdate(DocumentEvent e)
 282       {
 283         txt_search_ActionPerformed();
 284       }
 285     });
 286
 287     final String searchTabTitle = MessageManager
 288             .getString("label.search_result");
 289     final String configureCols = MessageManager.getString("label.configure_displayed_columns");
 290     ChangeListener changeListener = new ChangeListener()
 291     {
 292       public void stateChanged(ChangeEvent changeEvent)
 293       {
 294         JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
 295                 .getSource();
 296         int index = sourceTabbedPane.getSelectedIndex();
 297         if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
 298         {
 299           btn_back.setEnabled(false);
 300           btn_cancel.setEnabled(false);
 301           btn_ok.setEnabled(false);
 302           previousWantedFields = PDBDocFieldPreferences
 303                   .getSearchSummaryFields().toArray(new PDBDocField[0]);
 304         }
 305         if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
 306         {
 307           btn_back.setEnabled(true);
 308           btn_cancel.setEnabled(true);
 309           if (wantedFieldsUpdated())
 310           {
 311             txt_search_ActionPerformed();
 312           }
 313           else
 314           {
 315             validateSelection();
 316           }
 317         }
 318       }
 319     };
 320     tabbedPane.addChangeListener(changeListener);
 321     tabbedPane.setPreferredSize(new Dimension(500, 300));
 322     tabbedPane.add(searchTabTitle, scrl_searchResult);
 323     tabbedPane.add(configureCols, pdbDocFieldPrefs);
 324
 325     pnl_actions.add(btn_back);
 326     pnl_actions.add(btn_ok);
 327     pnl_actions.add(btn_cancel);
 328
 329     pnl_results.add(tabbedPane);
 330     pnl_inputs.add(cmb_searchTarget);
 331     pnl_inputs.add(txt_search);
 332     pnl_inputs.add(lbl_loading);
 333     pnl_inputs.add(lbl_warning);
 334
 335     this.setLayout(mainLayout);
 336     this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
 337     this.add(pnl_results, java.awt.BorderLayout.CENTER);
 338     this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
 339     mainFrame.setVisible(true);
 340     mainFrame.setContentPane(this);
 341     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
 342     Desktop.addInternalFrame(mainFrame, frameTitle, 800, 400);
 343   }
 344
 345   public boolean wantedFieldsUpdated()
 346   {
 347     if (previousWantedFields == null)
 348     {
 349       return true;
 350     }
 351
 352     return Arrays.equals(PDBDocFieldPreferences.getSearchSummaryFields()
 353             .toArray(new PDBDocField[0]), previousWantedFields) ? false
 354             : true;
 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   public JComboBox<PDBDocField> getCmbSearchTarget()
 369   {
 370     return cmb_searchTarget;
 371   }
 372
 373   public JTextField getTxtSearch()
 374   {
 375     return txt_search;
 376   }
 377
 378   public JInternalFrame getMainFrame()
 379   {
 380     return mainFrame;
 381   }
 382
 383   public abstract void transferToSequenceFetcher(String ids);
 384
 385   public abstract void txt_search_ActionPerformed();
 386
 387   public abstract void btn_ok_ActionPerformed();
 388
 389   public abstract void btn_back_ActionPerformed();
 390
 391   public abstract void btn_cancel_ActionPerformed();
 392
 393   public abstract void populateCmbSearchTargetOptions();
 394
 395 }