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