3 import java.awt.BorderLayout;
5 import java.awt.Component;
6 import java.awt.Dimension;
7 import java.awt.FlowLayout;
9 import java.awt.GridLayout;
10 import java.awt.Rectangle;
11 import java.awt.event.ActionEvent;
12 import java.awt.event.ActionListener;
13 import java.awt.event.ComponentEvent;
14 import java.awt.event.ComponentListener;
15 import java.awt.event.ContainerEvent;
16 import java.awt.event.ContainerListener;
17 import java.awt.event.ItemEvent;
18 import java.awt.event.ItemListener;
19 import java.awt.event.KeyEvent;
20 import java.awt.event.KeyListener;
21 import java.awt.event.MouseEvent;
22 import java.awt.event.MouseListener;
23 import java.awt.event.WindowEvent;
24 import java.awt.event.WindowListener;
25 import java.awt.event.WindowStateListener;
27 import java.util.ArrayList;
28 import java.util.EventObject;
29 import java.util.HashSet;
30 import java.util.Hashtable;
31 import java.util.Iterator;
32 import java.util.List;
34 import java.util.Vector;
36 import javax.swing.InputVerifier;
37 import javax.swing.JButton;
38 import javax.swing.JCheckBox;
39 import javax.swing.JComboBox;
40 import javax.swing.JComponent;
41 import javax.swing.JDialog;
42 import javax.swing.JFrame;
43 import javax.swing.JLabel;
44 import javax.swing.JList;
45 import javax.swing.JMenuItem;
46 import javax.swing.JOptionPane;
47 import javax.swing.JPanel;
48 import javax.swing.JPopupMenu;
49 import javax.swing.JScrollPane;
50 import javax.swing.JSlider;
51 import javax.swing.JSplitPane;
52 import javax.swing.JTabbedPane;
53 import javax.swing.JTable;
54 import javax.swing.JTextArea;
55 import javax.swing.JTextField;
56 import javax.swing.ListSelectionModel;
57 import javax.swing.SwingConstants;
58 import javax.swing.SwingUtilities;
59 import javax.swing.border.TitledBorder;
60 import javax.swing.event.CellEditorListener;
61 import javax.swing.event.ChangeEvent;
62 import javax.swing.event.ChangeListener;
63 import javax.swing.event.DocumentEvent;
64 import javax.swing.event.DocumentListener;
65 import javax.swing.table.*;
67 import compbio.metadata.Argument;
68 import compbio.metadata.Option;
69 import compbio.metadata.Parameter;
70 import compbio.metadata.Preset;
71 import compbio.metadata.PresetManager;
72 import compbio.metadata.RunnerConfig;
73 import compbio.metadata.ValueConstrain;
74 import compbio.metadata.WrongParameterException;
75 import compbio.metadata.ValueConstrain.Type;
77 import jalview.util.jarInputStreamProvider;
78 import jalview.ws.jws2.JabaParamStore;
79 import jalview.ws.jws2.JabaPreset;
80 import jalview.ws.jws2.Jws2Discoverer;
81 import jalview.ws.jws2.ParameterUtils;
82 import jalview.ws.jws2.Jws2Discoverer.Jws2Instance;
83 import jalview.ws.jws2.dm.JabaOption;
84 import jalview.ws.jws2.dm.JabaParameter;
85 import jalview.ws.params.ArgumentI;
86 import jalview.ws.params.OptionI;
87 import jalview.ws.params.ParamDatastoreI;
88 import jalview.ws.params.ParameterI;
89 import jalview.ws.params.ValueConstrainI;
90 import jalview.ws.params.WsParamSetI;
93 * job parameter editing/browsing dialog box. User can browse existing settings
94 * (user + presets + Defaults), and any changes to parameters creates a modified
95 * user parameter set. LOGIC: If the parameter set is modified, and its name is
96 * a valid, non-existant user parameter set, then a save button is shown. If the
97 * parameter set is modified and its name is a valid, extant user parameter set,
98 * then an update button is shown. If user parameter set's name is edited, and
99 * old name exists as a writable user parameter set, then rename button is
100 * shown. If current parameter set is associated with a user defined parameter
101 * set, then : if set is modifed, a 'revert' button is shown. if set is not
102 * modified, a 'delete' button is shown.
107 public class WsJobParameters extends JPanel implements ItemListener,
108 ActionListener, DocumentListener
110 URL linkImageURL = getClass().getResource("/images/link.gif");
111 private static final String SVC_DEF = "Defaults"; // this is the null
112 // parameter set as shown to
115 private static final int PARAM_WIDTH = 340, PARAM_HEIGHT = 150,
116 PARAM_CLOSEDHEIGHT = 80;
118 private static final int OPTSET_HEIGHT = 30;
120 JPanel SetNamePanel = new JPanel();
122 JPanel setDetails = new JPanel();
124 JSplitPane settingsPanel = new JSplitPane();
126 JSplitPane jobPanel = new JSplitPane();
127 JTabbedPane tabpanels=new JTabbedPane();
128 JPanel jobOptions = new JPanel();
130 JScrollPane jobOptionsPane = new JScrollPane();
132 JPanel jobParameters = new JPanel();
134 JButton createpref = new JButton();
136 JButton deletepref = new JButton();
138 JButton revertpref = new JButton();
140 JButton updatepref = new JButton();
142 JButton startjob = new JButton();
144 JButton canceljob = new JButton();
146 JComboBox setName = new JComboBox();
148 JTextArea setDescr = new JTextArea();
150 JScrollPane paramPane = new JScrollPane();
152 JPanel paramList = new JPanel();
154 RunnerConfig serviceOptions;
156 ParamDatastoreI paramStore;
158 WsJobParameters(Jws2Instance service)
163 public WsJobParameters(Jws2Instance service, WsParamSetI preset)
165 this(null, service, preset, null);
171 * - if null, create new JFrame outside of desktop
175 public WsJobParameters(JFrame parent, Jws2Instance service,
176 WsParamSetI preset, List<Argument> jobArgset)
178 this(parent, null, service, preset, jobArgset);
189 public WsJobParameters(JFrame parent, ParamDatastoreI paramStorei,
190 Jws2Instance service, WsParamSetI preset, List<Argument> jobArgset)
194 this.paramStore = paramStorei;
195 if (paramStore == null)
197 paramStore = service.getParamStore();
199 this.service = service;
200 // argSetModified(false);
201 // populate parameter table
202 initForService(service, preset, jobArgset);
203 // display in new JFrame attached to parent.
209 JDialog frame = null;
212 * shows a modal dialog containing the parameters.
216 public boolean showRunDialog()
219 frame = new JDialog(Desktop.instance, true);
221 frame.setTitle("Edit parameters for " + service.getActionText());
222 Rectangle deskr = Desktop.instance.getBounds();
223 frame.setBounds(new Rectangle((int) (deskr.getCenterX() - 240),
224 (int) (deskr.getCenterY() - 250), 480, 500));
225 frame.setContentPane(this);
226 // should recover defaults from user prefs.
227 //settingsPanel.setDividerLocation(0.4);
228 //jobPanel.setDividerLocation(0.5);
229 tabpanels.setSelectedComponent(jobOptionsPane);
231 frame.setVisible(true);
240 protected JButton makeButton(String label, String tooltip,
241 ActionListener action)
243 JButton button = new JButton();
244 button.setText(label);
245 button.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
246 button.setForeground(Color.black);
247 button.setHorizontalAlignment(SwingConstants.CENTER);
248 button.setToolTipText(tooltip);
249 button.addActionListener(action);
253 private void jbInit()
255 updatepref = makeButton("Update", "Update the stored user preference",
259 public void actionPerformed(ActionEvent e)
261 update_actionPerformed(e);
264 deletepref = makeButton("Delete", "Delete the user preference",
268 public void actionPerformed(ActionEvent e)
270 delete_actionPerformed(e);
273 createpref = makeButton("Create", "Create a new preference",
277 public void actionPerformed(ActionEvent e)
279 create_actionPerformed(e);
282 revertpref = makeButton("Revert",
283 "Undo all changes to the current set", new ActionListener()
286 public void actionPerformed(ActionEvent e)
288 revert_actionPerformed(e);
291 startjob.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
292 startjob.setText("Start");
293 startjob.setToolTipText("Start Job");
294 startjob.addActionListener(new ActionListener()
296 public void actionPerformed(ActionEvent e)
298 startjob_actionPerformed(e);
301 canceljob.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
302 canceljob.setText("Cancel");
303 canceljob.setToolTipText("Cancel Job");
304 canceljob.addActionListener(new ActionListener()
306 public void actionPerformed(ActionEvent e)
308 canceljob_actionPerformed(e);
312 setDetails.setBorder(new TitledBorder("Details"));
313 setDetails.setLayout(new BorderLayout());
314 setDescr.setColumns(40);
315 setDescr.setWrapStyleWord(true);
316 setDescr.setLineWrap(true);
317 setDescr.setBackground(getBackground());
318 setDescr.setEditable(true);
319 setDescr.getDocument().addDocumentListener(this);
320 JScrollPane setDescrView = new JScrollPane();
321 // setDescrView.setPreferredSize(new Dimension(350, 200));
322 setDescrView.getViewport().setView(setDescr);
323 setName.setEditable(true);
324 setName.addItemListener(this);
325 setName.getEditor().addActionListener(this);
326 JPanel setNameInfo = new JPanel(new FlowLayout(FlowLayout.LEFT));
327 SetNamePanel.setLayout(new GridLayout(2, 1));
328 SetNamePanel.setMinimumSize(new Dimension(300, 40));
329 JLabel setNameLabel = new JLabel("Parameter set: ");
330 setNameLabel.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
331 // setNameLabel.setHorizontalAlignment(FlowLayout.LEFT);
332 setNameInfo.add(setNameLabel);
333 setNameInfo.add(setName);
334 // initial button visibility
335 updatepref.setVisible(false);
336 deletepref.setVisible(false);
337 revertpref.setVisible(false);
338 createpref.setVisible(false);
339 JPanel setsavebuts = new JPanel();
340 setsavebuts.setLayout(new FlowLayout(FlowLayout.LEFT)); // GridLayout(1,2));
341 ((FlowLayout) setsavebuts.getLayout()).setHgap(10);
342 ((FlowLayout) setsavebuts.getLayout()).setVgap(0);
343 setsavebuts.add(deletepref);
344 setsavebuts.add(revertpref);
345 setsavebuts.add(createpref);
346 setsavebuts.add(updatepref);
347 setsavebuts.setSize(new Dimension(150, 20));
348 JPanel buttonArea = new JPanel(new GridLayout(1, 1));
349 buttonArea.add(setsavebuts);
350 SetNamePanel.add(setNameInfo);
351 SetNamePanel.add(buttonArea);
352 setDetails.add(setDescrView, BorderLayout.CENTER);
353 //setDetails.setPreferredSize(new Dimension(360, 100));
354 jobParameters.setBorder(new TitledBorder("Parameters"));
355 jobParameters.setLayout(new BorderLayout());
356 paramPane.setPreferredSize(new Dimension(360, 300));
357 paramPane.getVerticalScrollBar().setUnitIncrement(20);
358 // paramPanel.setPreferredSize(new Dimension(360, 300));
359 // TODO: relayout buttons nicely
360 paramPane.getViewport().setView(paramList);
361 jobParameters.add(paramPane, BorderLayout.CENTER);
362 JPanel jobOptionsPanel = new JPanel();
363 jobOptionsPanel.setLayout(new BorderLayout());
364 jobOptionsPanel.setBorder(new TitledBorder("Options"));
365 jobOptionsPane.getViewport().setView(jobOptions);
366 jobOptionsPanel.add(jobOptionsPane, BorderLayout.CENTER);
367 //settingsPanel.setLeftComponent(jobOptionsPanel);
368 //settingsPanel.setRightComponent(jobParameters);
369 //settingsPanel.setOrientation(JSplitPane.VERTICAL_SPLIT);
371 setLayout(new BorderLayout());
372 jobPanel.setLeftComponent(setDetails);
373 jobPanel.setRightComponent(tabpanels);
374 jobPanel.setOrientation(JSplitPane.VERTICAL_SPLIT);
375 add(SetNamePanel, BorderLayout.NORTH);
376 //add(jobPanel, BorderLayout.CENTER);
377 //setDescrView.setName("Description");
378 //tabpanels.add(setDescrView);
379 jobOptionsPane.setName("Options");
380 tabpanels.add(jobOptionsPane);
381 paramPane.setName("Parameters");
382 tabpanels.add(paramPane);
383 add(jobPanel, BorderLayout.CENTER);
384 JPanel dialogpanel = new JPanel();
385 dialogpanel.add(startjob);
386 dialogpanel.add(canceljob);
387 add(dialogpanel, BorderLayout.SOUTH);
390 protected void revert_actionPerformed(ActionEvent e)
392 reInitDialog(lastParmSet);
396 protected void update_actionPerformed(ActionEvent e)
400 String curname = ((String) setName.getSelectedItem()).trim();
401 _updatePreset(lastParmSet, curname);
402 lastParmSet = curname;
404 initArgSetModified();
405 syncSetNamesWithStore();
409 private void _deleteUserPreset(String lastParmSet2)
411 paramStore.deletePreset(lastParmSet2);
414 protected void delete_actionPerformed(ActionEvent e)
418 // delete current preset's saved entry
419 _deleteUserPreset(lastParmSet);
421 reInitDialog(null); // service default
424 protected void create_actionPerformed(ActionEvent e)
426 String curname = ((String) setName.getSelectedItem()).trim();
427 if (curname.length() > 0)
429 _storeCurrentPreset(curname);
430 lastParmSet = curname;
432 initArgSetModified();
436 // TODO: show warning
437 System.err.println("Invalid name. Not saved.");
441 protected void canceljob_actionPerformed(ActionEvent e)
446 frame.setVisible(false);
450 protected void startjob_actionPerformed(ActionEvent e)
455 frame.setVisible(false);
459 Jws2Instance service;
462 * list of service presets in the gui
464 Hashtable servicePresets = null;
467 * set if dialog is being set - so handlers will avoid spurious events
469 boolean settingDialog = false;
471 void initForService(Jws2Instance service, WsParamSetI jabap,
472 List<Argument> jabajobArgset)
474 WsParamSetI p = null;
475 List<ArgumentI> jobArgset = null;
476 settingDialog = true;
477 { // instantiate the abstract proxy for Jaba objects
478 jobArgset = jabajobArgset == null ? null : JabaParamStore
479 .getJwsArgsfromJaba(jabajobArgset);
480 p = jabap; // (jabap != null) ? paramStore.getPreset(jabap.getName()) :
483 // TODO: Recover window geometry prefs for this service
484 // jobPanel.setDividerLocation(proportionalLocation)
485 // settingsPanel.setDividerLocation(proportionalLocation)
486 Hashtable exnames = new Hashtable();
487 for (int i = 0, iSize = setName.getItemCount(); i < iSize; i++)
489 exnames.put((String) setName.getItemAt(i), setName.getItemAt(i));
491 servicePresets = new Hashtable();
492 // Add the default entry - if not present already.
493 if (!exnames.contains(SVC_DEF))
495 setName.addItem(SVC_DEF);
496 exnames.put(SVC_DEF, SVC_DEF);
497 servicePresets.put(SVC_DEF, SVC_DEF);
499 String curname = (p == null ? "" : p.getName());
500 for (WsParamSetI pr : paramStore.getPresets())
502 if (!pr.isModifiable())
504 servicePresets.put(pr.getName(), "preset");
509 if (!exnames.contains(pr.getName()))
511 setName.addItem(pr.getName());
514 // TODO: if initial jobArgset matches a given user setting or preset then
515 // should recover setting accordingly
516 // updateTable(p, jobArgset);
519 reInitDialog(p.getName());
520 initArgSetModified();
524 if (jobArgset != null && jobArgset.size() > 0)
526 curSetName = "Supplied Settings";
527 updateTable(p, jobArgset);
535 settingDialog = false;
539 @SuppressWarnings("unchecked")
540 private void updateTable(WsParamSetI p, List<ArgumentI> jobArgset)
542 // populate table from default parameter set.
543 List<ArgumentI> args = paramStore.getServiceParameters();
545 // split to params and required arguments
547 for (ArgumentI myarg : args)
549 // Ideally, Argument would implement isRequired !
550 if (myarg instanceof ParameterI)
552 ParameterI parm = (ParameterI) myarg;
557 if (myarg instanceof OptionI)
559 OptionI opt = (OptionI) myarg;
560 addOption(opt).resetToDefault();
564 System.err.println("Ignoring unknown service argument type "
565 + myarg.getClass().getName());
569 args = null; // no more args to process.
573 isUserPreset = false;
574 // initialise setname
575 setName.setSelectedItem(lastSetName = p.getName());
576 setDescr.setText(lastDescrText = p.getDescription());
580 args = p.getArguments();
581 } catch (Exception e)
585 // TODO: check if args should be unselected prior to resetting using the
590 if (lastParmSet == null)
592 isUserPreset = false;
593 // first call - so create a dummy name
595 setName.setSelectedItem(lastSetName = SVC_DEF);
599 if (jobArgset != null)
601 argSetModified(jobArgset, true);
604 // get setargs from current object
607 for (ArgumentI arg : args)
609 if (arg instanceof ParameterI)
611 setParameter((ParameterI) arg);
615 if (arg instanceof OptionI)
617 // System.out.println("Setting option "
618 // + System.identityHashCode(arg) + ":" + arg.getName()
619 // + " with " + arg.getDefaultValue());
620 selectOption((OptionI) arg, arg.getDefaultValue());
627 jobOptions.setPreferredSize(new Dimension(PARAM_WIDTH, optSet.size()
629 jobOptions.setLayout(new GridLayout(optSet.size(), 1));
630 refreshParamLayout();
631 paramPane.validate();
635 private boolean isModified()
637 return modifiedElements.size() > 0;
640 private Hashtable modifiedElements = new Hashtable();
643 * reset gui and modification state settings
645 private void initArgSetModified()
648 modifiedElements.clear();
649 updateButtonDisplay();
652 private void updateButtonDisplay()
654 boolean _update = false, _create = false, _delete = false, _revert = false;
655 if (modifiedElements.size() > 0)
659 _update = isUserPreset; // can only update user presets
660 if (!isUserPreset || modifiedElements.containsKey(setName))
662 // name modified - can create new preset
670 // can still delete a user preset
671 _delete = isUserPreset;
673 createpref.setVisible(_create);
674 updatepref.setVisible(_update);
675 deletepref.setVisible(_delete);
676 revertpref.setVisible(_revert);
680 private void argSetModified(Object modifiedElement, boolean b)
688 modifiedElements.remove(modifiedElement);
692 if (b && modifiedElement == setName
693 && modifiedElements.contains(modifiedElement))
695 // HACK! prevents iteration on makeSetNameValid
698 modifiedElements.put(modifiedElement, modifiedElement);
700 // set mod status based on presence of elements in table
701 if (b && modifiedElements.size() > 0)
703 makeSetNameValid(!isUserPreset);
704 SetNamePanel.revalidate();
706 updateButtonDisplay();
709 private boolean isServicePreset(String selectedItem)
711 return selectedItem.equals(SVC_DEF)
712 || servicePresets.containsKey(selectedItem);
716 * check if the current set name is a valid set name for saving, if not, then
719 private void makeSetNameValid(boolean newuserset)
721 boolean stn = settingDialog;
722 boolean renamed = false;
723 settingDialog = true;
724 String nm = (curSetName != null ? curSetName : (String) setName
726 // check if the name is reserved - if it is, rename it.
727 if (isServicePreset(nm))
736 while (paramStore.getPreset(tnm) != null)
738 tnm = nm + " (" + (++i) + ")";
747 boolean makeupdate = false;
748 // sync the gui with the preset database
749 for (int i = 0, iS = setName.getItemCount(); i < iS; i++)
751 String snm = (String) setName.getItemAt(i);
755 // setName.setSelectedIndex(i);
760 setName.addItem(curSetName = nm);
761 setName.setSelectedItem(curSetName);
765 settingDialog = false; // we need this name change to be registered.
766 argSetModified(setName, renamed);
771 private void addParameter(ParameterI arg)
773 ParamBox pb = paramSet.get(arg.getName());
776 pb = new ParamBox(this, arg);
777 paramSet.put(arg.getName(), pb);
781 // take the defaults from the parameter
782 pb.updateControls(arg);
785 private void setParameter(ParameterI arg)
787 ParamBox pb = paramSet.get(arg.getName());
794 pb.updateControls(arg);
799 private void selectOption(OptionI option, String string)
801 OptionBox cb = optSet.get(option.getName());
804 cb = addOption(option);
806 cb.enabled.setSelected(string != null); // initial state for an option.
809 if (option.getPossibleValues().contains(string))
811 cb.val.setSelectedItem(string);
815 throw new Error("Invalid value " + string + " for option " + option);
819 if (option.isRequired() && !cb.enabled.isSelected())
821 // TODO: indicate paramset is not valid.. option needs to be selected!
823 cb.setInitialValue();
826 Map<String, ParamBox> paramSet = new Hashtable<String, ParamBox>();
828 public class ParamBox extends JPanel implements ChangeListener,
829 ActionListener, MouseListener
831 JButton showDesc = new JButton();
833 JTextArea string = new JTextArea();
835 JScrollPane descPanel = new JScrollPane();
837 JSlider slider = null;
839 JTextField valueField = null;
841 ValueConstrainI validator = null;
843 JPanel settingPanel = new JPanel();
845 JPanel controlPanel = new JPanel();
847 boolean integ = false;
849 boolean choice = false;
851 boolean descisvisible = false;
853 final WsJobParameters pmdialogbox;
857 public ParamBox(final WsJobParameters pmlayout, ParameterI parm)
859 pmdialogbox = pmlayout;
860 setPreferredSize(new Dimension(PARAM_WIDTH, PARAM_CLOSEDHEIGHT));
861 setBorder(new TitledBorder(parm.getName()));
863 showDesc.setFont(new Font("Verdana", Font.PLAIN, 6));
864 showDesc.setText("+");
865 string.setFont(new Font("Verdana", Font.PLAIN, 11));
866 string.setBackground(getBackground());
867 // string.setSize(new Dimension(PARAM_WIDTH, 80));
868 string.setEditable(false);
869 descPanel.getViewport().setView(string);
870 // descPanel.setLocation(2,17);
871 descPanel.setVisible(false);
872 // string.setMinimumSize(new Dimension(140,80));
873 // string.setMaximumSize(new Dimension(280,80));
874 final ParamBox me = this;
875 finfo = parm.getFurtherDetails();
878 showDesc.setToolTipText("<html><p>Click to show brief description<br><img src=\"" + linkImageURL + "\"/> Right click for further information.</p></html>");
879 showDesc.addMouseListener(this);
883 showDesc.setToolTipText("<html><p>Click to show brief description.</p></html>");
885 showDesc.addActionListener(new ActionListener()
888 public void actionPerformed(ActionEvent e)
890 descisvisible = !descisvisible;
891 descPanel.setVisible(descisvisible);
892 me.setPreferredSize(new Dimension(PARAM_WIDTH,
893 (descisvisible) ? PARAM_HEIGHT : PARAM_CLOSEDHEIGHT));
895 pmlayout.refreshParamLayout();
898 string.setWrapStyleWord(true);
899 string.setLineWrap(true);
900 string.setColumns(32);
901 string.setText(parm.getDescription());
902 JPanel firstrow = new JPanel();
903 firstrow.setLayout(null);
904 controlPanel.setLayout(new BorderLayout());
905 controlPanel.setBounds(new Rectangle(39, 10, PARAM_WIDTH - 70,
906 PARAM_CLOSEDHEIGHT - 50));
907 showDesc.setBounds(new Rectangle(10, 10, 16, 16));
908 firstrow.add(showDesc);
909 firstrow.add(controlPanel);
910 firstrow.setBounds(new Rectangle(10, 20, PARAM_WIDTH - 30,
911 PARAM_CLOSEDHEIGHT - 30));
913 validator = parm.getValidValue();
915 if (validator != null)
917 integ = validator.getType() == Type.Integer;
921 if (parameter.getPossibleValues() != null)
926 updateControls(parm);
927 descPanel.setBounds(new Rectangle(10, PARAM_CLOSEDHEIGHT,
928 PARAM_WIDTH - 20, PARAM_HEIGHT - PARAM_CLOSEDHEIGHT - 5));
935 // reset the widget's initial value.
939 boolean adjusting = false;
941 ParameterI parameter;
945 public int getBoxHeight()
947 return (descisvisible ? PARAM_HEIGHT : PARAM_CLOSEDHEIGHT);
950 public void updateControls(ParameterI parm)
953 boolean init = (choicebox == null && valueField == null);
960 choicebox = new JComboBox();
961 choicebox.addActionListener(this);
962 controlPanel.add(choicebox, BorderLayout.CENTER);
966 slider = new JSlider();
967 slider.addChangeListener(this);
968 valueField = new JTextField();
969 valueField.addActionListener(this);
970 valueField.setPreferredSize(new Dimension(60, 25));
971 controlPanel.add(slider, BorderLayout.WEST);
972 controlPanel.add(valueField, BorderLayout.EAST);
983 List vals = parm.getPossibleValues();
984 for (Object val : vals)
986 choicebox.addItem(val);
990 if (parm.getDefaultValue() != null)
992 choicebox.setSelectedItem(parm.getDefaultValue());
997 valueField.setText(parm.getDefaultValue());
1000 lastVal = updateSliderFromValueField();
1006 public ParameterI getParameter()
1008 ParameterI prm = parameter.copy();
1011 prm.setDefaultValue((String) choicebox.getSelectedItem());
1015 prm.setDefaultValue(valueField.getText());
1020 public Object updateSliderFromValueField()
1024 if (validator != null)
1031 valueField.setText(valueField.getText().trim());
1032 iVal = Integer.valueOf(valueField.getText());
1033 if (validator.getMin() != null
1034 && validator.getMin().intValue() > iVal)
1036 iVal = validator.getMin().intValue();
1037 // TODO: provide visual indication that hard limit was reached for
1040 if (validator.getMax() != null
1041 && validator.getMax().intValue() < iVal)
1043 iVal = validator.getMax().intValue();
1044 // TODO: provide visual indication that hard limit was reached for
1047 } catch (Exception e)
1051 if (validator.getMin() != null && validator.getMax() != null)
1053 slider.getModel().setRangeProperties(iVal, 1,
1054 validator.getMin().intValue(),
1055 validator.getMax().intValue(), true);
1059 slider.setVisible(false);
1069 fVal = Float.valueOf(valueField.getText());
1070 if (validator.getMin() != null
1071 && validator.getMin().floatValue() > fVal)
1073 fVal = validator.getMin().floatValue();
1074 // TODO: provide visual indication that hard limit was reached for
1077 if (validator.getMax() != null
1078 && validator.getMax().floatValue() < fVal)
1080 fVal = validator.getMax().floatValue();
1081 // TODO: provide visual indication that hard limit was reached for
1084 } catch (Exception e)
1088 if (validator.getMin() != null && validator.getMax() != null)
1090 slider.getModel().setRangeProperties((int) fVal * 1000, 1,
1091 (int) validator.getMin().floatValue() * 1000,
1092 (int) validator.getMax().floatValue() * 1000, true);
1096 slider.setVisible(false);
1106 slider.setVisible(false);
1108 { valueField.getText().trim() };
1113 { (String) choicebox.getSelectedItem() };
1119 public void stateChanged(ChangeEvent e)
1123 valueField.setText(""
1124 + ((integ) ? ("" + (int) slider.getValue())
1125 : ("" + (float) (slider.getValue() / 1000f))));
1131 public void actionPerformed(ActionEvent e)
1139 updateSliderFromValueField();
1144 private void checkIfModified()
1146 Object cstate = updateSliderFromValueField();
1147 boolean notmod = false;
1148 if (cstate.getClass() == lastVal.getClass())
1150 if (cstate instanceof int[])
1152 notmod = (((int[]) cstate)[0] == ((int[]) lastVal)[0]);
1154 else if (cstate instanceof float[])
1156 notmod = (((float[]) cstate)[0] == ((float[]) lastVal)[0]);
1158 else if (cstate instanceof String[])
1160 notmod = (((String[]) cstate)[0].equals(((String[]) lastVal)[0]));
1163 pmdialogbox.argSetModified(this, !notmod);
1166 public void mouseClicked(MouseEvent e)
1168 if (javax.swing.SwingUtilities.isRightMouseButton(e))
1170 showUrlPopUp(this, finfo.toString(), e.getX(), e.getY());
1174 public void mousePressed(MouseEvent e)
1176 // TODO Auto-generated method stub
1180 public void mouseReleased(MouseEvent e)
1182 // TODO Auto-generated method stub
1186 public void mouseEntered(MouseEvent e)
1188 // TODO Auto-generated method stub
1192 public void mouseExited(MouseEvent e)
1194 // TODO Auto-generated method stub
1200 Map<String, OptionBox> optSet = new Hashtable<String, OptionBox>();
1202 public class OptionBox extends JPanel implements MouseListener,
1205 JComboBox val = new JComboBox();
1207 JCheckBox enabled = new JCheckBox();
1209 JLabel optlabel = new JLabel();
1213 boolean hasLink = false;
1217 public OptionBox(OptionI opt)
1220 setLayout(new BorderLayout());
1221 enabled.setSelected(opt.isRequired()); // TODO: lock required options
1222 enabled.setFont(new Font("Verdana", Font.PLAIN, 11));
1223 enabled.setText("");
1224 enabled.setText(opt.getName());
1225 enabled.addActionListener(this);
1226 finfo = option.getFurtherDetails();
1230 // optlabel.setToolTipText("<html><p>"+opt.getDescription()+"</p><img src=\""+linkImageURL+"\"/></html>");
1231 enabled.setToolTipText("<html><p>" + opt.getDescription()
1232 + "</p><img src=\"" + linkImageURL + "\"/></html>");
1233 // optlabel.addMouseListener(this);
1234 enabled.addMouseListener(this);
1238 // optlabel.setToolTipText(opt.getDescription());
1239 enabled.setToolTipText(opt.getDescription());
1241 add(enabled, BorderLayout.NORTH);
1242 if (opt.getPossibleValues().size() > 1)
1244 setLayout(new GridLayout(1, 2));
1245 for (Object str : opt.getPossibleValues())
1247 val.addItem((String) str);
1249 val.setSelectedItem((String) opt.getDefaultValue());
1250 val.addActionListener(this);
1251 add(val, BorderLayout.SOUTH);
1253 // TODO: add actionListeners for popup (to open further info),
1254 // and to update list of parameters if an option is enabled
1255 // that takes a value.
1259 public void resetToDefault()
1261 enabled.setSelected(false);
1262 if (option.isRequired())
1264 // Apply default value
1265 selectOption(option, option.getDefaultValue());
1269 boolean initEnabled = false;
1271 String initVal = null;
1273 public void setInitialValue()
1275 initEnabled = enabled.isSelected();
1276 if (option.getPossibleValues() != null
1277 && option.getPossibleValues().size() > 1)
1279 initVal = (String) val.getSelectedItem();
1283 initVal = (initEnabled) ? option.getDefaultValue() : null;
1287 public OptionI getOptionIfEnabled()
1289 if (!enabled.isSelected())
1293 OptionI opt = option.copy();
1295 if (val.getSelectedItem() != null)
1297 opt.setDefaultValue((String) val.getSelectedItem());
1302 public void actionPerformed(ActionEvent e)
1304 if (e.getSource() != enabled)
1306 enabled.setSelected(true);
1311 private void checkIfModified()
1313 boolean notmod = (initEnabled == enabled.isSelected());
1314 if (enabled.isSelected())
1316 if (initVal != null)
1318 notmod &= initVal.equals(val.getSelectedItem());
1322 // compare against default service setting
1323 notmod &= option.getDefaultValue() == null
1324 || option.getDefaultValue().equals(val.getSelectedItem());
1329 notmod &= initVal == null;
1331 argSetModified(this, !notmod);
1334 public void mouseClicked(MouseEvent e)
1336 if (javax.swing.SwingUtilities.isRightMouseButton(e))
1338 showUrlPopUp(this, finfo.toString(), e.getX(), e.getY());
1342 public void mousePressed(MouseEvent e)
1344 // TODO Auto-generated method stub
1348 public void mouseReleased(MouseEvent e)
1350 // TODO Auto-generated method stub
1354 public void mouseEntered(MouseEvent e)
1356 // TODO Auto-generated method stub
1360 public void mouseExited(MouseEvent e)
1362 // TODO Auto-generated method stub
1368 private OptionBox addOption(OptionI opt)
1370 OptionBox cb = optSet.get(opt.getName());
1373 cb = new OptionBox(opt);
1374 optSet.put(opt.getName(), cb);
1380 public static void showUrlPopUp(JComponent invoker, final String finfo,
1384 JPopupMenu mnu = new JPopupMenu();
1385 JMenuItem mitem = new JMenuItem("View " + finfo);
1386 mitem.addActionListener(new ActionListener()
1390 public void actionPerformed(ActionEvent e)
1392 Desktop.showUrl(finfo);
1397 mnu.show(invoker, x, y);
1400 protected void refreshParamLayout()
1402 FlowLayout fl = new FlowLayout();
1403 paramList.setLayout(fl);
1404 int s = 2 * fl.getVgap();
1405 for (ParamBox pbox : paramSet.values())
1407 s += fl.getVgap() + pbox.getBoxHeight(); // getBoxHeight();
1409 paramList.setPreferredSize(new Dimension(PARAM_WIDTH, s));
1414 * testing method - grab a service and parameter set and show the window
1418 public static void main(String[] args)
1420 jalview.ws.jws2.Jws2Discoverer disc = jalview.ws.jws2.Jws2Discoverer
1423 if (args.length > 3)
1425 Vector<String> services = new Vector<String>();
1426 services.addElement(args[p++]);
1427 Jws2Discoverer.setServiceUrls(services);
1432 } catch (Exception e)
1434 System.err.println("Aborting. Problem discovering services.");
1435 e.printStackTrace();
1438 Jws2Discoverer.Jws2Instance lastserv = null;
1439 for (Jws2Discoverer.Jws2Instance service : disc.getServices())
1442 if (p >= args.length || service.serviceType.equalsIgnoreCase(args[p]))
1444 if (lastserv != null)
1446 List<Preset> prl = null;
1448 if (++p < args.length)
1450 PresetManager prman = lastserv.getPresets();
1453 pr = prman.getPresetByName(args[p]);
1456 // just grab the last preset.
1457 prl = prman.getPresets();
1463 PresetManager prman = lastserv.getPresets();
1466 prl = prman.getPresets();
1469 Iterator<Preset> en = (prl == null) ? null : prl.iterator();
1470 while (en != null && en.hasNext())
1476 en = prl.iterator();
1481 System.out.println("Testing opts dupes for "
1482 + lastserv.getUri() + " : "
1483 + lastserv.getActionText() + ":" + pr.getName());
1484 List<Option> rg = lastserv.getRunnerConfig().getOptions();
1489 Option cpy = jalview.ws.jws2.ParameterUtils.copyOption(o);
1490 } catch (Exception e)
1492 System.err.println("Failed to copy " + o.getName());
1493 e.printStackTrace();
1496 System.err.println("Failed to copy " + o.getName());
1497 e.printStackTrace();
1502 System.out.println("Testing param dupes:");
1503 List<Parameter> rg = lastserv.getRunnerConfig()
1505 for (Parameter o : rg)
1509 Parameter cpy = jalview.ws.jws2.ParameterUtils
1511 } catch (Exception e)
1513 System.err.println("Failed to copy " + o.getName());
1514 e.printStackTrace();
1517 System.err.println("Failed to copy " + o.getName());
1518 e.printStackTrace();
1523 System.out.println("Testing param write:");
1524 List<String> writeparam = null, readparam = null;
1527 writeparam = jalview.ws.jws2.ParameterUtils
1529 pr.getArguments(lastserv.getRunnerConfig()),
1531 System.out.println("Testing param read :");
1532 List<Option> pset = jalview.ws.jws2.ParameterUtils
1533 .processParameters(writeparam,
1534 lastserv.getRunnerConfig(), " ");
1535 readparam = jalview.ws.jws2.ParameterUtils
1536 .writeParameterSet(pset, " ");
1537 Iterator<String> o = pr.getOptions().iterator(), s = writeparam
1538 .iterator(), t = readparam.iterator();
1539 boolean failed = false;
1540 while (s.hasNext() && t.hasNext())
1542 String on = o.next(), sn = s.next(), st = t.next();
1545 System.out.println("Original was " + on
1546 + " Phase 1 wrote " + sn + "\tPhase 2 wrote "
1553 System.out.println("Original parameters:\n"
1555 System.out.println("Wrote parameters in first set:\n"
1557 System.out.println("Wrote parameters in second set:\n"
1561 } catch (Exception e)
1563 e.printStackTrace();
1566 WsJobParameters pgui = new WsJobParameters(lastserv,
1567 new JabaPreset(lastserv, pr));
1568 JFrame jf = new JFrame("Parameters for "
1569 + lastserv.getActionText());
1570 JPanel cont = new JPanel();
1571 // jf.setPreferredSize(new Dimension(600, 800));
1574 final Thread thr = Thread.currentThread();
1575 jf.addWindowListener(new WindowListener()
1578 public void windowActivated(WindowEvent e)
1580 // TODO Auto-generated method stub
1584 public void windowClosed(WindowEvent e)
1588 public void windowClosing(WindowEvent e)
1594 public void windowDeactivated(WindowEvent e)
1596 // TODO Auto-generated method stub
1600 public void windowDeiconified(WindowEvent e)
1602 // TODO Auto-generated method stub
1606 public void windowIconified(WindowEvent e)
1608 // TODO Auto-generated method stub
1612 public void windowOpened(WindowEvent e)
1614 // TODO Auto-generated method stub
1619 jf.setVisible(true);
1620 boolean inter = false;
1625 Thread.sleep(10000);
1626 } catch (Exception e)
1639 public List<ArgumentI> getJobParams()
1641 List<ArgumentI> argSet = new ArrayList<ArgumentI>();
1642 // recover options and parameters from GUI
1643 for (OptionBox opts : optSet.values())
1645 OptionI opt = opts.getOptionIfEnabled();
1651 for (ParamBox parambox : paramSet.values())
1653 ParameterI parm = parambox.getParameter();
1663 String lastParmSet = null;
1666 * Hashtable<String, Object[]> editedParams = new Hashtable<String,
1669 * store the given parameters in the user parameter set database.
1671 * @param storeSetName - lastParmSet
1673 * @param descr - setDescr.getText()
1675 * @param jobParams - getJobParams()
1677 * private void _storeUserPreset(String storeSetName, String descr,
1678 * List<ArgumentI> jobParams) { // this is a simple hash store. Object[] pset;
1679 * editedParams.put(storeSetName, pset = new Object[3]); pset[0] =
1680 * storeSetName; pset[1] = descr; pset[2] = jobParams; // writeParam("Saving "
1681 * + storeSetName + ": ", jobParams); }
1683 * private void writeParam(String nm, List<ArgumentI> params) { for (ArgumentI
1684 * p : params) { System.out.println(nm + ":" + System.identityHashCode(p) +
1685 * " Name: " + p.getName() + " Value: " + p.getDefaultValue()); } }
1687 * private Object[] _getUserPreset(String setName) { Object[] pset =
1688 * editedParams.get(setName); // if (pset != null) // writeParam("Retrieving "
1689 * + setName + ": ", (List<Argument>) pset[2]); return pset; }
1691 * * remove the given user preset from the preset stash
1695 * private void _deleteUserPreset(String setName) {
1696 * editedParams.remove(setName); }
1699 private void syncSetNamesWithStore()
1702 // remove any set names in the drop down menu that aren't either a reserved
1703 // setting, or a user defined or service preset.
1704 Vector items = new Vector();
1705 while (n < setName.getItemCount())
1707 String item = (String) setName.getItemAt(n);
1708 if (!item.equals(SVC_DEF) && !paramStore.presetExists(item))
1710 setName.removeItemAt(n);
1714 items.addElement(item);
1718 if (!items.contains(SVC_DEF))
1720 setName.addItem(SVC_DEF);
1722 for (WsParamSetI upn : paramStore.getPresets())
1724 if (!items.contains(upn.getName()))
1726 setName.addItem(upn.getName());
1732 * true if lastParmSet is a user preset
1734 boolean isUserPreset = false;
1736 private void reInitDialog(String nextPreset)
1738 settingDialog = true;
1739 // updateTable(null,null); // first reset to defaults
1740 WsParamSetI pset = null;
1741 if (nextPreset != null && nextPreset.length() > 0)
1743 pset = paramStore.getPreset(nextPreset);
1747 if (pset.isModifiable())
1749 isUserPreset = true;
1750 setDescr.setText(pset.getDescription());
1751 updateTable(null, pset.getArguments());
1752 lastParmSet = nextPreset;
1756 isUserPreset = false;
1757 setDescr.setText("");
1758 // must be a default preset from service
1759 updateTable(pset, null);
1760 lastParmSet = nextPreset;
1765 isUserPreset = false;
1767 updateTable(null, null);
1768 lastParmSet = SVC_DEF;
1771 initArgSetModified();
1772 syncSetNamesWithStore();
1773 setName.setSelectedItem(lastParmSet);
1775 settingDialog = false;
1779 String curSetName = null;
1781 public void itemStateChanged(ItemEvent e)
1783 if (e.getSource() == setName && e.getStateChange() == e.SELECTED)
1785 final String setname = (String) setName.getSelectedItem();
1786 System.out.println("Item state changed for " + setname
1787 + " (handling ? " + !settingDialog + ")");
1793 if (setname == null)
1797 javax.swing.SwingUtilities.invokeLater(new Runnable()
1801 doPreferenceComboStateChange(setname);
1807 private void doPreferenceComboStateChange(String setname)
1809 // user has selected a different item from combo-box
1812 String lsetname = (curSetName != null) ? curSetName : lastParmSet;
1813 if (lsetname.equals(setname))
1815 // setname was just edited - so ignore this event.
1818 settingDialog = true;
1819 System.out.println("Prompting to save " + lsetname);
1820 if (javax.swing.JOptionPane
1825 + "' is modifed, and your changes will be lost.\nReally change preset ?",
1826 "Warning: Unsaved Changes",
1827 javax.swing.JOptionPane.OK_CANCEL_OPTION) != JOptionPane.OK_OPTION)
1829 // revert the combobox to the current item
1830 settingDialog = true;
1831 setName.setSelectedItem(lsetname);
1832 settingDialog = false;
1835 // System.out.println("Saving for " + lsetname);
1836 // _storeCurrentPreset(lsetname);
1840 settingDialog = true;
1841 reInitDialog(setname);
1842 settingDialog = false;
1846 private void _renameExistingPreset(String oldName, String curSetName2)
1848 paramStore.updatePreset(oldName, curSetName2, setDescr.getText(),
1853 * store current settings as given name. You should then reset gui.
1855 * @param curSetName2
1857 private void _storeCurrentPreset(String curSetName2)
1859 paramStore.storePreset(curSetName2, setDescr.getText(), getJobParams());
1862 private void _updatePreset(String lastParmSet2, String curname)
1864 paramStore.updatePreset(lastParmSet2, curname, setDescr.getText(),
1870 * last saved name for this user preset
1872 String lastSetName = null;
1875 * last saved value of the description text for this user preset
1877 String lastDescrText = null;
1879 public void actionPerformed(ActionEvent e)
1881 if (e.getSource() instanceof Component)
1883 Component src = (Component) e.getSource();
1884 if (src.getParent() == setName)
1886 // rename any existing records we know about for this set.
1887 String newname = (String) e.getActionCommand().trim();
1889 if (isServicePreset(newname))
1891 final String oldname = curSetName!=null ? curSetName : lastParmSet;
1892 final Component ourframe=this;
1894 setName.getEditor().setItem(oldname);
1895 settingDialog=false;
1896 javax.swing.SwingUtilities.invokeLater(new Runnable() {public void run() {
1897 JOptionPane.showMessageDialog(ourframe,
1898 "Invalid name - preset already exists.", "Invalid name",
1899 JOptionPane.WARNING_MESSAGE);
1904 curSetName = newname;
1905 System.err.println("New name for user setting " + curSetName
1906 + " (was " + setName.getSelectedItem() + ")");
1907 if (curSetName.equals(setName.getSelectedItem()))
1911 if (curSetName != null)
1913 argSetModified(setName, true);
1921 private void checkDescrModified()
1928 (lastDescrText == null ? setDescr.getText().trim().length() > 0
1929 : !setDescr.getText().equals(lastDescrText)));
1934 public void insertUpdate(DocumentEvent e)
1936 checkDescrModified();
1939 public void removeUpdate(DocumentEvent e)
1941 checkDescrModified();
1944 public void changedUpdate(DocumentEvent e)
1946 checkDescrModified();
1951 * @return null or the service preset selected by the user
1953 public WsParamSetI getPreset()
1955 if (isUserPreset || isModified()
1956 || (lastParmSet != null && lastParmSet.equals(SVC_DEF)))
1962 return paramStore.getPreset(lastParmSet);