JAL-3616 show name of structure viewer in ‘new view’ button
[jalview.git] / 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(
469             MessageManager.formatMessage("action.new_structure_view_with",
470                     StructureViewer.getViewerType().toString()));
471     btn_newView.setFont(VERDANA_12);
472     btn_newView.addActionListener(new java.awt.event.ActionListener()
473     {
474       @Override
475       public void actionPerformed(ActionEvent e)
476       {
477         newView_ActionPerformed();
478       }
479     });
480     btn_newView.addKeyListener(new KeyAdapter()
481     {
482       @Override
483       public void keyPressed(KeyEvent evt)
484       {
485         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
486         {
487           newView_ActionPerformed();
488         }
489       }
490     });
491     
492     // TODO: JAL-3898 - get list of available external programs to view structures with
493
494     btn_add = new JButton(MessageManager.getString("action.add"));
495     btn_add.setFont(VERDANA_12);
496     btn_add.addActionListener(new java.awt.event.ActionListener()
497     {
498       @Override
499       public void actionPerformed(ActionEvent e)
500       {
501         add_ActionPerformed();
502       }
503     });
504     btn_add.addKeyListener(new KeyAdapter()
505     {
506       @Override
507       public void keyPressed(KeyEvent evt)
508       {
509         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
510         {
511           add_ActionPerformed();
512         }
513       }
514     });
515
516     btn_pdbFromFile.setFont(VERDANA_12);
517     String btn_title = MessageManager.getString("label.select_pdb_file");
518     btn_pdbFromFile.setText(btn_title + "              ");
519     btn_pdbFromFile.addActionListener(new java.awt.event.ActionListener()
520     {
521       @Override
522       public void actionPerformed(ActionEvent e)
523       {
524         pdbFromFile_actionPerformed();
525       }
526     });
527     btn_pdbFromFile.addKeyListener(new KeyAdapter()
528     {
529       @Override
530       public void keyPressed(KeyEvent evt)
531       {
532         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
533         {
534           pdbFromFile_actionPerformed();
535         }
536       }
537     });
538
539     JScrollPane scrl_foundStructures = new JScrollPane(tbl_summary);
540     scrl_foundStructures.setPreferredSize(new Dimension(width, height));
541
542     JScrollPane scrl_localPDB = new JScrollPane(tbl_local_pdb);
543     scrl_localPDB.setPreferredSize(new Dimension(width, height));
544     scrl_localPDB.setHorizontalScrollBarPolicy(
545             JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
546
547     chk_invertFilter.setFont(VERDANA_12);
548     txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
549             MessageManager.getString("label.enter_pdb_id_tip")));
550     txt_search.getDocument().addDocumentListener(new DocumentListener()
551     {
552       @Override
553       public void insertUpdate(DocumentEvent e)
554       {
555         txt_search_ActionPerformedDelayed();
556       }
557
558       @Override
559       public void removeUpdate(DocumentEvent e)
560       {
561         txt_search_ActionPerformedDelayed();
562       }
563
564       @Override
565       public void changedUpdate(DocumentEvent e)
566       {
567         txt_search_ActionPerformedDelayed();
568       }
569     });
570
571     cmb_filterOption.setFont(VERDANA_12);
572     cmb_filterOption.setToolTipText(
573             MessageManager.getString("info.select_filter_option"));
574     cmb_filterOption.addItemListener(this);
575     // add CustomComboSeparatorsRenderer to filter option combo-box
576     cmb_filterOption.setRenderer(new CustomComboSeparatorsRenderer(
577             (ListCellRenderer<Object>) cmb_filterOption.getRenderer())
578     {
579       @Override
580       protected boolean addSeparatorAfter(JList list, FilterOption value,
581               int index)
582       {
583         return value.isAddSeparatorAfter();
584       }
585     });
586
587     chk_invertFilter.addItemListener(this);
588     btn_queryTDB.setFont(VERDANA_12);
589     //btn_queryTDB.setPreferredSize(new Dimension(200,22));
590     btn_queryTDB.setText(MessageManager.getString("label.search_3dbeacons"));
591     btn_queryTDB.setToolTipText(MessageManager.getString("label.find_models_from_3dbeacons"));
592     btn_queryTDB.setIcon(tdbImage);
593     btn_queryTDB.setVisible(false);
594
595     targetView.setVisible(false);
596
597     JPanel actionsPanel = new JPanel(new MigLayout());
598     actionsPanel.add(targetView, "left");
599     actionsPanel.add(btn_add, "wrap");
600     actionsPanel.add(chk_superpose, "left");
601     actionsPanel.add(btn_newView);
602     actionsPanel.add(btn_cancel, "right");
603
604     JPanel pnl_main = new JPanel(new BorderLayout());
605     JPanel pnl_controls = new JPanel();
606     pnl_main.add(btn_queryTDB,BorderLayout.NORTH);
607     pnl_controls.add(cmb_filterOption);
608     pnl_controls.add(lbl_loading);
609     pnl_controls.add(chk_invertFilter);
610     pnl_main.add(pnl_controls,BorderLayout.CENTER);
611     lbl_loading.setVisible(false);
612
613     JPanel pnl_fileChooser = new JPanel(new FlowLayout());
614     pnl_fileChooser.add(btn_pdbFromFile);
615     pnl_fileChooser.add(lbl_fromFileStatus);
616     JPanel pnl_fileChooserBL = new JPanel(new BorderLayout());
617     pnl_fileChooserBL.add(fileChooserAssSeqPanel, BorderLayout.NORTH);
618     pnl_fileChooserBL.add(pnl_fileChooser, BorderLayout.CENTER);
619
620     JPanel pnl_idInput = new JPanel(new FlowLayout());
621     pnl_idInput.add(txt_search);
622     pnl_idInput.add(lbl_pdbManualFetchStatus);
623
624     JPanel pnl_idInputBL = new JPanel(new BorderLayout());
625     pnl_idInputBL.add(idInputAssSeqPanel, BorderLayout.NORTH);
626     pnl_idInputBL.add(pnl_idInput, BorderLayout.CENTER);
627
628     final String foundStructureSummary = MessageManager
629             .getString("label.found_structures_summary");
630     final String configureCols = MessageManager
631             .getString("label.configure_displayed_columns");
632     ChangeListener changeListener = new ChangeListener()
633     {
634       @Override
635       public void stateChanged(ChangeEvent changeEvent)
636       {
637         JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
638                 .getSource();
639         int index = sourceTabbedPane.getSelectedIndex();
640         btn_add.setVisible(targetView.isVisible());
641         btn_newView.setVisible(true);
642         btn_cancel.setVisible(true);
643         if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
644         {
645           btn_add.setEnabled(false);
646           btn_cancel.setEnabled(false);
647           btn_add.setVisible(false);
648           btn_newView.setEnabled(false);
649           btn_cancel.setVisible(false);
650           previousWantedFields = getFTSDocFieldPrefs()
651                   .getStructureSummaryFields()
652                   .toArray(new FTSDataColumnI[0]);
653         }
654         if (sourceTabbedPane.getTitleAt(index)
655                 .equals(foundStructureSummary))
656         {
657           btn_cancel.setEnabled(true);
658           if (wantedFieldsUpdated())
659           {
660             tabRefresh();
661           }
662           else
663           {
664             validateSelections();
665           }
666         }
667       }
668     };
669     pnl_filter.addChangeListener(changeListener);
670     pnl_filter.setPreferredSize(new Dimension(width, height));
671     pnl_filter.add(foundStructureSummary, scrl_foundStructures);
672     pnl_filter.add(configureCols, getFTSDocFieldPrefs());
673
674     JPanel pnl_locPDB = new JPanel(new BorderLayout());
675     pnl_locPDB.add(scrl_localPDB);
676
677     pnl_switchableViews.add(pnl_fileChooserBL, VIEWS_FROM_FILE);
678     pnl_switchableViews.add(pnl_idInputBL, VIEWS_ENTER_ID);
679     pnl_switchableViews.add(pnl_filter, VIEWS_FILTER);
680     pnl_switchableViews.add(pnl_locPDB, VIEWS_LOCAL_PDB);
681
682     this.setLayout(new BorderLayout());
683     this.add(pnl_main, java.awt.BorderLayout.NORTH);
684     this.add(pnl_switchableViews, java.awt.BorderLayout.CENTER);
685     // this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
686     statusPanel.setLayout(new GridLayout());
687
688     JPanel pnl_actionsAndStatus = new JPanel(new BorderLayout());
689     pnl_actionsAndStatus.add(actionsPanel, BorderLayout.CENTER);
690     pnl_actionsAndStatus.add(statusPanel, BorderLayout.SOUTH);
691     statusPanel.add(statusBar, null);
692     this.add(pnl_actionsAndStatus, java.awt.BorderLayout.SOUTH);
693
694     mainFrame.addInternalFrameListener(
695             new javax.swing.event.InternalFrameAdapter()
696             {
697               @Override
698               public void internalFrameClosing(InternalFrameEvent e)
699               {
700                 closeAction(pnl_filter.getHeight());
701               }
702             });
703     mainFrame.setVisible(true);
704     mainFrame.setContentPane(this);
705     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
706     Integer x = tempUserPrefs.get("structureChooser.x");
707     Integer y = tempUserPrefs.get("structureChooser.y");
708     if (x != null && y != null)
709     {
710       mainFrame.setLocation(x, y);
711     }
712     Desktop.addInternalFrame(mainFrame, frameTitle, width, height);
713   }
714
715
716 protected abstract boolean showPopupFor(int selectedRow, int x, int y);
717 protected void closeAction(int preferredHeight)
718   {
719     // System.out.println(">>>>>>>>>> closing internal frame!!!");
720     // System.out.println("width : " + mainFrame.getWidth());
721     // System.out.println("heigh : " + mainFrame.getHeight());
722     // System.out.println("x : " + mainFrame.getX());
723     // System.out.println("y : " + mainFrame.getY());
724     tempUserPrefs.put("structureChooser.width", pnl_filter.getWidth());
725     tempUserPrefs.put("structureChooser.height", preferredHeight);
726     tempUserPrefs.put("structureChooser.x", mainFrame.getX());
727     tempUserPrefs.put("structureChooser.y", mainFrame.getY());
728     mainFrame.dispose();
729   }
730
731   public boolean wantedFieldsUpdated()
732   {
733     if (previousWantedFields == null)
734     {
735       return true;
736     }
737
738     FTSDataColumnI[] currentWantedFields = getFTSDocFieldPrefs()
739             .getStructureSummaryFields().toArray(new FTSDataColumnI[0]);
740     return Arrays.equals(currentWantedFields, previousWantedFields) ? false
741             : true;
742
743   }
744
745   @Override
746   /**
747    * Event listener for the 'filter' combo-box and 'invert' check-box
748    */
749   public void itemStateChanged(ItemEvent e)
750   {
751     stateChanged(e);
752   }
753
754   /**
755    * This inner class provides the provides the data model for associate
756    * sequence combo-box - cmb_assSeq
757    * 
758    * @author tcnofoegbu
759    *
760    */
761   public class AssociateSeqOptions
762   {
763     private SequenceI sequence;
764
765     private String name;
766
767     public AssociateSeqOptions(SequenceI seq)
768     {
769       this.sequence = seq;
770       this.name = (seq.getName().length() >= 23)
771               ? seq.getName().substring(0, 23)
772               : seq.getName();
773     }
774
775     public AssociateSeqOptions(String name, SequenceI seq)
776     {
777       this.name = name;
778       this.sequence = seq;
779     }
780
781     @Override
782     public String toString()
783     {
784       return name;
785     }
786
787     public String getName()
788     {
789       return name;
790     }
791
792     public void setName(String name)
793     {
794       this.name = name;
795     }
796
797     public SequenceI getSequence()
798     {
799       return sequence;
800     }
801
802     public void setSequence(SequenceI sequence)
803     {
804       this.sequence = sequence;
805     }
806
807   }
808
809   /**
810    * This inner class holds the Layout and configuration of the panel which
811    * handles association of manually fetched structures to a unique sequence
812    * when more than one sequence selection is made
813    * 
814    * @author tcnofoegbu
815    *
816    */
817   public class AssociateSeqPanel extends JPanel implements ItemListener
818   {
819     private JComboBox<AssociateSeqOptions> cmb_assSeq = new JComboBox<>();
820
821     private JLabel lbl_associateSeq = new JLabel();
822
823     public AssociateSeqPanel()
824     {
825       this.setLayout(new FlowLayout());
826       this.add(cmb_assSeq);
827       this.add(lbl_associateSeq);
828       cmb_assSeq.setToolTipText(
829               MessageManager.getString("info.associate_wit_sequence"));
830       cmb_assSeq.addItemListener(this);
831     }
832
833     public void loadCmbAssSeq()
834     {
835       populateCmbAssociateSeqOptions(cmb_assSeq, lbl_associateSeq);
836     }
837
838     public JComboBox<AssociateSeqOptions> getCmb_assSeq()
839     {
840       return cmb_assSeq;
841     }
842
843     public void setCmb_assSeq(JComboBox<AssociateSeqOptions> cmb_assSeq)
844     {
845       this.cmb_assSeq = cmb_assSeq;
846     }
847
848     @Override
849     public void itemStateChanged(ItemEvent e)
850     {
851       if (e.getStateChange() == ItemEvent.SELECTED)
852       {
853         cmbAssSeqStateChanged();
854       }
855     }
856   }
857
858   public JTable getResultTable()
859   {
860     return tbl_summary;
861   }
862
863   public JComboBox<FilterOption> getCmbFilterOption()
864   {
865     return cmb_filterOption;
866   }
867
868   /**
869    * Custom ListCellRenderer for adding a separator between different categories
870    * of structure chooser filter option drop-down.
871    * 
872    * @author tcnofoegbu
873    *
874    */
875   public abstract class CustomComboSeparatorsRenderer
876           implements ListCellRenderer<Object>
877   {
878     private ListCellRenderer<Object> regent;
879
880     private JPanel separatorPanel = new JPanel(new BorderLayout());
881
882     private JSeparator jSeparator = new JSeparator();
883
884     public CustomComboSeparatorsRenderer(
885             ListCellRenderer<Object> listCellRenderer)
886     {
887       this.regent = listCellRenderer;
888     }
889
890     @Override
891     public Component getListCellRendererComponent(JList list, Object value,
892             int index, boolean isSelected, boolean cellHasFocus)
893     {
894
895       Component comp = regent.getListCellRendererComponent(list, value,
896               index, isSelected, cellHasFocus);
897       if (index != -1
898               && addSeparatorAfter(list, (FilterOption) value, index))
899       {
900         separatorPanel.removeAll();
901         separatorPanel.add(comp, BorderLayout.CENTER);
902         separatorPanel.add(jSeparator, BorderLayout.SOUTH);
903         return separatorPanel;
904       }
905       else
906       {
907         return comp;
908       }
909     }
910
911     protected abstract boolean addSeparatorAfter(JList list,
912             FilterOption value, int index);
913   }
914
915   protected abstract void stateChanged(ItemEvent e);
916
917   protected abstract void add_ActionPerformed();
918
919   protected abstract void newView_ActionPerformed();
920
921   protected abstract void pdbFromFile_actionPerformed();
922
923   protected abstract void txt_search_ActionPerformed();
924
925   protected abstract void populateCmbAssociateSeqOptions(
926           JComboBox<AssociateSeqOptions> cmb_assSeq,
927           JLabel lbl_associateSeq);
928
929   protected abstract void cmbAssSeqStateChanged();
930
931   protected abstract void tabRefresh();
932
933   protected abstract void validateSelections();
934 }