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