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