JAL-2668 fix broken factory method for colour scheme
[jalview.git] / src / jalview / gui / WsJobParameters.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 package jalview.gui;
22
23 import jalview.gui.OptsAndParamsPage.OptionBox;
24 import jalview.gui.OptsAndParamsPage.ParamBox;
25 import jalview.util.MessageManager;
26 import jalview.ws.jws2.JabaParamStore;
27 import jalview.ws.jws2.JabaPreset;
28 import jalview.ws.jws2.Jws2Discoverer;
29 import jalview.ws.jws2.jabaws2.Jws2Instance;
30 import jalview.ws.params.ArgumentI;
31 import jalview.ws.params.OptionI;
32 import jalview.ws.params.ParamDatastoreI;
33 import jalview.ws.params.ParameterI;
34 import jalview.ws.params.WsParamSetI;
35
36 import java.awt.BorderLayout;
37 import java.awt.Component;
38 import java.awt.Dimension;
39 import java.awt.FlowLayout;
40 import java.awt.Font;
41 import java.awt.GridBagConstraints;
42 import java.awt.GridBagLayout;
43 import java.awt.GridLayout;
44 import java.awt.Rectangle;
45 import java.awt.event.ActionEvent;
46 import java.awt.event.ActionListener;
47 import java.awt.event.HierarchyBoundsListener;
48 import java.awt.event.HierarchyEvent;
49 import java.awt.event.ItemEvent;
50 import java.awt.event.ItemListener;
51 import java.awt.event.WindowEvent;
52 import java.awt.event.WindowListener;
53 import java.net.URL;
54 import java.util.Hashtable;
55 import java.util.Iterator;
56 import java.util.List;
57 import java.util.Vector;
58
59 import javax.swing.JButton;
60 import javax.swing.JComboBox;
61 import javax.swing.JDialog;
62 import javax.swing.JFrame;
63 import javax.swing.JLabel;
64 import javax.swing.JPanel;
65 import javax.swing.JScrollPane;
66 import javax.swing.JSplitPane;
67 import javax.swing.JTextArea;
68 import javax.swing.border.TitledBorder;
69 import javax.swing.event.DocumentEvent;
70 import javax.swing.event.DocumentListener;
71
72 import compbio.metadata.Argument;
73 import compbio.metadata.Option;
74 import compbio.metadata.Parameter;
75 import compbio.metadata.Preset;
76 import compbio.metadata.PresetManager;
77 import compbio.metadata.RunnerConfig;
78 import net.miginfocom.swing.MigLayout;
79
80 /**
81  * job parameter editing/browsing dialog box. User can browse existing settings
82  * (user + presets + Defaults), and any changes to parameters creates a modified
83  * user parameter set. LOGIC: If the parameter set is modified, and its name is
84  * a valid, non-existant user parameter set, then a save button is shown. If the
85  * parameter set is modified and its name is a valid, extant user parameter set,
86  * then an update button is shown. If user parameter set's name is edited, and
87  * old name exists as a writable user parameter set, then rename button is
88  * shown. If current parameter set is associated with a user defined parameter
89  * set, then : if set is modifed, a 'revert' button is shown. if set is not
90  * modified, a 'delete' button is shown.
91  * 
92  * @author JimP
93  * 
94  */
95 public class WsJobParameters extends JPanel implements ItemListener,
96         ActionListener, DocumentListener, OptsParametersContainerI
97 {
98   URL linkImageURL = getClass().getResource("/images/link.gif");
99
100   private static final String SVC_DEF = "Defaults"; // this is the null
101                                                     // parameter set as shown to
102                                                     // user
103
104   /**
105    * manager for options and parameters.
106    */
107   OptsAndParamsPage opanp = new OptsAndParamsPage(this);
108
109   /**
110    * panel containing job options
111    */
112   JPanel jobOptions = new JPanel();
113
114   /**
115    * panel containing job parameters
116    */
117   JPanel paramList = new JPanel();
118
119   JPanel SetNamePanel = new JPanel();
120
121   JPanel setDetails = new JPanel();
122
123   JSplitPane settingsPanel = new JSplitPane();
124
125   JPanel jobPanel = new JPanel();
126
127   JScrollPane jobOptionsPane = new JScrollPane();
128
129   JButton createpref = new JButton();
130
131   JButton deletepref = new JButton();
132
133   JButton revertpref = new JButton();
134
135   JButton updatepref = new JButton();
136
137   JButton startjob = new JButton();
138
139   JButton canceljob = new JButton();
140
141   JComboBox setName = new JComboBox();
142
143   JTextArea setDescr = new JTextArea();
144
145   JScrollPane paramPane = new JScrollPane();
146
147   // ScrollablePanel optsAndparams = new ScrollablePanel();
148   JPanel optsAndparams = new JPanel();
149
150   RunnerConfig serviceOptions;
151
152   ParamDatastoreI paramStore;
153
154   private int MAX_OPTWIDTH = 200;
155
156   WsJobParameters(Jws2Instance service)
157   {
158     this(service, null);
159   }
160
161   public WsJobParameters(JFrame parent, ParamDatastoreI store,
162           WsParamSetI preset,
163           List<ArgumentI> args)
164   {
165     super();
166     jbInit();
167     this.paramStore = store;
168     this.service = null;
169     // argSetModified(false);
170     // populate parameter table
171     init(preset, args);
172     // display in new JFrame attached to parent.
173     validate();
174   }
175
176   public WsJobParameters(Jws2Instance service, WsParamSetI preset)
177   {
178     this(null, service, preset, null);
179   }
180
181   /**
182    * 
183    * @param desktop
184    *          - if null, create new JFrame outside of desktop
185    * @param service
186    * @param preset
187    */
188   public WsJobParameters(JFrame parent, Jws2Instance service,
189           WsParamSetI preset, List<Argument> jobArgset)
190   {
191     this(parent, null, service, preset, jobArgset);
192   }
193
194   /**
195    * 
196    * @param parent
197    * @param paramStorei
198    * @param service
199    * @param preset
200    * @param jobArgset
201    */
202   public WsJobParameters(JFrame parent, ParamDatastoreI paramStorei,
203           Jws2Instance service, WsParamSetI preset,
204           List<Argument> jobArgset)
205   {
206     super();
207     jbInit();
208     this.paramStore = paramStorei;
209     if (paramStore == null)
210     {
211       paramStore = service.getParamStore();
212     }
213     this.service = service;
214     // argSetModified(false);
215     // populate parameter table
216     initForService(service, preset, jobArgset);
217     // display in new JFrame attached to parent.
218     validate();
219   }
220
221   int response = -1;
222
223   JDialog frame = null;
224
225   /**
226    * shows a modal dialog containing the parameters.
227    * 
228    * @return
229    */
230   public boolean showRunDialog()
231   {
232
233     frame = new JDialog(Desktop.instance, true);
234     if (service != null)
235     {
236       frame.setTitle(MessageManager.formatMessage("label.edit_params_for",
237               new String[]
238       { service.getActionText() }));
239     }
240
241     Rectangle deskr = Desktop.instance.getBounds();
242     Dimension pref = this.getPreferredSize();
243     frame.setBounds(
244             new Rectangle((int) (deskr.getCenterX() - pref.width / 2),
245                     (int) (deskr.getCenterY() - pref.height / 2),
246                     pref.width, pref.height));
247     frame.setContentPane(this);
248
249     // should perhaps recover defaults from user prefs.
250
251     frame.validate();
252     javax.swing.SwingUtilities.invokeLater(new Runnable()
253     {
254       @Override
255       public void run()
256       {
257         // jobPanel.setDividerLocation(0.25);
258
259       }
260     });
261     frame.setVisible(true);
262
263     if (response > 0)
264     {
265       return true;
266     }
267     return false;
268   }
269
270   private void jbInit()
271   {
272     this.addHierarchyBoundsListener(new HierarchyBoundsListener()
273     {
274
275       @Override
276       public void ancestorResized(HierarchyEvent arg0)
277       {
278         refreshParamLayout();
279       }
280
281       @Override
282       public void ancestorMoved(HierarchyEvent arg0)
283       {
284         // TODO Auto-generated method stub
285
286       }
287     });
288     updatepref = JvSwingUtils.makeButton(
289             MessageManager.getString("action.update"),
290             MessageManager.getString("label.update_user_parameter_set"),
291             new ActionListener()
292             {
293
294               @Override
295               public void actionPerformed(ActionEvent e)
296               {
297                 update_actionPerformed(e);
298               }
299             });
300     deletepref = JvSwingUtils.makeButton(
301             MessageManager.getString("action.delete"),
302             MessageManager.getString("label.delete_user_parameter_set"),
303             new ActionListener()
304             {
305
306               @Override
307               public void actionPerformed(ActionEvent e)
308               {
309                 delete_actionPerformed(e);
310               }
311             });
312     createpref = JvSwingUtils.makeButton(
313             MessageManager.getString("action.create"),
314             MessageManager.getString("label.create_user_parameter_set"),
315             new ActionListener()
316             {
317
318               @Override
319               public void actionPerformed(ActionEvent e)
320               {
321                 create_actionPerformed(e);
322               }
323             });
324     revertpref = JvSwingUtils.makeButton(
325             MessageManager.getString("action.revert"),
326             MessageManager
327                     .getString("label.revert_changes_user_parameter_set"),
328             new ActionListener()
329             {
330
331               @Override
332               public void actionPerformed(ActionEvent e)
333               {
334                 revert_actionPerformed(e);
335               }
336             });
337     startjob = JvSwingUtils.makeButton(
338             MessageManager.getString("action.start_job"),
339             MessageManager.getString("label.start_job_current_settings"),
340             new ActionListener()
341             {
342               @Override
343               public void actionPerformed(ActionEvent e)
344               {
345                 startjob_actionPerformed(e);
346               }
347             });
348     canceljob = JvSwingUtils.makeButton(
349             MessageManager.getString("action.cancel_job"),
350             MessageManager.getString("label.cancel_job_close_dialog"),
351             new ActionListener()
352             {
353               @Override
354               public void actionPerformed(ActionEvent e)
355               {
356                 canceljob_actionPerformed(e);
357               }
358             });
359
360     setDetails.setBorder(
361             new TitledBorder(MessageManager.getString("label.details")));
362     setDetails.setLayout(new BorderLayout());
363     setDescr.setColumns(40);
364     setDescr.setWrapStyleWord(true);
365     setDescr.setLineWrap(true);
366     setDescr.setBackground(getBackground());
367     setDescr.setEditable(true);
368     setDescr.getDocument().addDocumentListener(this);
369     setDescr.setToolTipText(
370             MessageManager.getString("label.edit_notes_parameter_set"));
371     JScrollPane setDescrView = new JScrollPane();
372     setDescrView.getViewport().setView(setDescr);
373     setName.setEditable(true);
374     setName.addItemListener(this);
375     setName.getEditor().addActionListener(this);
376     JPanel setNameInfo = new JPanel(new FlowLayout(FlowLayout.LEFT));
377     GridBagLayout gbl = new GridBagLayout();
378     SetNamePanel.setLayout(gbl);
379
380     JLabel setNameLabel = new JLabel(
381             MessageManager.getString("label.current_parameter_set_name"));
382     setNameLabel.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
383
384     setNameInfo.add(setNameLabel);
385     setNameInfo.add(setName);
386
387     // initial button visibility
388     updatepref.setVisible(false);
389     deletepref.setVisible(false);
390     revertpref.setVisible(false);
391     createpref.setVisible(false);
392     JPanel setsavebuts = new JPanel();
393     setsavebuts.setLayout(new FlowLayout(FlowLayout.LEFT)); // GridLayout(1,2));
394     ((FlowLayout) setsavebuts.getLayout()).setHgap(10);
395     ((FlowLayout) setsavebuts.getLayout()).setVgap(0);
396     JPanel spacer = new JPanel();
397     spacer.setPreferredSize(new Dimension(2, 30));
398     setsavebuts.add(spacer);
399     setsavebuts.add(deletepref);
400     setsavebuts.add(revertpref);
401     setsavebuts.add(createpref);
402     setsavebuts.add(updatepref);
403     // setsavebuts.setSize(new Dimension(150, 30));
404     JPanel buttonArea = new JPanel(new GridLayout(1, 1));
405     buttonArea.add(setsavebuts);
406     SetNamePanel.add(setNameInfo);
407     GridBagConstraints gbc = new GridBagConstraints();
408     gbc.gridheight = 2;
409     gbl.setConstraints(setNameInfo, gbc);
410     SetNamePanel.add(buttonArea);
411     gbc = new GridBagConstraints();
412     gbc.gridx = 0;
413     gbc.gridy = 2;
414     gbc.gridheight = 1;
415     gbl.setConstraints(buttonArea, gbc);
416     setDetails.add(setDescrView, BorderLayout.CENTER);
417
418     // paramPane.setPreferredSize(new Dimension(360, 400));
419     // paramPane.setPreferredSize(null);
420     jobOptions.setBorder(
421             new TitledBorder(MessageManager.getString("label.options")));
422     jobOptions.setOpaque(true);
423     paramList.setBorder(
424             new TitledBorder(MessageManager.getString("label.parameters")));
425     paramList.setOpaque(true);
426     JPanel bjo = new JPanel(new BorderLayout()),
427             bjp = new JPanel(new BorderLayout());
428     bjo.add(jobOptions, BorderLayout.CENTER);
429     bjp.add(paramList, BorderLayout.CENTER);
430     bjp.setOpaque(true);
431     bjo.setOpaque(true);
432     // optsAndparams.setScrollableWidth(ScrollableSizeHint.FIT);
433     // optsAndparams.setScrollableHeight(ScrollableSizeHint.NONE);
434     // optsAndparams.setLayout(new BorderLayout());
435     optsAndparams.setLayout(new BorderLayout());
436     optsAndparams.add(jobOptions, BorderLayout.NORTH);
437     optsAndparams.add(paramList, BorderLayout.CENTER);
438     JPanel jp = new JPanel(new BorderLayout());
439     jp.add(optsAndparams, BorderLayout.CENTER);
440     paramPane.getViewport().setView(jp);
441     paramPane.setBorder(null);
442     setLayout(new BorderLayout());
443     jobPanel.setPreferredSize(null);
444     jobPanel.setLayout(new BorderLayout());
445     jobPanel.add(setDetails, BorderLayout.NORTH);
446     jobPanel.add(paramPane, BorderLayout.CENTER);
447     // jobPanel.setOrientation(JSplitPane.VERTICAL_SPLIT);
448
449     add(SetNamePanel, BorderLayout.NORTH);
450     add(jobPanel, BorderLayout.CENTER);
451
452     JPanel dialogpanel = new JPanel();
453     dialogpanel.add(startjob);
454     dialogpanel.add(canceljob);
455     // JAL-1580: setMaximumSize() doesn't work, so just size for the worst case:
456     // check for null is for JUnit usage
457     final int windowHeight = Desktop.instance == null ? 540
458             : Desktop.instance.getHeight();
459     setPreferredSize(new Dimension(540, windowHeight));
460     add(dialogpanel, BorderLayout.SOUTH);
461     validate();
462   }
463
464   protected void revert_actionPerformed(ActionEvent e)
465   {
466     reInitDialog(lastParmSet);
467     updateWebServiceMenus();
468   }
469
470   protected void update_actionPerformed(ActionEvent e)
471   {
472     if (isUserPreset)
473     {
474       String curname = ((String) setName.getSelectedItem()).trim();
475       _updatePreset(lastParmSet, curname);
476       lastParmSet = curname;
477       isUserPreset = true;
478       initArgSetModified();
479       syncSetNamesWithStore();
480     }
481   }
482
483   private void _deleteUserPreset(String lastParmSet2)
484   {
485     paramStore.deletePreset(lastParmSet2);
486   }
487
488   protected void delete_actionPerformed(ActionEvent e)
489   {
490     if (isUserPreset)
491     {
492       // delete current preset's saved entry
493       _deleteUserPreset(lastParmSet);
494     }
495     reInitDialog(null); // service default
496     updateWebServiceMenus();
497   }
498
499   protected void create_actionPerformed(ActionEvent e)
500   {
501     String curname = ((String) setName.getSelectedItem()).trim();
502     if (curname.length() > 0)
503     {
504       _storeCurrentPreset(curname);
505       lastParmSet = curname;
506       isUserPreset = true;
507       reInitDialog(curname);
508       initArgSetModified();
509       updateWebServiceMenus();
510     }
511     else
512     {
513       // TODO: show warning
514       System.err.println("Invalid name. Not saved.");
515     }
516   }
517
518   protected void canceljob_actionPerformed(ActionEvent e)
519   {
520     response = 0;
521     if (frame != null)
522     {
523       frame.setVisible(false);
524     }
525   }
526
527   protected void startjob_actionPerformed(ActionEvent e)
528   {
529     response = 1;
530     if (frame != null)
531     {
532       frame.setVisible(false);
533     }
534   }
535
536   Jws2Instance service;
537
538   /**
539    * list of service presets in the gui
540    */
541   Hashtable servicePresets = null;
542
543   /**
544    * set if dialog is being set - so handlers will avoid spurious events
545    */
546   boolean settingDialog = false;
547
548   void initForService(Jws2Instance service, WsParamSetI jabap,
549           List<Argument> jabajobArgset)
550   {
551     WsParamSetI p = null;
552     List<ArgumentI> jobArgset = null;
553     settingDialog = true;
554     { // instantiate the abstract proxy for Jaba objects
555       jobArgset = jabajobArgset == null ? null
556               : JabaParamStore.getJwsArgsfromJaba(jabajobArgset);
557       p = jabap; // (jabap != null) ? paramStore.getPreset(jabap.getName()) :
558                  // null;
559     }
560
561     init(p, jobArgset);
562
563   }
564
565   void init(WsParamSetI p, List<ArgumentI> jobArgset)
566   {
567     Hashtable exnames = new Hashtable();
568     for (int i = 0, iSize = setName.getItemCount(); i < iSize; i++)
569     {
570       exnames.put(setName.getItemAt(i), setName.getItemAt(i));
571     }
572     servicePresets = new Hashtable();
573     // Add the default entry - if not present already.
574     if (!exnames.contains(SVC_DEF))
575     {
576       setName.addItem(SVC_DEF);
577       exnames.put(SVC_DEF, SVC_DEF);
578       servicePresets.put(SVC_DEF, SVC_DEF);
579     }
580     String curname = (p == null ? "" : p.getName());
581     for (WsParamSetI pr : paramStore.getPresets())
582     {
583       if (!pr.isModifiable())
584       {
585         servicePresets.put(pr.getName(), "preset");
586       }
587       else
588       {
589       }
590       if (!exnames.contains(pr.getName()))
591       {
592         setName.addItem(pr.getName());
593       }
594     }
595     // TODO: if initial jobArgset matches a given user setting or preset then
596     // should recover setting accordingly
597     // updateTable(p, jobArgset);
598     if (p != null)
599     {
600       reInitDialog(p.getName());
601       initArgSetModified();
602     }
603     else
604     {
605       if (jobArgset != null && jobArgset.size() > 0)
606       {
607         curSetName = "Supplied Settings";
608         isUserPreset = false;
609         updateTable(p, jobArgset);
610         setName.setSelectedItem(curSetName);
611         updateButtonDisplay();
612       }
613       else
614       {
615         curSetName = null;
616         reInitDialog(null);
617       }
618     }
619     settingDialog = false;
620   }
621
622   @SuppressWarnings("unchecked")
623   private void updateTable(WsParamSetI p, List<ArgumentI> jobArgset)
624   {
625     boolean setDefaultParams = false;
626     if (lastParmSet == null)
627     {
628       isUserPreset = false;
629       // First call - so provide Service default settings
630       setName.setSelectedItem(lastSetName = SVC_DEF);
631     }
632     if (p == null && SVC_DEF.equals("" + setName.getSelectedItem()))
633     {
634       // indicate that service defaults should be set if available
635       setDefaultParams = true;
636     }
637     // populate table from default parameter set.
638     List<ArgumentI> args = paramStore.getServiceParameters();
639
640     // split to params and required arguments
641     {
642       int cw = 0;
643       boolean optset = false;
644       for (ArgumentI myarg : args)
645       {
646         // Ideally, Argument would implement isRequired !
647         if (myarg instanceof ParameterI)
648         {
649           ParameterI parm = (ParameterI) myarg;
650           opanp.addParameter(parm).validate();
651         }
652         else
653         {
654           if (myarg instanceof OptionI)
655           {
656             OptionI opt = (OptionI) myarg;
657             OptionBox ob = opanp.addOption(opt);
658             ob.resetToDefault(setDefaultParams);
659             if (MAX_OPTWIDTH < ob.getPreferredSize().width)
660             {
661               MAX_OPTWIDTH = ob.getPreferredSize().width;
662             }
663             ob.validate();
664             cw += ob.getPreferredSize().width + 5;
665           }
666           else
667           {
668             System.err.println("Ignoring unknown service argument type "
669                     + myarg.getClass().getName());
670           }
671         }
672       }
673       args = null; // no more args to process.
674     }
675     if (p != null)
676     {
677       isUserPreset = false;
678       // initialise setname
679       setName.setSelectedItem(lastSetName = p.getName());
680       setDescr.setText(lastDescrText = p.getDescription());
681       // TODO - URL link
682       try
683       {
684         args = p.getArguments();
685       } catch (Exception e)
686       {
687         e.printStackTrace();
688       }
689       // TODO: check if args should be unselected prior to resetting using the
690       // preset
691     }
692
693     if (jobArgset != null)
694     {
695       argSetModified(jobArgset, true);
696       args = jobArgset;
697     }
698     // get setargs from current object
699     if (args != null)
700     {
701       for (ArgumentI arg : args)
702       {
703         if (arg instanceof ParameterI)
704         {
705           opanp.setParameter((ParameterI) arg);
706         }
707         else
708         {
709           if (arg instanceof OptionI)
710           {
711             // System.out.println("Setting option "
712             // + System.identityHashCode(arg) + ":" + arg.getName()
713             // + " with " + arg.getDefaultValue());
714             opanp.selectOption((OptionI) arg, arg.getValue());
715           }
716         }
717
718       }
719     }
720
721     refreshParamLayout();
722     revalidate();
723   }
724
725   private boolean isModified()
726   {
727     return modifiedElements.size() > 0;
728   }
729
730   private Hashtable modifiedElements = new Hashtable();
731
732   /**
733    * reset gui and modification state settings
734    */
735   private void initArgSetModified()
736   {
737     curSetName = null;
738     modifiedElements.clear();
739     updateButtonDisplay();
740   }
741
742   private void updateButtonDisplay()
743   {
744     boolean _update = false, _create = false, _delete = false,
745             _revert = false;
746     if (modifiedElements.size() > 0)
747     {
748       // set modified
749       _revert = true;
750       _update = isUserPreset; // can only update user presets
751       if (!isUserPreset || modifiedElements.containsKey(setName))
752       {
753         // name modified - can create new preset
754         _create = true;
755       }
756     }
757     else
758     {
759       // set unmodified
760     }
761     // can still delete a user preset
762     _delete = isUserPreset;
763
764     createpref.setVisible(_create);
765     updatepref.setVisible(_update);
766     deletepref.setVisible(_delete);
767     revertpref.setVisible(_revert);
768     validate();
769   }
770
771   @Override
772   public void argSetModified(Object modifiedElement, boolean b)
773   {
774     if (settingDialog)
775     {
776       return;
777     }
778     if (!b)
779     {
780       modifiedElements.remove(modifiedElement);
781     }
782     else
783     {
784       if (b && modifiedElement == setName
785               && modifiedElements.contains(modifiedElement))
786       {
787         // HACK! prevents iteration on makeSetNameValid
788         b = false;
789       }
790       modifiedElements.put(modifiedElement, modifiedElement);
791     }
792     // set mod status based on presence of elements in table
793     if (b && modifiedElements.size() > 0)
794     {
795       makeSetNameValid(!isUserPreset);
796       SetNamePanel.revalidate();
797     }
798     updateButtonDisplay();
799   }
800
801   private boolean isServicePreset(String selectedItem)
802   {
803     return selectedItem.equals(SVC_DEF)
804             || servicePresets.containsKey(selectedItem);
805   }
806
807   /**
808    * check if the current set name is a valid set name for saving, if not, then
809    * fix it.
810    */
811   private void makeSetNameValid(boolean newuserset)
812   {
813     boolean stn = settingDialog;
814     boolean renamed = false;
815     settingDialog = true;
816     String nm = (curSetName != null ? curSetName
817             : (String) setName.getSelectedItem());
818     // check if the name is reserved - if it is, rename it.
819     if (isServicePreset(nm))
820     {
821       nm = "User " + nm;
822       renamed = true;
823     }
824     String tnm = nm;
825     if (newuserset)
826     {
827       int i = 0;
828       while (paramStore.getPreset(tnm) != null)
829       {
830         tnm = nm + " (" + (++i) + ")";
831         renamed = true;
832       }
833       if (i > 0)
834       {
835         nm = tnm;
836       }
837     }
838
839     boolean makeupdate = false;
840     // sync the gui with the preset database
841     for (int i = 0, iS = setName.getItemCount(); i < iS; i++)
842     {
843       String snm = (String) setName.getItemAt(i);
844       if (snm.equals(nm))
845       {
846         makeupdate = true;
847         // setName.setSelectedIndex(i);
848       }
849     }
850     if (!makeupdate)
851     {
852       setName.addItem(curSetName = nm);
853       setName.setSelectedItem(curSetName);
854     }
855     if (renamed)
856     {
857       settingDialog = false; // we need this name change to be registered.
858       argSetModified(setName, renamed);
859     }
860     settingDialog = stn;
861   }
862
863   @Override
864   public void refreshParamLayout()
865   {
866     // optsAndparams.setPreferredSize(null);
867     FlowLayout fl = new FlowLayout(FlowLayout.LEFT);
868     int sep = fl.getVgap();
869     boolean fh = true;
870     int os = 0,
871             s = jobOptions.getBorder().getBorderInsets(jobOptions).bottom
872                     + jobOptions.getBorder().getBorderInsets(jobOptions).top
873                     + 2 * sep;
874     /**
875      * final height for viewport
876      */
877     int finalh = s;
878     int panewidth = paramPane.getViewport().getSize().width - 120
879             - jobOptions.getBorder().getBorderInsets(jobOptions).left
880             + jobOptions.getBorder().getBorderInsets(jobOptions).right;
881
882     int w = 2 * fl.getHgap()
883             + (MAX_OPTWIDTH > OptsAndParamsPage.PARAM_WIDTH ? MAX_OPTWIDTH
884                     : OptsAndParamsPage.PARAM_WIDTH);
885     int hgap = fl.getHgap(), cw = hgap;
886
887     if (opanp.getOptSet().size() > 0)
888     {
889
890       jobOptions.setLayout(new MigLayout("", "", ""));
891       jobOptions.removeAll();
892
893       for (OptionBox pbox : opanp.getOptSet().values())
894       {
895         pbox.validate();
896         cw += pbox.getSize().width + hgap;
897         if (cw + 120 > panewidth)
898         {
899           jobOptions.add(pbox, "wrap");
900           // System.out.println("Wrap on "+pbox.option.getName());
901           cw = hgap + pbox.getSize().width;
902           fh = true;
903         }
904         else
905         {
906           jobOptions.add(pbox);
907         }
908         if (fh)
909         {
910           finalh += pbox.getSize().height + fl.getVgap();
911           fh = false;
912         }
913       }
914       jobOptions.revalidate();
915     }
916     else
917     {
918       jobOptions.setVisible(false);
919     }
920
921     // Now layout the parameters assuming they occupy one column - to calculate
922     // total height of options+parameters
923     fl = new FlowLayout(FlowLayout.LEFT);
924     // helpful hint from
925     // http://stackoverflow.com/questions/2743177/top-alignment-for-flowlayout
926     fl.setAlignOnBaseline(true);
927     if (opanp.getParamSet().size() > 0)
928     {
929       paramList.removeAll();
930       paramList.setLayout(new MigLayout("", "", ""));
931       fh = true;
932       for (ParamBox pbox : opanp.getParamSet().values())
933       {
934         pbox.validate();
935         cw += pbox.getSize().width + hgap;
936         if (cw + 160 > panewidth)
937         {
938           paramList.add(pbox, "wrap");
939           cw = pbox.getSize().width + hgap;
940           fh = true;
941         }
942         else
943         {
944           paramList.add(pbox);
945         }
946         if (fh)
947         {
948           finalh += pbox.getSize().height + fl.getVgap();
949           fh = false;
950         }
951
952       }
953       /*
954        * s = 2 * sep; for (ParamBox pbox : opanp.getParamSet().values()) {
955        * pbox.validate(); s += sep +
956        * pbox.getPreferredSize().height+pbox.getBorder
957        * ().getBorderInsets(pbox).bottom; }
958        * 
959        * // paramList.setPreferredSize(new Dimension(w, s));
960        * os+=s+2*sep+paramList
961        * .getBorder().getBorderInsets(paramList).bottom+paramList
962        * .getBorder().getBorderInsets(paramList).top;
963        */
964       paramList.revalidate();
965     }
966     else
967     {
968       paramList.setVisible(false);
969     }
970     // TODO: waste some time trying to eliminate any unnecessary .validate calls
971     // here
972     // System.out.println("Size will be : "+w+","+os);
973     // optsAndparams.setPreferredSize(null);
974     // paramPane.getViewport().setView(optsAndparams);
975     paramPane.getViewport().setAutoscrolls(true);
976     paramPane.revalidate();
977     revalidate();
978   }
979
980   /**
981    * testing method - grab a service and parameter set and show the window
982    * 
983    * @param args
984    */
985   public static void main(String[] args)
986   {
987     jalview.ws.jws2.Jws2Discoverer disc = jalview.ws.jws2.Jws2Discoverer
988             .getDiscoverer();
989     int p = 0;
990     if (args.length > 0)
991     {
992       Vector<String> services = new Vector<>();
993       services.addElement(args[p++]);
994       Jws2Discoverer.getDiscoverer().setServiceUrls(services);
995     }
996     try
997     {
998       disc.run();
999     } catch (Exception e)
1000     {
1001       System.err.println("Aborting. Problem discovering services.");
1002       e.printStackTrace();
1003       return;
1004     }
1005     Jws2Instance lastserv = null;
1006     for (Jws2Instance service : disc.getServices())
1007     {
1008       lastserv = service;
1009       if (p >= args.length || service.serviceType.equalsIgnoreCase(args[p]))
1010       {
1011         if (lastserv != null)
1012         {
1013           List<Preset> prl = null;
1014           Preset pr = null;
1015           if (++p < args.length)
1016           {
1017             PresetManager prman = lastserv.getPresets();
1018             if (prman != null)
1019             {
1020               pr = prman.getPresetByName(args[p]);
1021               if (pr == null)
1022               {
1023                 // just grab the last preset.
1024                 prl = prman.getPresets();
1025               }
1026             }
1027           }
1028           else
1029           {
1030             PresetManager prman = lastserv.getPresets();
1031             if (prman != null)
1032             {
1033               prl = prman.getPresets();
1034             }
1035           }
1036           Iterator<Preset> en = (prl == null) ? null : prl.iterator();
1037           while (en != null && en.hasNext())
1038           {
1039             if (en != null)
1040             {
1041               if (!en.hasNext())
1042               {
1043                 en = prl.iterator();
1044               }
1045               pr = en.next();
1046             }
1047             {
1048               System.out.println("Testing opts dupes for "
1049                       + lastserv.getUri() + " : " + lastserv.getActionText()
1050                       + ":" + pr.getName());
1051               List<Option> rg = lastserv.getRunnerConfig().getOptions();
1052               for (Option o : rg)
1053               {
1054                 try
1055                 {
1056                   Option cpy = jalview.ws.jws2.ParameterUtils.copyOption(o);
1057                 } catch (Exception e)
1058                 {
1059                   System.err.println("Failed to copy " + o.getName());
1060                   e.printStackTrace();
1061                 } catch (Error e)
1062                 {
1063                   System.err.println("Failed to copy " + o.getName());
1064                   e.printStackTrace();
1065                 }
1066               }
1067             }
1068             {
1069               System.out.println("Testing param dupes:");
1070               List<Parameter> rg = lastserv.getRunnerConfig()
1071                       .getParameters();
1072               for (Parameter o : rg)
1073               {
1074                 try
1075                 {
1076                   Parameter cpy = jalview.ws.jws2.ParameterUtils
1077                           .copyParameter(o);
1078                 } catch (Exception e)
1079                 {
1080                   System.err.println("Failed to copy " + o.getName());
1081                   e.printStackTrace();
1082                 } catch (Error e)
1083                 {
1084                   System.err.println("Failed to copy " + o.getName());
1085                   e.printStackTrace();
1086                 }
1087               }
1088             }
1089             {
1090               System.out.println("Testing param write:");
1091               List<String> writeparam = null, readparam = null;
1092               try
1093               {
1094                 writeparam = jalview.ws.jws2.ParameterUtils
1095                         .writeParameterSet(
1096                                 pr.getArguments(lastserv.getRunnerConfig()),
1097                                 " ");
1098                 System.out.println("Testing param read :");
1099                 List<Option> pset = jalview.ws.jws2.ParameterUtils
1100                         .processParameters(writeparam,
1101                                 lastserv.getRunnerConfig(), " ");
1102                 readparam = jalview.ws.jws2.ParameterUtils
1103                         .writeParameterSet(pset, " ");
1104                 Iterator<String> o = pr.getOptions().iterator(),
1105                         s = writeparam.iterator(), t = readparam.iterator();
1106                 boolean failed = false;
1107                 while (s.hasNext() && t.hasNext())
1108                 {
1109                   String on = o.next(), sn = s.next(), st = t.next();
1110                   if (!sn.equals(st))
1111                   {
1112                     System.out.println(
1113                             "Original was " + on + " Phase 1 wrote " + sn
1114                                     + "\tPhase 2 wrote " + st);
1115                     failed = true;
1116                   }
1117                 }
1118                 if (failed)
1119                 {
1120                   System.out.println(
1121                           "Original parameters:\n" + pr.getOptions());
1122                   System.out.println(
1123                           "Wrote parameters in first set:\n" + writeparam);
1124                   System.out.println(
1125                           "Wrote parameters in second set:\n" + readparam);
1126
1127                 }
1128               } catch (Exception e)
1129               {
1130                 e.printStackTrace();
1131               }
1132             }
1133             WsJobParameters pgui = new WsJobParameters(lastserv,
1134                     new JabaPreset(lastserv, pr));
1135             JFrame jf = new JFrame(MessageManager
1136                     .formatMessage("label.ws_parameters_for", new String[]
1137                     { lastserv.getActionText() }));
1138             JPanel cont = new JPanel(new BorderLayout());
1139             pgui.validate();
1140             cont.setPreferredSize(pgui.getPreferredSize());
1141             cont.add(pgui, BorderLayout.CENTER);
1142             jf.setLayout(new BorderLayout());
1143             jf.add(cont, BorderLayout.CENTER);
1144             jf.validate();
1145             final Thread thr = Thread.currentThread();
1146             jf.addWindowListener(new WindowListener()
1147             {
1148
1149               @Override
1150               public void windowActivated(WindowEvent e)
1151               {
1152                 // TODO Auto-generated method stub
1153
1154               }
1155
1156               @Override
1157               public void windowClosed(WindowEvent e)
1158               {
1159               }
1160
1161               @Override
1162               public void windowClosing(WindowEvent e)
1163               {
1164                 thr.interrupt();
1165
1166               }
1167
1168               @Override
1169               public void windowDeactivated(WindowEvent e)
1170               {
1171                 // TODO Auto-generated method stub
1172
1173               }
1174
1175               @Override
1176               public void windowDeiconified(WindowEvent e)
1177               {
1178                 // TODO Auto-generated method stub
1179
1180               }
1181
1182               @Override
1183               public void windowIconified(WindowEvent e)
1184               {
1185                 // TODO Auto-generated method stub
1186
1187               }
1188
1189               @Override
1190               public void windowOpened(WindowEvent e)
1191               {
1192                 // TODO Auto-generated method stub
1193
1194               }
1195
1196             });
1197             jf.setVisible(true);
1198             boolean inter = false;
1199             while (!inter)
1200             {
1201               try
1202               {
1203                 Thread.sleep(10000);
1204               } catch (Exception e)
1205               {
1206                 inter = true;
1207               }
1208               ;
1209             }
1210             jf.dispose();
1211           }
1212         }
1213       }
1214     }
1215   }
1216
1217   public boolean isServiceDefaults()
1218   {
1219     return (!isModified()
1220             && (lastParmSet != null && lastParmSet.equals(SVC_DEF)));
1221   }
1222
1223   public List<ArgumentI> getJobParams()
1224   {
1225     return opanp.getCurrentSettings();
1226   }
1227
1228   String lastParmSet = null;
1229
1230   /*
1231    * Hashtable<String, Object[]> editedParams = new Hashtable<String,
1232    * Object[]>();
1233    * 
1234    * store the given parameters in the user parameter set database.
1235    * 
1236    * @param storeSetName - lastParmSet
1237    * 
1238    * @param descr - setDescr.getText()
1239    * 
1240    * @param jobParams - getJobParams()
1241    * 
1242    * private void _storeUserPreset(String storeSetName, String descr,
1243    * List<ArgumentI> jobParams) { // this is a simple hash store. Object[] pset;
1244    * editedParams.put(storeSetName, pset = new Object[3]); pset[0] =
1245    * storeSetName; pset[1] = descr; pset[2] = jobParams; // writeParam("Saving "
1246    * + storeSetName + ": ", jobParams); }
1247    * 
1248    * private void writeParam(String nm, List<ArgumentI> params) { for (ArgumentI
1249    * p : params) { System.out.println(nm + ":" + System.identityHashCode(p) +
1250    * " Name: " + p.getName() + " Value: " + p.getDefaultValue()); } }
1251    * 
1252    * private Object[] _getUserPreset(String setName) { Object[] pset =
1253    * editedParams.get(setName); // if (pset != null) // writeParam("Retrieving "
1254    * + setName + ": ", (List<Argument>) pset[2]); return pset; }
1255    * 
1256    * * remove the given user preset from the preset stash
1257    * 
1258    * @param setName
1259    * 
1260    * private void _deleteUserPreset(String setName) {
1261    * editedParams.remove(setName); }
1262    */
1263
1264   private void syncSetNamesWithStore()
1265   {
1266     int n = 0;
1267     // remove any set names in the drop down menu that aren't either a reserved
1268     // setting, or a user defined or service preset.
1269     Vector items = new Vector();
1270     while (n < setName.getItemCount())
1271     {
1272       String item = (String) setName.getItemAt(n);
1273       if (!item.equals(SVC_DEF) && !paramStore.presetExists(item))
1274       {
1275         setName.removeItemAt(n);
1276       }
1277       else
1278       {
1279         items.addElement(item);
1280         n++;
1281       }
1282     }
1283     if (!items.contains(SVC_DEF))
1284     {
1285       setName.addItem(SVC_DEF);
1286     }
1287     for (WsParamSetI upn : paramStore.getPresets())
1288     {
1289       if (!items.contains(upn.getName()))
1290       {
1291         setName.addItem(upn.getName());
1292       }
1293     }
1294   }
1295
1296   /**
1297    * true if lastParmSet is a user preset
1298    */
1299   boolean isUserPreset = false;
1300
1301   private void reInitDialog(String nextPreset)
1302   {
1303     settingDialog = true;
1304     // updateTable(null,null); // first reset to defaults
1305     WsParamSetI pset = null;
1306     if (nextPreset != null && nextPreset.length() > 0)
1307     {
1308       pset = paramStore.getPreset(nextPreset);
1309     }
1310     if (pset != null)
1311     {
1312       if (pset.isModifiable())
1313       {
1314         isUserPreset = true;
1315         setDescr.setText(pset.getDescription());
1316         updateTable(null, pset.getArguments());
1317         lastParmSet = nextPreset;
1318       }
1319       else
1320       {
1321         isUserPreset = false;
1322         setDescr.setText("");
1323         // must be a default preset from service
1324         updateTable(pset, null);
1325         lastParmSet = nextPreset;
1326       }
1327     }
1328     else
1329     {
1330       isUserPreset = false;
1331       // Service defaults
1332       setDescr.setText("");
1333       updateTable(null, null);
1334       lastParmSet = SVC_DEF;
1335     }
1336
1337     initArgSetModified();
1338     syncSetNamesWithStore();
1339     setName.setSelectedItem(lastParmSet);
1340     SetNamePanel.validate();
1341     validate();
1342     settingDialog = false;
1343   }
1344
1345   /**
1346    * Rebuild the AlignFrame web service menus (after add/delete of a preset
1347    * option).
1348    */
1349   protected void updateWebServiceMenus()
1350   {
1351     for (AlignFrame alignFrame : Desktop.getAlignFrames())
1352     {
1353       alignFrame.BuildWebServiceMenu();
1354     }
1355   }
1356
1357   String curSetName = null;
1358
1359   @Override
1360   public void itemStateChanged(ItemEvent e)
1361   {
1362     if (e.getSource() == setName && e.getStateChange() == e.SELECTED)
1363     {
1364       final String setname = (String) setName.getSelectedItem();
1365       // System.out.println("Item state changed for " + setname
1366       // + " (handling ? " + !settingDialog + ")");
1367       if (settingDialog)
1368       {
1369         // ignore event
1370         return;
1371       }
1372       if (setname == null)
1373       {
1374         return;
1375       }
1376       javax.swing.SwingUtilities.invokeLater(new Runnable()
1377       {
1378         @Override
1379         public void run()
1380         {
1381           doPreferenceComboStateChange(setname);
1382         }
1383       });
1384     }
1385   }
1386
1387   private void doPreferenceComboStateChange(String setname)
1388   {
1389     // user has selected a different item from combo-box
1390     if (isModified())
1391     {
1392       String lsetname = (curSetName != null) ? curSetName : lastParmSet;
1393       if (lsetname.equals(setname))
1394       {
1395         // setname was just edited - so ignore this event.
1396         return;
1397       }
1398       settingDialog = true;
1399       System.out.println("Prompting to save " + lsetname);
1400       if (JvOptionPane.showConfirmDialog(this, "Parameter set '" + lsetname
1401               + "' is modifed, and your changes will be lost.\nReally change preset ?",
1402               "Warning: Unsaved Changes",
1403               JvOptionPane.OK_CANCEL_OPTION) != JvOptionPane.OK_OPTION)
1404       {
1405         // revert the combobox to the current item
1406         settingDialog = true;
1407         setName.setSelectedItem(lsetname);
1408         settingDialog = false;
1409         // and leave.
1410         return;
1411         // System.out.println("Saving for " + lsetname);
1412         // _storeCurrentPreset(lsetname);
1413
1414       }
1415     }
1416     settingDialog = true;
1417     reInitDialog(setname);
1418     settingDialog = false;
1419
1420   }
1421
1422   private void _renameExistingPreset(String oldName, String curSetName2)
1423   {
1424     paramStore.updatePreset(oldName, curSetName2, setDescr.getText(),
1425             getJobParams());
1426   }
1427
1428   /**
1429    * store current settings as given name. You should then reset gui.
1430    * 
1431    * @param curSetName2
1432    */
1433   private void _storeCurrentPreset(String curSetName2)
1434   {
1435     paramStore.storePreset(curSetName2, setDescr.getText(), getJobParams());
1436   }
1437
1438   private void _updatePreset(String lastParmSet2, String curname)
1439   {
1440     paramStore.updatePreset(lastParmSet2, curname, setDescr.getText(),
1441             getJobParams());
1442
1443   }
1444
1445   /**
1446    * last saved name for this user preset
1447    */
1448   String lastSetName = null;
1449
1450   /**
1451    * last saved value of the description text for this user preset
1452    */
1453   String lastDescrText = null;
1454
1455   @Override
1456   public void actionPerformed(ActionEvent e)
1457   {
1458     if (e.getSource() instanceof Component)
1459     {
1460       Component src = (Component) e.getSource();
1461       if (src.getParent() == setName)
1462       {
1463         // rename any existing records we know about for this set.
1464         String newname = e.getActionCommand().trim();
1465         String msg = null;
1466         if (isServicePreset(newname))
1467         {
1468           final String oldname = curSetName != null ? curSetName
1469                   : lastParmSet;
1470           final Component ourframe = this;
1471           settingDialog = true;
1472           setName.getEditor().setItem(oldname);
1473           settingDialog = false;
1474           javax.swing.SwingUtilities.invokeLater(new Runnable()
1475           {
1476             @Override
1477             public void run()
1478             {
1479               JvOptionPane.showMessageDialog(ourframe,
1480                       MessageManager.getString(
1481                               "label.invalid_name_preset_exists"),
1482                       MessageManager.getString("label.invalid_name"),
1483                       JvOptionPane.WARNING_MESSAGE);
1484             }
1485           });
1486
1487           return;
1488         }
1489         curSetName = newname;
1490         System.err.println("New name for user setting " + curSetName
1491                 + " (was " + setName.getSelectedItem() + ")");
1492         if (curSetName.equals(setName.getSelectedItem()))
1493         {
1494           curSetName = null;
1495         }
1496         if (curSetName != null)
1497         {
1498           argSetModified(setName, true);
1499           return;
1500         }
1501
1502       }
1503     }
1504   }
1505
1506   private void checkDescrModified()
1507   {
1508     if (!settingDialog)
1509     {
1510
1511       argSetModified(setDescr,
1512               (lastDescrText == null
1513                       ? setDescr.getText().trim().length() > 0
1514                       : !setDescr.getText().equals(lastDescrText)));
1515
1516     }
1517   }
1518
1519   @Override
1520   public void insertUpdate(DocumentEvent e)
1521   {
1522     checkDescrModified();
1523   }
1524
1525   @Override
1526   public void removeUpdate(DocumentEvent e)
1527   {
1528     checkDescrModified();
1529   }
1530
1531   @Override
1532   public void changedUpdate(DocumentEvent e)
1533   {
1534     checkDescrModified();
1535   }
1536
1537   /**
1538    * 
1539    * @return null or the service preset selected by the user
1540    */
1541   public WsParamSetI getPreset()
1542   {
1543     if (isUserPreset || isModified()
1544             || (lastParmSet != null && lastParmSet.equals(SVC_DEF)))
1545     {
1546       return null;
1547     }
1548     else
1549     {
1550       return paramStore.getPreset(lastParmSet);
1551     }
1552   }
1553 }