src/jalview/jbgui/GStructureChooser.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ 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.fts.api.FTSDataColumnI;
  26 import jalview.fts.core.FTSDataColumnPreferences;
  27 import jalview.fts.core.FTSDataColumnPreferences.PreferenceSource;
  28 import jalview.fts.service.pdb.PDBFTSRestClient;
  29 import jalview.gui.AlignmentPanel;
  30 import jalview.gui.Desktop;
  31 import jalview.gui.JvSwingUtils;
  32 import jalview.gui.StructureViewer;
  33 import jalview.util.MessageManager;
  34
  35 import java.awt.BorderLayout;
  36 import java.awt.CardLayout;
  37 import java.awt.Component;
  38 import java.awt.Dimension;
  39 import java.awt.FlowLayout;
  40 import java.awt.Font;
  41 import java.awt.GridLayout;
  42 import java.awt.Point;
  43 import java.awt.event.ActionEvent;
  44 import java.awt.event.ActionListener;
  45 import java.awt.event.ItemEvent;
  46 import java.awt.event.ItemListener;
  47 import java.awt.event.KeyAdapter;
  48 import java.awt.event.KeyEvent;
  49 import java.awt.event.MouseAdapter;
  50 import java.awt.event.MouseEvent;
  51 import java.util.Arrays;
  52 import java.util.HashMap;
  53 import java.util.Map;
  54
  55 import javax.swing.ImageIcon;
  56 import javax.swing.JButton;
  57 import javax.swing.JCheckBox;
  58 import javax.swing.JComboBox;
  59 import javax.swing.JFrame;
  60 import javax.swing.JInternalFrame;
  61 import javax.swing.JLabel;
  62 import javax.swing.JList;
  63 import javax.swing.JPanel;
  64 import javax.swing.JScrollPane;
  65 import javax.swing.JSeparator;
  66 import javax.swing.JTabbedPane;
  67 import javax.swing.JTable;
  68 import javax.swing.JTextField;
  69 import javax.swing.ListCellRenderer;
  70 import javax.swing.Timer;
  71 import javax.swing.UIManager;
  72 import javax.swing.event.ChangeEvent;
  73 import javax.swing.event.ChangeListener;
  74 import javax.swing.event.DocumentEvent;
  75 import javax.swing.event.DocumentListener;
  76 import javax.swing.event.InternalFrameEvent;
  77 import javax.swing.table.TableColumn;
  78
  79 import net.miginfocom.swing.MigLayout;
  80
  81 @SuppressWarnings("serial")
  82 /**
  83  * GUI layout for structure chooser
  84  *
  85  * @author tcnofoegbu
  86  *
  87  */
  88 public abstract class GStructureChooser extends JPanel
  89         implements ItemListener
  90 {
  91   private static final Font VERDANA_12 = new Font("Verdana", 0, 12);
  92
  93   public static final String VIEWS_FILTER = "VIEWS_FILTER";
  94
  95   protected static final String VIEWS_FROM_FILE = "VIEWS_FROM_FILE";
  96
  97   protected static final String VIEWS_ENTER_ID = "VIEWS_ENTER_ID";
  98
  99   /*
 100    * 'cached' structure view
 101    */
 102   protected static final String VIEWS_LOCAL_PDB = "VIEWS_LOCAL_PDB";
 103
 104   protected JPanel statusPanel = new JPanel();
 105
 106   public JLabel statusBar = new JLabel();
 107
 108   protected String frameTitle = MessageManager
 109           .getString("label.structure_chooser");
 110
 111   protected JInternalFrame mainFrame = new JInternalFrame(frameTitle);
 112
 113   protected JComboBox<FilterOption> cmb_filterOption = new JComboBox<>();
 114
 115   protected AlignmentPanel ap;
 116
 117   protected StringBuilder errorWarning = new StringBuilder();
 118
 119   protected JButton btn_add;
 120
 121   protected JButton btn_newView;
 122
 123   protected JButton btn_pdbFromFile = new JButton();
 124
 125   protected JButton btn_queryTDB = new JButton();
 126
 127   protected JCheckBox chk_superpose = new JCheckBox(
 128           MessageManager.getString("label.superpose_structures"));
 129
 130   protected JTextField txt_search = new JTextField(14);
 131
 132   protected JPanel pnl_switchableViews = new JPanel(new CardLayout());
 133
 134   protected CardLayout layout_switchableViews = (CardLayout) (pnl_switchableViews
 135           .getLayout());
 136
 137   protected JCheckBox chk_invertFilter = new JCheckBox(
 138           MessageManager.getString("label.invert"));
 139
 140   protected ImageIcon loadingImage = new ImageIcon(
 141           getClass().getResource("/images/loading.gif"));
 142
 143   protected ImageIcon goodImage = new ImageIcon(
 144           getClass().getResource("/images/good.png"));
 145
 146   protected ImageIcon errorImage = new ImageIcon(
 147           getClass().getResource("/images/error.png"));
 148
 149   protected ImageIcon warningImage = new ImageIcon(
 150           getClass().getResource("/images/warning.gif"));
 151
 152   protected ImageIcon tdbImage = new ImageIcon(getClass()
 153           .getResource("/images/3d-beacons-logo-transparent.png"));
 154
 155   protected JLabel lbl_loading = new JLabel(loadingImage);
 156
 157   protected JLabel lbl_pdbManualFetchStatus = new JLabel(errorImage);
 158
 159   protected JLabel lbl_fromFileStatus = new JLabel(errorImage);
 160
 161   protected AssociateSeqPanel idInputAssSeqPanel = new AssociateSeqPanel();
 162
 163   protected AssociateSeqPanel fileChooserAssSeqPanel = new AssociateSeqPanel();
 164
 165   protected JComboBox<StructureViewer> targetView = new JComboBox<>();
 166
 167   protected JTable tbl_local_pdb = new JTable();
 168
 169   protected JTabbedPane pnl_filter = new JTabbedPane();
 170
 171   protected abstract FTSDataColumnPreferences getFTSDocFieldPrefs();
 172
 173   protected abstract void setFTSDocFieldPrefs(
 174           FTSDataColumnPreferences newPrefs);
 175
 176   protected FTSDataColumnI[] previousWantedFields;
 177
 178   protected static Map<String, Integer> tempUserPrefs = new HashMap<>();
 179
 180   private JTable tbl_summary = new JTable()
 181   {
 182     private boolean inLayout;
 183
 184     @Override
 185     public boolean getScrollableTracksViewportWidth()
 186     {
 187       return hasExcessWidth();
 188
 189     }
 190
 191     @Override
 192     public void doLayout()
 193     {
 194       if (hasExcessWidth())
 195       {
 196         autoResizeMode = AUTO_RESIZE_SUBSEQUENT_COLUMNS;
 197       }
 198       inLayout = true;
 199       super.doLayout();
 200       inLayout = false;
 201       autoResizeMode = AUTO_RESIZE_OFF;
 202     }
 203
 204     protected boolean hasExcessWidth()
 205     {
 206       return getPreferredSize().width < getParent().getWidth();
 207     }
 208
 209     @Override
 210     public void columnMarginChanged(ChangeEvent e)
 211     {
 212       if (isEditing())
 213       {
 214         removeEditor();
 215       }
 216       TableColumn resizingColumn = getTableHeader().getResizingColumn();
 217       // Need to do this here, before the parent's
 218       // layout manager calls getPreferredSize().
 219       if (resizingColumn != null && autoResizeMode == AUTO_RESIZE_OFF
 220               && !inLayout)
 221       {
 222         resizingColumn.setPreferredWidth(resizingColumn.getWidth());
 223         String colHeader = resizingColumn.getHeaderValue().toString();
 224         tempUserPrefs.put(colHeader, resizingColumn.getWidth());
 225       }
 226       resizeAndRepaint();
 227     }
 228
 229     @Override
 230     public String getToolTipText(MouseEvent evt)
 231     {
 232       String toolTipText = null;
 233       java.awt.Point pnt = evt.getPoint();
 234       int rowIndex = rowAtPoint(pnt);
 235       int colIndex = columnAtPoint(pnt);
 236
 237       try
 238       {
 239         if (getValueAt(rowIndex, colIndex) == null)
 240         {
 241           return null;
 242         }
 243         toolTipText = getValueAt(rowIndex, colIndex).toString();
 244       } catch (Exception e)
 245       {
 246         // e.printStackTrace();
 247       }
 248       toolTipText = (toolTipText == null ? null
 249               : (toolTipText.length() > 500
 250                       ? JvSwingUtils.wrapTooltip(true,
 251                               "\"" + toolTipText.subSequence(0, 500)
 252                                       + "...\"")
 253                       : JvSwingUtils.wrapTooltip(true, toolTipText)));
 254       return toolTipText;
 255     }
 256   };
 257
 258   public GStructureChooser()
 259   {
 260   }
 261
 262   protected void initDialog()
 263   {
 264
 265     try
 266     {
 267       jbInit();
 268       mainFrame.setVisible(false);
 269       mainFrame.invalidate();
 270       mainFrame.pack();
 271     } catch (Exception e)
 272     {
 273       System.out.println(e); // for JavaScript TypeError
 274       e.printStackTrace();
 275     }
 276   }
 277
 278   // BH SwingJS optimization
 279   // (a) 100-ms interruptable timer for text entry -- BH 1/10/2019
 280   // (b) two-character minimum, at least for JavaScript.
 281
 282   private Timer timer;
 283
 284   protected void txt_search_ActionPerformedDelayed()
 285   {
 286     if (timer != null)
 287     {
 288       timer.stop();
 289     }
 290     timer = new Timer(300, new ActionListener()
 291     {
 292
 293       @Override
 294       public void actionPerformed(ActionEvent e)
 295       {
 296         txt_search_ActionPerformed();
 297       }
 298     });
 299     timer.setRepeats(false);
 300     timer.start();
 301   }
 302   //
 303
 304   /**
 305    * Initializes the GUI default properties
 306    *
 307    * @throws Exception
 308    */
 309   private void jbInit() throws Exception
 310   {
 311     Integer width = tempUserPrefs.get("structureChooser.width") == null
 312             ? 800
 313             : tempUserPrefs.get("structureChooser.width");
 314     Integer height = tempUserPrefs.get("structureChooser.height") == null
 315             ? 400
 316             : tempUserPrefs.get("structureChooser.height");
 317     tbl_summary.setAutoCreateRowSorter(true);
 318     tbl_summary.getTableHeader().setReorderingAllowed(false);
 319     tbl_summary.addMouseListener(new MouseAdapter()
 320     {
 321       @Override
 322       public void mousePressed(MouseEvent e)
 323       {
 324         if (!popupAction(e))
 325         {
 326           super.mousePressed(e);
 327         }
 328       }
 329
 330       @Override
 331       public void mouseClicked(MouseEvent e)
 332       {
 333         if (!popupAction(e))
 334         {
 335           validateSelections();
 336         }
 337       }
 338
 339       @Override
 340       public void mouseReleased(MouseEvent e)
 341       {
 342         if (!popupAction(e))
 343         {
 344           validateSelections();
 345         }
 346       }
 347
 348       boolean popupAction(MouseEvent e)
 349       {
 350         if (e.isPopupTrigger())
 351         {
 352           Point pt = e.getPoint();
 353           int selectedRow = tbl_summary.rowAtPoint(pt);
 354           if (showPopupFor(selectedRow, pt.x, pt.y))
 355           {
 356             return true;
 357           }
 358         }
 359         return false;
 360       }
 361     });
 362     tbl_summary.addKeyListener(new KeyAdapter()
 363     {
 364       @Override
 365       public void keyPressed(KeyEvent evt)
 366       {
 367         validateSelections();
 368         switch (evt.getKeyCode())
 369         {
 370         case KeyEvent.VK_ESCAPE: // escape key
 371           mainFrame.dispose();
 372           break;
 373         case KeyEvent.VK_ENTER: // enter key
 374           if (btn_add.isEnabled())
 375           {
 376             add_ActionPerformed();
 377           }
 378           break;
 379         case KeyEvent.VK_TAB: // tab key
 380           if (evt.isShiftDown())
 381           {
 382             pnl_filter.requestFocus();
 383           }
 384           else
 385           {
 386             btn_add.requestFocus();
 387           }
 388           evt.consume();
 389           break;
 390         default:
 391           return;
 392         }
 393       }
 394     });
 395
 396     JButton btn_cancel = new JButton(
 397             MessageManager.getString("action.cancel"));
 398     btn_cancel.setFont(VERDANA_12);
 399     btn_cancel.addActionListener(new java.awt.event.ActionListener()
 400     {
 401       @Override
 402       public void actionPerformed(ActionEvent e)
 403       {
 404         closeAction(pnl_filter.getHeight());
 405       }
 406     });
 407     btn_cancel.addKeyListener(new KeyAdapter()
 408     {
 409       @Override
 410       public void keyPressed(KeyEvent evt)
 411       {
 412         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 413         {
 414           closeAction(pnl_filter.getHeight());
 415         }
 416       }
 417     });
 418
 419     tbl_local_pdb.setAutoCreateRowSorter(true);
 420     tbl_local_pdb.getTableHeader().setReorderingAllowed(false);
 421     tbl_local_pdb.addMouseListener(new MouseAdapter()
 422     {
 423       @Override
 424       public void mouseClicked(MouseEvent e)
 425       {
 426         validateSelections();
 427       }
 428
 429       @Override
 430       public void mouseReleased(MouseEvent e)
 431       {
 432         validateSelections();
 433       }
 434     });
 435     tbl_local_pdb.addKeyListener(new KeyAdapter()
 436     {
 437       @Override
 438       public void keyPressed(KeyEvent evt)
 439       {
 440         validateSelections();
 441         switch (evt.getKeyCode())
 442         {
 443         case KeyEvent.VK_ESCAPE: // escape key
 444           mainFrame.dispose();
 445           break;
 446         case KeyEvent.VK_ENTER: // enter key
 447           if (btn_add.isEnabled())
 448           {
 449             add_ActionPerformed();
 450           }
 451           break;
 452         case KeyEvent.VK_TAB: // tab key
 453           if (evt.isShiftDown())
 454           {
 455             cmb_filterOption.requestFocus();
 456           }
 457           else
 458           {
 459             if (btn_add.isEnabled())
 460             {
 461               btn_add.requestFocus();
 462             }
 463             else
 464             {
 465               btn_cancel.requestFocus();
 466             }
 467           }
 468           evt.consume();
 469           break;
 470         default:
 471           return;
 472         }
 473       }
 474     });
 475
 476     btn_newView = new JButton(
 477             MessageManager.formatMessage("action.new_structure_view_with",
 478                     StructureViewer.getViewerType().toString()));
 479     btn_newView.setFont(VERDANA_12);
 480     btn_newView.addActionListener(new java.awt.event.ActionListener()
 481     {
 482       @Override
 483       public void actionPerformed(ActionEvent e)
 484       {
 485         newView_ActionPerformed();
 486       }
 487     });
 488     btn_newView.addKeyListener(new KeyAdapter()
 489     {
 490       @Override
 491       public void keyPressed(KeyEvent evt)
 492       {
 493         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 494         {
 495           newView_ActionPerformed();
 496         }
 497       }
 498     });
 499
 500     // TODO: JAL-3898 - get list of available external programs to view
 501     // structures with
 502
 503     btn_add = new JButton(MessageManager.getString("action.add"));
 504     btn_add.setFont(VERDANA_12);
 505     btn_add.addActionListener(new java.awt.event.ActionListener()
 506     {
 507       @Override
 508       public void actionPerformed(ActionEvent e)
 509       {
 510         add_ActionPerformed();
 511       }
 512     });
 513     btn_add.addKeyListener(new KeyAdapter()
 514     {
 515       @Override
 516       public void keyPressed(KeyEvent evt)
 517       {
 518         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 519         {
 520           add_ActionPerformed();
 521         }
 522       }
 523     });
 524
 525     btn_pdbFromFile.setFont(VERDANA_12);
 526     String btn_title = MessageManager.getString("label.select_pdb_file");
 527     btn_pdbFromFile.setText(btn_title + "              ");
 528     btn_pdbFromFile.addActionListener(new java.awt.event.ActionListener()
 529     {
 530       @Override
 531       public void actionPerformed(ActionEvent e)
 532       {
 533         pdbFromFile_actionPerformed();
 534       }
 535     });
 536     btn_pdbFromFile.addKeyListener(new KeyAdapter()
 537     {
 538       @Override
 539       public void keyPressed(KeyEvent evt)
 540       {
 541         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 542         {
 543           pdbFromFile_actionPerformed();
 544         }
 545       }
 546     });
 547
 548     JScrollPane scrl_foundStructures = new JScrollPane(tbl_summary);
 549     scrl_foundStructures.setPreferredSize(new Dimension(width, height));
 550
 551     JScrollPane scrl_localPDB = new JScrollPane(tbl_local_pdb);
 552     scrl_localPDB.setPreferredSize(new Dimension(width, height));
 553     scrl_localPDB.setHorizontalScrollBarPolicy(
 554             JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
 555
 556     chk_invertFilter.setFont(VERDANA_12);
 557     txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
 558             MessageManager.getString("label.enter_pdb_id_tip")));
 559     txt_search.getDocument().addDocumentListener(new DocumentListener()
 560     {
 561       @Override
 562       public void insertUpdate(DocumentEvent e)
 563       {
 564         txt_search_ActionPerformedDelayed();
 565       }
 566
 567       @Override
 568       public void removeUpdate(DocumentEvent e)
 569       {
 570         txt_search_ActionPerformedDelayed();
 571       }
 572
 573       @Override
 574       public void changedUpdate(DocumentEvent e)
 575       {
 576         txt_search_ActionPerformedDelayed();
 577       }
 578     });
 579
 580     cmb_filterOption.setFont(VERDANA_12);
 581     cmb_filterOption.setToolTipText(
 582             MessageManager.getString("info.select_filter_option"));
 583     cmb_filterOption.addItemListener(this);
 584     // add CustomComboSeparatorsRenderer to filter option combo-box
 585     cmb_filterOption.setRenderer(new CustomComboSeparatorsRenderer(
 586             (ListCellRenderer<Object>) cmb_filterOption.getRenderer())
 587     {
 588       @Override
 589       protected boolean addSeparatorAfter(JList list, FilterOption value,
 590               int index)
 591       {
 592         return value.isAddSeparatorAfter();
 593       }
 594     });
 595
 596     chk_invertFilter.addItemListener(this);
 597     btn_queryTDB.setFont(VERDANA_12);
 598     // btn_queryTDB.setPreferredSize(new Dimension(200,22));
 599     btn_queryTDB
 600             .setText(MessageManager.getString("label.search_3dbeacons"));
 601     btn_queryTDB.setToolTipText(
 602             MessageManager.getString("label.find_models_from_3dbeacons"));
 603     btn_queryTDB.setIcon(tdbImage);
 604     btn_queryTDB.setVisible(false);
 605
 606     targetView.setVisible(false);
 607
 608     JPanel actionsPanel = new JPanel(new MigLayout());
 609     actionsPanel.add(targetView, "left");
 610     actionsPanel.add(btn_add, "wrap");
 611     actionsPanel.add(chk_superpose, "left");
 612     actionsPanel.add(btn_newView);
 613     actionsPanel.add(btn_cancel, "right");
 614
 615     JPanel pnl_main = new JPanel(new BorderLayout());
 616     JPanel pnl_controls = new JPanel();
 617     pnl_main.add(btn_queryTDB, BorderLayout.NORTH);
 618     pnl_controls.add(cmb_filterOption);
 619     pnl_controls.add(lbl_loading);
 620     pnl_controls.add(chk_invertFilter);
 621     pnl_main.add(pnl_controls, BorderLayout.CENTER);
 622     lbl_loading.setVisible(false);
 623
 624     JPanel pnl_fileChooser = new JPanel(new FlowLayout());
 625     pnl_fileChooser.add(btn_pdbFromFile);
 626     pnl_fileChooser.add(lbl_fromFileStatus);
 627     JPanel pnl_fileChooserBL = new JPanel(new BorderLayout());
 628     pnl_fileChooserBL.add(fileChooserAssSeqPanel, BorderLayout.NORTH);
 629     pnl_fileChooserBL.add(pnl_fileChooser, BorderLayout.CENTER);
 630
 631     JPanel pnl_idInput = new JPanel(new FlowLayout());
 632     pnl_idInput.add(txt_search);
 633     pnl_idInput.add(lbl_pdbManualFetchStatus);
 634
 635     JPanel pnl_idInputBL = new JPanel(new BorderLayout());
 636     pnl_idInputBL.add(idInputAssSeqPanel, BorderLayout.NORTH);
 637     pnl_idInputBL.add(pnl_idInput, BorderLayout.CENTER);
 638
 639     final String foundStructureSummary = MessageManager
 640             .getString("label.found_structures_summary");
 641     final String configureCols = MessageManager
 642             .getString("label.configure_displayed_columns");
 643     ChangeListener changeListener = new ChangeListener()
 644     {
 645       @Override
 646       public void stateChanged(ChangeEvent changeEvent)
 647       {
 648         JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
 649                 .getSource();
 650         int index = sourceTabbedPane.getSelectedIndex();
 651         btn_add.setVisible(targetView.isVisible());
 652         btn_newView.setVisible(true);
 653         btn_cancel.setVisible(true);
 654         if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
 655         {
 656           btn_add.setEnabled(false);
 657           btn_cancel.setEnabled(false);
 658           btn_add.setVisible(false);
 659           btn_newView.setEnabled(false);
 660           btn_cancel.setVisible(false);
 661           previousWantedFields = getFTSDocFieldPrefs()
 662                   .getStructureSummaryFields()
 663                   .toArray(new FTSDataColumnI[0]);
 664         }
 665         if (sourceTabbedPane.getTitleAt(index)
 666                 .equals(foundStructureSummary))
 667         {
 668           btn_cancel.setEnabled(true);
 669           if (wantedFieldsUpdated())
 670           {
 671             tabRefresh();
 672           }
 673           else
 674           {
 675             validateSelections();
 676           }
 677         }
 678       }
 679     };
 680     pnl_filter.addChangeListener(changeListener);
 681     pnl_filter.setPreferredSize(new Dimension(width, height));
 682     pnl_filter.add(foundStructureSummary, scrl_foundStructures);
 683     pnl_filter.add(configureCols, getFTSDocFieldPrefs());
 684
 685     JPanel pnl_locPDB = new JPanel(new BorderLayout());
 686     pnl_locPDB.add(scrl_localPDB);
 687
 688     pnl_switchableViews.add(pnl_fileChooserBL, VIEWS_FROM_FILE);
 689     pnl_switchableViews.add(pnl_idInputBL, VIEWS_ENTER_ID);
 690     pnl_switchableViews.add(pnl_filter, VIEWS_FILTER);
 691     pnl_switchableViews.add(pnl_locPDB, VIEWS_LOCAL_PDB);
 692
 693     this.setLayout(new BorderLayout());
 694     this.add(pnl_main, java.awt.BorderLayout.NORTH);
 695     this.add(pnl_switchableViews, java.awt.BorderLayout.CENTER);
 696     // this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
 697     statusPanel.setLayout(new GridLayout());
 698
 699     JPanel pnl_actionsAndStatus = new JPanel(new BorderLayout());
 700     pnl_actionsAndStatus.add(actionsPanel, BorderLayout.CENTER);
 701     pnl_actionsAndStatus.add(statusPanel, BorderLayout.SOUTH);
 702     statusPanel.add(statusBar, null);
 703     this.add(pnl_actionsAndStatus, java.awt.BorderLayout.SOUTH);
 704
 705     mainFrame.addInternalFrameListener(
 706             new javax.swing.event.InternalFrameAdapter()
 707             {
 708               @Override
 709               public void internalFrameClosing(InternalFrameEvent e)
 710               {
 711                 closeAction(pnl_filter.getHeight());
 712               }
 713             });
 714     mainFrame.setVisible(true);
 715     mainFrame.setContentPane(this);
 716     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
 717     Integer x = tempUserPrefs.get("structureChooser.x");
 718     Integer y = tempUserPrefs.get("structureChooser.y");
 719     if (x != null && y != null)
 720     {
 721       mainFrame.setLocation(x, y);
 722     }
 723     Desktop.addInternalFrame(mainFrame, frameTitle, width, height);
 724   }
 725
 726   protected abstract boolean showPopupFor(int selectedRow, int x, int y);
 727
 728   protected void closeAction(int preferredHeight)
 729   {
 730     // System.out.println(">>>>>>>>>> closing internal frame!!!");
 731     // System.out.println("width : " + mainFrame.getWidth());
 732     // System.out.println("heigh : " + mainFrame.getHeight());
 733     // System.out.println("x : " + mainFrame.getX());
 734     // System.out.println("y : " + mainFrame.getY());
 735     tempUserPrefs.put("structureChooser.width", pnl_filter.getWidth());
 736     tempUserPrefs.put("structureChooser.height", preferredHeight);
 737     tempUserPrefs.put("structureChooser.x", mainFrame.getX());
 738     tempUserPrefs.put("structureChooser.y", mainFrame.getY());
 739     mainFrame.dispose();
 740   }
 741
 742   public boolean wantedFieldsUpdated()
 743   {
 744     if (previousWantedFields == null)
 745     {
 746       return true;
 747     }
 748
 749     FTSDataColumnI[] currentWantedFields = getFTSDocFieldPrefs()
 750             .getStructureSummaryFields().toArray(new FTSDataColumnI[0]);
 751     return Arrays.equals(currentWantedFields, previousWantedFields) ? false
 752             : true;
 753
 754   }
 755
 756   @Override
 757   /**
 758    * Event listener for the 'filter' combo-box and 'invert' check-box
 759    */
 760   public void itemStateChanged(ItemEvent e)
 761   {
 762     stateChanged(e);
 763   }
 764
 765   /**
 766    * This inner class provides the provides the data model for associate
 767    * sequence combo-box - cmb_assSeq
 768    *
 769    * @author tcnofoegbu
 770    *
 771    */
 772   public class AssociateSeqOptions
 773   {
 774     private SequenceI sequence;
 775
 776     private String name;
 777
 778     public AssociateSeqOptions(SequenceI seq)
 779     {
 780       this.sequence = seq;
 781       this.name = (seq.getName().length() >= 23)
 782               ? seq.getName().substring(0, 23)
 783               : seq.getName();
 784     }
 785
 786     public AssociateSeqOptions(String name, SequenceI seq)
 787     {
 788       this.name = name;
 789       this.sequence = seq;
 790     }
 791
 792     @Override
 793     public String toString()
 794     {
 795       return name;
 796     }
 797
 798     public String getName()
 799     {
 800       return name;
 801     }
 802
 803     public void setName(String name)
 804     {
 805       this.name = name;
 806     }
 807
 808     public SequenceI getSequence()
 809     {
 810       return sequence;
 811     }
 812
 813     public void setSequence(SequenceI sequence)
 814     {
 815       this.sequence = sequence;
 816     }
 817
 818   }
 819
 820   /**
 821    * This inner class holds the Layout and configuration of the panel which
 822    * handles association of manually fetched structures to a unique sequence
 823    * when more than one sequence selection is made
 824    *
 825    * @author tcnofoegbu
 826    *
 827    */
 828   public class AssociateSeqPanel extends JPanel implements ItemListener
 829   {
 830     private JComboBox<AssociateSeqOptions> cmb_assSeq = new JComboBox<>();
 831
 832     private JLabel lbl_associateSeq = new JLabel();
 833
 834     public AssociateSeqPanel()
 835     {
 836       this.setLayout(new FlowLayout());
 837       this.add(cmb_assSeq);
 838       this.add(lbl_associateSeq);
 839       cmb_assSeq.setToolTipText(
 840               MessageManager.getString("info.associate_wit_sequence"));
 841       cmb_assSeq.addItemListener(this);
 842     }
 843
 844     public void loadCmbAssSeq()
 845     {
 846       populateCmbAssociateSeqOptions(cmb_assSeq, lbl_associateSeq);
 847     }
 848
 849     public JComboBox<AssociateSeqOptions> getCmb_assSeq()
 850     {
 851       return cmb_assSeq;
 852     }
 853
 854     public void setCmb_assSeq(JComboBox<AssociateSeqOptions> cmb_assSeq)
 855     {
 856       this.cmb_assSeq = cmb_assSeq;
 857     }
 858
 859     @Override
 860     public void itemStateChanged(ItemEvent e)
 861     {
 862       if (e.getStateChange() == ItemEvent.SELECTED)
 863       {
 864         cmbAssSeqStateChanged();
 865       }
 866     }
 867   }
 868
 869   public JTable getResultTable()
 870   {
 871     return tbl_summary;
 872   }
 873
 874   public JComboBox<FilterOption> getCmbFilterOption()
 875   {
 876     return cmb_filterOption;
 877   }
 878
 879   /**
 880    * Custom ListCellRenderer for adding a separator between different categories
 881    * of structure chooser filter option drop-down.
 882    *
 883    * @author tcnofoegbu
 884    *
 885    */
 886   public abstract class CustomComboSeparatorsRenderer
 887           implements ListCellRenderer<Object>
 888   {
 889     private ListCellRenderer<Object> regent;
 890
 891     private JPanel separatorPanel = new JPanel(new BorderLayout());
 892
 893     private JSeparator jSeparator = new JSeparator();
 894
 895     public CustomComboSeparatorsRenderer(
 896             ListCellRenderer<Object> listCellRenderer)
 897     {
 898       this.regent = listCellRenderer;
 899     }
 900
 901     @Override
 902     public Component getListCellRendererComponent(JList list, Object value,
 903             int index, boolean isSelected, boolean cellHasFocus)
 904     {
 905
 906       Component comp = regent.getListCellRendererComponent(list, value,
 907               index, isSelected, cellHasFocus);
 908       if (index != -1
 909               && addSeparatorAfter(list, (FilterOption) value, index))
 910       {
 911         separatorPanel.removeAll();
 912         separatorPanel.add(comp, BorderLayout.CENTER);
 913         separatorPanel.add(jSeparator, BorderLayout.SOUTH);
 914         return separatorPanel;
 915       }
 916       else
 917       {
 918         return comp;
 919       }
 920     }
 921
 922     protected abstract boolean addSeparatorAfter(JList list,
 923             FilterOption value, int index);
 924   }
 925
 926   protected abstract void stateChanged(ItemEvent e);
 927
 928   protected abstract void add_ActionPerformed();
 929
 930   protected abstract void newView_ActionPerformed();
 931
 932   protected abstract void pdbFromFile_actionPerformed();
 933
 934   protected abstract void txt_search_ActionPerformed();
 935
 936   protected abstract void populateCmbAssociateSeqOptions(
 937           JComboBox<AssociateSeqOptions> cmb_assSeq,
 938           JLabel lbl_associateSeq);
 939
 940   protected abstract void cmbAssSeqStateChanged();
 941
 942   protected abstract void tabRefresh();
 943
 944   protected abstract void validateSelections();
 945 }