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