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.JTable;
53 import javax.swing.JTextArea;
54 import javax.swing.JTextField;
55 import javax.swing.ListSelectionModel;
56 import javax.swing.SwingConstants;
57 import javax.swing.SwingUtilities;
58 import javax.swing.border.TitledBorder;
59 import javax.swing.event.CellEditorListener;
60 import javax.swing.event.ChangeEvent;
61 import javax.swing.event.ChangeListener;
62 import javax.swing.event.DocumentEvent;
63 import javax.swing.event.DocumentListener;
64 import javax.swing.table.*;
66 import compbio.metadata.Argument;
67 import compbio.metadata.Option;
68 import compbio.metadata.Parameter;
69 import compbio.metadata.Preset;
70 import compbio.metadata.PresetManager;
71 import compbio.metadata.RunnerConfig;
72 import compbio.metadata.ValueConstrain;
73 import compbio.metadata.WrongParameterException;
74 import compbio.metadata.ValueConstrain.Type;
76 import jalview.util.jarInputStreamProvider;
77 import jalview.ws.jws2.JabaParamStore;
78 import jalview.ws.jws2.JabaPreset;
79 import jalview.ws.jws2.Jws2Discoverer;
80 import jalview.ws.jws2.ParameterUtils;
81 import jalview.ws.jws2.Jws2Discoverer.Jws2Instance;
82 import jalview.ws.jws2.dm.JabaOption;
83 import jalview.ws.jws2.dm.JabaParameter;
84 import jalview.ws.params.ArgumentI;
85 import jalview.ws.params.OptionI;
86 import jalview.ws.params.ParamDatastoreI;
87 import jalview.ws.params.ParameterI;
88 import jalview.ws.params.ValueConstrainI;
89 import jalview.ws.params.WsParamSetI;
92 * job parameter editing/browsing dialog box. User can browse existing settings
93 * (user + presets + Defaults), and any changes to parameters creates a modified
94 * user parameter set. LOGIC: If the parameter set is modified, and its name is
95 * a valid, non-existant user parameter set, then a save button is shown. If the
96 * parameter set is modified and its name is a valid, extant user parameter set,
97 * then an update button is shown. If user parameter set's name is edited, and
98 * old name exists as a writable user parameter set, then rename button is
99 * shown. If current parameter set is associated with a user defined parameter
100 * set, then : if set is modifed, a 'revert' button is shown. if set is not
101 * modified, a 'delete' button is shown.
106 public class WsJobParameters extends JPanel implements ItemListener,
107 ActionListener, DocumentListener
109 URL linkImageURL = getClass().getResource("/images/link.gif");
110 private static final String SVC_DEF = "Defaults"; // this is the null
111 // parameter set as shown to
114 private static final int PARAM_WIDTH = 340, PARAM_HEIGHT = 150,
115 PARAM_CLOSEDHEIGHT = 80;
117 private static final int OPTSET_HEIGHT = 30;
119 JPanel SetNamePanel = new JPanel();
121 JPanel setDetails = new JPanel();
123 JSplitPane settingsPanel = new JSplitPane();
125 JSplitPane jobPanel = new JSplitPane();
127 JPanel jobOptions = new JPanel();
129 JScrollPane jobOptionsPane = new JScrollPane();
131 JPanel jobParameters = new JPanel();
133 JButton createpref = new JButton();
135 JButton deletepref = new JButton();
137 JButton revertpref = new JButton();
139 JButton updatepref = new JButton();
141 JButton startjob = new JButton();
143 JButton canceljob = new JButton();
145 JComboBox setName = new JComboBox();
147 JTextArea setDescr = new JTextArea();
149 JScrollPane paramPane = new JScrollPane();
151 JPanel paramList = new JPanel();
153 RunnerConfig serviceOptions;
155 ParamDatastoreI paramStore;
157 WsJobParameters(Jws2Instance service)
162 public WsJobParameters(Jws2Instance service, WsParamSetI preset)
164 this(null, service, preset, null);
170 * - if null, create new JFrame outside of desktop
174 public WsJobParameters(JFrame parent, Jws2Instance service,
175 WsParamSetI preset, List<Argument> jobArgset)
177 this(parent, null, service, preset, jobArgset);
188 public WsJobParameters(JFrame parent, ParamDatastoreI paramStorei,
189 Jws2Instance service, WsParamSetI preset, List<Argument> jobArgset)
193 this.paramStore = paramStorei;
194 if (paramStore == null)
196 paramStore = service.getParamStore();
198 this.service = service;
199 // argSetModified(false);
200 // populate parameter table
201 initForService(service, preset, jobArgset);
202 // display in new JFrame attached to parent.
208 JDialog frame = null;
211 * shows a modal dialog containing the parameters.
215 public boolean showRunDialog()
218 frame = new JDialog(Desktop.instance, true);
220 frame.setTitle("Edit parameters for " + service.getActionText());
221 Rectangle deskr = Desktop.instance.getBounds();
222 frame.setBounds(new Rectangle((int) (deskr.getCenterX() - 240),
223 (int) (deskr.getCenterY() - 250), 480, 500));
224 frame.setContentPane(this);
225 // should recover defaults from user prefs.
227 settingsPanel.setDividerLocation(0.4);
228 jobPanel.setDividerLocation(0.3);
229 frame.setVisible(true);
238 protected JButton makeButton(String label, String tooltip,
239 ActionListener action)
241 JButton button = new JButton();
242 button.setText(label);
243 button.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
244 button.setForeground(Color.black);
245 button.setHorizontalAlignment(SwingConstants.CENTER);
246 button.setToolTipText(tooltip);
247 button.addActionListener(action);
251 private void jbInit()
253 updatepref = makeButton("Update", "Update the stored user preference",
257 public void actionPerformed(ActionEvent e)
259 update_actionPerformed(e);
262 deletepref = makeButton("Delete", "Delete the user preference",
266 public void actionPerformed(ActionEvent e)
268 delete_actionPerformed(e);
271 createpref = makeButton("Create", "Create a new preference",
275 public void actionPerformed(ActionEvent e)
277 create_actionPerformed(e);
280 revertpref = makeButton("Revert",
281 "Undo all changes to the current set", new ActionListener()
284 public void actionPerformed(ActionEvent e)
286 revert_actionPerformed(e);
289 startjob.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
290 startjob.setText("Start");
291 startjob.setToolTipText("Start Job");
292 startjob.addActionListener(new ActionListener()
294 public void actionPerformed(ActionEvent e)
296 startjob_actionPerformed(e);
299 canceljob.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
300 canceljob.setText("Cancel");
301 canceljob.setToolTipText("Cancel Job");
302 canceljob.addActionListener(new ActionListener()
304 public void actionPerformed(ActionEvent e)
306 canceljob_actionPerformed(e);
310 setDetails.setBorder(new TitledBorder("Details"));
311 setDetails.setLayout(new BorderLayout());
312 setDescr.setColumns(40);
313 setDescr.setWrapStyleWord(true);
314 setDescr.setLineWrap(true);
315 setDescr.setBackground(getBackground());
316 setDescr.setEditable(true);
317 setDescr.getDocument().addDocumentListener(this);
318 JScrollPane setDescrView = new JScrollPane();
319 // setDescrView.setPreferredSize(new Dimension(350, 200));
320 setDescrView.getViewport().setView(setDescr);
321 setName.setEditable(true);
322 setName.addItemListener(this);
323 setName.getEditor().addActionListener(this);
324 JPanel setNameInfo = new JPanel(new FlowLayout(FlowLayout.LEFT));
325 SetNamePanel.setLayout(new GridLayout(2, 1));
326 SetNamePanel.setMinimumSize(new Dimension(300, 40));
327 JLabel setNameLabel = new JLabel("Parameter set: ");
328 setNameLabel.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
329 // setNameLabel.setHorizontalAlignment(FlowLayout.LEFT);
330 setNameInfo.add(setNameLabel);
331 setNameInfo.add(setName);
332 // initial button visibility
333 updatepref.setVisible(false);
334 deletepref.setVisible(false);
335 revertpref.setVisible(false);
336 createpref.setVisible(false);
337 JPanel setsavebuts = new JPanel();
338 setsavebuts.setLayout(new FlowLayout(FlowLayout.LEFT)); // GridLayout(1,2));
339 ((FlowLayout) setsavebuts.getLayout()).setHgap(10);
340 ((FlowLayout) setsavebuts.getLayout()).setVgap(0);
341 setsavebuts.add(deletepref);
342 setsavebuts.add(revertpref);
343 setsavebuts.add(createpref);
344 setsavebuts.add(updatepref);
345 setsavebuts.setSize(new Dimension(150, 20));
346 JPanel buttonArea = new JPanel(new GridLayout(1, 1));
347 buttonArea.add(setsavebuts);
348 SetNamePanel.add(setNameInfo);
349 SetNamePanel.add(buttonArea);
350 setDetails.add(setDescrView, BorderLayout.CENTER);
351 // setDetails.setPreferredSize(new Dimension(360, 100));
352 jobParameters.setBorder(new TitledBorder("Parameters"));
353 jobParameters.setLayout(new BorderLayout());
354 paramPane.setPreferredSize(new Dimension(360, 300));
355 paramPane.getVerticalScrollBar().setUnitIncrement(20);
356 // paramPanel.setPreferredSize(new Dimension(360, 300));
357 // TODO: relayout buttons nicely
358 paramPane.getViewport().setView(paramList);
359 jobParameters.add(paramPane, BorderLayout.CENTER);
360 JPanel jobOptionsPanel = new JPanel();
361 jobOptionsPanel.setLayout(new BorderLayout());
362 jobOptionsPanel.setBorder(new TitledBorder("Options"));
363 jobOptionsPane.getViewport().setView(jobOptions);
364 jobOptionsPanel.add(jobOptionsPane, BorderLayout.CENTER);
365 settingsPanel.setLeftComponent(jobOptionsPanel);
366 settingsPanel.setRightComponent(jobParameters);
367 settingsPanel.setOrientation(JSplitPane.VERTICAL_SPLIT);
369 setLayout(new BorderLayout());
370 // setPreferredSize(new Dimension(400, 600));
371 // setSize(new Dimension(400, 600));
372 jobPanel.setLeftComponent(setDetails);
373 jobPanel.setRightComponent(settingsPanel);
374 jobPanel.setOrientation(JSplitPane.VERTICAL_SPLIT);
375 add(SetNamePanel, BorderLayout.NORTH);
376 add(jobPanel, BorderLayout.CENTER);
377 JPanel dialogpanel = new JPanel();
378 dialogpanel.add(startjob);
379 dialogpanel.add(canceljob);
380 add(dialogpanel, BorderLayout.SOUTH);
383 protected void revert_actionPerformed(ActionEvent e)
385 reInitDialog(lastParmSet);
389 protected void update_actionPerformed(ActionEvent e)
393 String curname = ((String) setName.getSelectedItem()).trim();
394 _updatePreset(lastParmSet, curname);
395 lastParmSet = curname;
397 initArgSetModified();
398 syncSetNamesWithStore();
402 private void _deleteUserPreset(String lastParmSet2)
404 paramStore.deletePreset(lastParmSet2);
407 protected void delete_actionPerformed(ActionEvent e)
411 // delete current preset's saved entry
412 _deleteUserPreset(lastParmSet);
414 reInitDialog(null); // service default
417 protected void create_actionPerformed(ActionEvent e)
419 String curname = ((String) setName.getSelectedItem()).trim();
420 if (curname.length() > 0)
422 _storeCurrentPreset(curname);
423 lastParmSet = curname;
425 initArgSetModified();
429 // TODO: show warning
430 System.err.println("Invalid name. Not saved.");
434 protected void canceljob_actionPerformed(ActionEvent e)
439 frame.setVisible(false);
443 protected void startjob_actionPerformed(ActionEvent e)
448 frame.setVisible(false);
452 Jws2Instance service;
455 * list of service presets in the gui
457 Hashtable servicePresets = null;
460 * set if dialog is being set - so handlers will avoid spurious events
462 boolean settingDialog = false;
464 void initForService(Jws2Instance service, WsParamSetI jabap,
465 List<Argument> jabajobArgset)
467 WsParamSetI p = null;
468 List<ArgumentI> jobArgset = null;
469 settingDialog = true;
470 { // instantiate the abstract proxy for Jaba objects
471 jobArgset = jabajobArgset == null ? null : JabaParamStore
472 .getJwsArgsfromJaba(jabajobArgset);
473 p = jabap; // (jabap != null) ? paramStore.getPreset(jabap.getName()) :
476 // TODO: Recover window geometry prefs for this service
477 // jobPanel.setDividerLocation(proportionalLocation)
478 // settingsPanel.setDividerLocation(proportionalLocation)
479 Hashtable exnames = new Hashtable();
480 for (int i = 0, iSize = setName.getItemCount(); i < iSize; i++)
482 exnames.put((String) setName.getItemAt(i), setName.getItemAt(i));
484 servicePresets = new Hashtable();
485 // Add the default entry - if not present already.
486 if (!exnames.contains(SVC_DEF))
488 setName.addItem(SVC_DEF);
489 exnames.put(SVC_DEF, SVC_DEF);
490 servicePresets.put(SVC_DEF, SVC_DEF);
492 String curname = (p == null ? "" : p.getName());
493 for (WsParamSetI pr : paramStore.getPresets())
495 if (!pr.isModifiable())
497 servicePresets.put(pr.getName(), "preset");
502 if (!exnames.contains(pr.getName()))
504 setName.addItem(pr.getName());
507 // TODO: if initial jobArgset matches a given user setting or preset then
508 // should recover setting accordingly
509 // updateTable(p, jobArgset);
512 reInitDialog(p.getName());
513 initArgSetModified();
517 if (jobArgset != null && jobArgset.size() > 0)
519 curSetName = "Supplied Settings";
520 updateTable(p, jobArgset);
528 settingDialog = false;
532 @SuppressWarnings("unchecked")
533 private void updateTable(WsParamSetI p, List<ArgumentI> jobArgset)
535 // populate table from default parameter set.
536 List<ArgumentI> args = paramStore.getServiceParameters();
538 // split to params and required arguments
540 for (ArgumentI myarg : args)
542 // Ideally, Argument would implement isRequired !
543 if (myarg instanceof ParameterI)
545 ParameterI parm = (ParameterI) myarg;
550 if (myarg instanceof OptionI)
552 OptionI opt = (OptionI) myarg;
553 addOption(opt).resetToDefault();
557 System.err.println("Ignoring unknown service argument type "
558 + myarg.getClass().getName());
562 args = null; // no more args to process.
566 isUserPreset = false;
567 // initialise setname
568 setName.setSelectedItem(lastSetName = p.getName());
569 setDescr.setText(lastDescrText = p.getDescription());
573 args = p.getArguments();
574 } catch (Exception e)
578 // TODO: check if args should be unselected prior to resetting using the
583 if (lastParmSet == null)
585 isUserPreset = false;
586 // first call - so create a dummy name
588 setName.setSelectedItem(lastSetName = SVC_DEF);
592 if (jobArgset != null)
594 argSetModified(jobArgset, true);
597 // get setargs from current object
600 for (ArgumentI arg : args)
602 if (arg instanceof ParameterI)
604 setParameter((ParameterI) arg);
608 if (arg instanceof OptionI)
610 // System.out.println("Setting option "
611 // + System.identityHashCode(arg) + ":" + arg.getName()
612 // + " with " + arg.getDefaultValue());
613 selectOption((OptionI) arg, arg.getDefaultValue());
620 jobOptions.setPreferredSize(new Dimension(PARAM_WIDTH, optSet.size()
622 jobOptions.setLayout(new GridLayout(optSet.size(), 1));
623 refreshParamLayout();
624 paramPane.validate();
628 private boolean isModified()
630 return modifiedElements.size() > 0;
633 private Hashtable modifiedElements = new Hashtable();
636 * reset gui and modification state settings
638 private void initArgSetModified()
641 modifiedElements.clear();
642 updateButtonDisplay();
645 private void updateButtonDisplay()
647 boolean _update = false, _create = false, _delete = false, _revert = false;
648 if (modifiedElements.size() > 0)
652 _update = isUserPreset; // can only update user presets
653 if (!isUserPreset || modifiedElements.containsKey(setName))
655 // name modified - can create new preset
663 // can still delete a user preset
664 _delete = isUserPreset;
666 createpref.setVisible(_create);
667 updatepref.setVisible(_update);
668 deletepref.setVisible(_delete);
669 revertpref.setVisible(_revert);
673 private void argSetModified(Object modifiedElement, boolean b)
681 modifiedElements.remove(modifiedElement);
685 if (b && modifiedElement == setName
686 && modifiedElements.contains(modifiedElement))
688 // HACK! prevents iteration on makeSetNameValid
691 modifiedElements.put(modifiedElement, modifiedElement);
693 // set mod status based on presence of elements in table
694 if (b && modifiedElements.size() > 0)
696 makeSetNameValid(!isUserPreset);
697 SetNamePanel.revalidate();
699 updateButtonDisplay();
702 private boolean isServicePreset(String selectedItem)
704 return selectedItem.equals(SVC_DEF)
705 || servicePresets.containsKey(selectedItem);
709 * check if the current set name is a valid set name for saving, if not, then
712 private void makeSetNameValid(boolean newuserset)
714 boolean stn = settingDialog;
715 boolean renamed = false;
716 settingDialog = true;
717 String nm = (curSetName != null ? curSetName : (String) setName
719 // check if the name is reserved - if it is, rename it.
720 if (isServicePreset(nm))
729 while (paramStore.getPreset(tnm) != null)
731 tnm = nm + " (" + (++i) + ")";
740 boolean makeupdate = false;
741 // sync the gui with the preset database
742 for (int i = 0, iS = setName.getItemCount(); i < iS; i++)
744 String snm = (String) setName.getItemAt(i);
748 // setName.setSelectedIndex(i);
753 setName.addItem(curSetName = nm);
754 setName.setSelectedItem(curSetName);
758 settingDialog = false; // we need this name change to be registered.
759 argSetModified(setName, renamed);
764 private void addParameter(ParameterI arg)
766 ParamBox pb = paramSet.get(arg.getName());
769 pb = new ParamBox(this, arg);
770 paramSet.put(arg.getName(), pb);
774 // take the defaults from the parameter
775 pb.updateControls(arg);
778 private void setParameter(ParameterI arg)
780 ParamBox pb = paramSet.get(arg.getName());
787 pb.updateControls(arg);
792 private void selectOption(OptionI option, String string)
794 OptionBox cb = optSet.get(option.getName());
797 cb = addOption(option);
799 cb.enabled.setSelected(string != null); // initial state for an option.
802 if (option.getPossibleValues().contains(string))
804 cb.val.setSelectedItem(string);
808 throw new Error("Invalid value " + string + " for option " + option);
812 if (option.isRequired() && !cb.enabled.isSelected())
814 // TODO: indicate paramset is not valid.. option needs to be selected!
816 cb.setInitialValue();
819 Map<String, ParamBox> paramSet = new Hashtable<String, ParamBox>();
821 public class ParamBox extends JPanel implements ChangeListener,
822 ActionListener, MouseListener
824 JButton showDesc = new JButton();
826 JTextArea string = new JTextArea();
828 JScrollPane descPanel = new JScrollPane();
830 JSlider slider = null;
832 JTextField valueField = null;
834 ValueConstrainI validator = null;
836 JPanel settingPanel = new JPanel();
838 JPanel controlPanel = new JPanel();
840 boolean integ = false;
842 boolean choice = false;
844 boolean descisvisible = false;
846 final WsJobParameters pmdialogbox;
850 public ParamBox(final WsJobParameters pmlayout, ParameterI parm)
852 pmdialogbox = pmlayout;
853 setPreferredSize(new Dimension(PARAM_WIDTH, PARAM_CLOSEDHEIGHT));
854 setBorder(new TitledBorder(parm.getName()));
856 showDesc.setFont(new Font("Verdana", Font.PLAIN, 6));
857 showDesc.setText("+");
858 string.setFont(new Font("Verdana", Font.PLAIN, 11));
859 string.setBackground(getBackground());
860 // string.setSize(new Dimension(PARAM_WIDTH, 80));
861 string.setEditable(false);
862 descPanel.getViewport().setView(string);
863 // descPanel.setLocation(2,17);
864 descPanel.setVisible(false);
865 // string.setMinimumSize(new Dimension(140,80));
866 // string.setMaximumSize(new Dimension(280,80));
867 final ParamBox me = this;
868 finfo = parm.getFurtherDetails();
871 showDesc.setToolTipText("<html><p>Click to show brief description<br><img src=\"" + linkImageURL + "\"/> Right click for further information.</p></html>");
872 showDesc.addMouseListener(this);
876 showDesc.setToolTipText("<html><p>Click to show brief description.</p></html>");
878 showDesc.addActionListener(new ActionListener()
881 public void actionPerformed(ActionEvent e)
883 descisvisible = !descisvisible;
884 descPanel.setVisible(descisvisible);
885 me.setPreferredSize(new Dimension(PARAM_WIDTH,
886 (descisvisible) ? PARAM_HEIGHT : PARAM_CLOSEDHEIGHT));
888 pmlayout.refreshParamLayout();
891 string.setWrapStyleWord(true);
892 string.setLineWrap(true);
893 string.setColumns(32);
894 string.setText(parm.getDescription());
895 JPanel firstrow = new JPanel();
896 firstrow.setLayout(null);
897 controlPanel.setLayout(new BorderLayout());
898 controlPanel.setBounds(new Rectangle(39, 10, PARAM_WIDTH - 70,
899 PARAM_CLOSEDHEIGHT - 50));
900 showDesc.setBounds(new Rectangle(10, 10, 16, 16));
901 firstrow.add(showDesc);
902 firstrow.add(controlPanel);
903 firstrow.setBounds(new Rectangle(10, 20, PARAM_WIDTH - 30,
904 PARAM_CLOSEDHEIGHT - 30));
906 validator = parm.getValidValue();
908 if (validator != null)
910 integ = validator.getType() == Type.Integer;
914 if (parameter.getPossibleValues() != null)
919 updateControls(parm);
920 descPanel.setBounds(new Rectangle(10, PARAM_CLOSEDHEIGHT,
921 PARAM_WIDTH - 20, PARAM_HEIGHT - PARAM_CLOSEDHEIGHT - 5));
928 // reset the widget's initial value.
932 boolean adjusting = false;
934 ParameterI parameter;
938 public int getBoxHeight()
940 return (descisvisible ? PARAM_HEIGHT : PARAM_CLOSEDHEIGHT);
943 public void updateControls(ParameterI parm)
946 boolean init = (choicebox == null && valueField == null);
953 choicebox = new JComboBox();
954 choicebox.addActionListener(this);
955 controlPanel.add(choicebox, BorderLayout.CENTER);
959 slider = new JSlider();
960 slider.addChangeListener(this);
961 valueField = new JTextField();
962 valueField.addActionListener(this);
963 valueField.setPreferredSize(new Dimension(60, 25));
964 controlPanel.add(slider, BorderLayout.WEST);
965 controlPanel.add(valueField, BorderLayout.EAST);
976 List vals = parm.getPossibleValues();
977 for (Object val : vals)
979 choicebox.addItem(val);
983 if (parm.getDefaultValue() != null)
985 choicebox.setSelectedItem(parm.getDefaultValue());
990 valueField.setText(parm.getDefaultValue());
993 lastVal = updateSliderFromValueField();
999 public ParameterI getParameter()
1001 ParameterI prm = parameter.copy();
1004 prm.setDefaultValue((String) choicebox.getSelectedItem());
1008 prm.setDefaultValue(valueField.getText());
1013 public Object updateSliderFromValueField()
1017 if (validator != null)
1024 valueField.setText(valueField.getText().trim());
1025 iVal = Integer.valueOf(valueField.getText());
1026 if (validator.getMin() != null
1027 && validator.getMin().intValue() > iVal)
1029 iVal = validator.getMin().intValue();
1030 // TODO: provide visual indication that hard limit was reached for
1033 if (validator.getMax() != null
1034 && validator.getMax().intValue() < iVal)
1036 iVal = validator.getMax().intValue();
1037 // TODO: provide visual indication that hard limit was reached for
1040 } catch (Exception e)
1044 if (validator.getMin() != null && validator.getMax() != null)
1046 slider.getModel().setRangeProperties(iVal, 1,
1047 validator.getMin().intValue(),
1048 validator.getMax().intValue(), true);
1052 slider.setVisible(false);
1062 fVal = Float.valueOf(valueField.getText());
1063 if (validator.getMin() != null
1064 && validator.getMin().floatValue() > fVal)
1066 fVal = validator.getMin().floatValue();
1067 // TODO: provide visual indication that hard limit was reached for
1070 if (validator.getMax() != null
1071 && validator.getMax().floatValue() < fVal)
1073 fVal = validator.getMax().floatValue();
1074 // TODO: provide visual indication that hard limit was reached for
1077 } catch (Exception e)
1081 if (validator.getMin() != null && validator.getMax() != null)
1083 slider.getModel().setRangeProperties((int) fVal * 1000, 1,
1084 (int) validator.getMin().floatValue() * 1000,
1085 (int) validator.getMax().floatValue() * 1000, true);
1089 slider.setVisible(false);
1099 slider.setVisible(false);
1101 { valueField.getText().trim() };
1106 { (String) choicebox.getSelectedItem() };
1112 public void stateChanged(ChangeEvent e)
1116 valueField.setText(""
1117 + ((integ) ? ("" + (int) slider.getValue())
1118 : ("" + (float) (slider.getValue() / 1000f))));
1124 public void actionPerformed(ActionEvent e)
1132 updateSliderFromValueField();
1137 private void checkIfModified()
1139 Object cstate = updateSliderFromValueField();
1140 boolean notmod = false;
1141 if (cstate.getClass() == lastVal.getClass())
1143 if (cstate instanceof int[])
1145 notmod = (((int[]) cstate)[0] == ((int[]) lastVal)[0]);
1147 else if (cstate instanceof float[])
1149 notmod = (((float[]) cstate)[0] == ((float[]) lastVal)[0]);
1151 else if (cstate instanceof String[])
1153 notmod = (((String[]) cstate)[0].equals(((String[]) lastVal)[0]));
1156 pmdialogbox.argSetModified(this, !notmod);
1159 public void mouseClicked(MouseEvent e)
1161 if (javax.swing.SwingUtilities.isRightMouseButton(e))
1163 showUrlPopUp(this, finfo.toString(), e.getX(), e.getY());
1167 public void mousePressed(MouseEvent e)
1169 // TODO Auto-generated method stub
1173 public void mouseReleased(MouseEvent e)
1175 // TODO Auto-generated method stub
1179 public void mouseEntered(MouseEvent e)
1181 // TODO Auto-generated method stub
1185 public void mouseExited(MouseEvent e)
1187 // TODO Auto-generated method stub
1193 Map<String, OptionBox> optSet = new Hashtable<String, OptionBox>();
1195 public class OptionBox extends JPanel implements MouseListener,
1198 JComboBox val = new JComboBox();
1200 JCheckBox enabled = new JCheckBox();
1202 JLabel optlabel = new JLabel();
1206 boolean hasLink = false;
1210 public OptionBox(OptionI opt)
1213 setLayout(new BorderLayout());
1214 enabled.setSelected(opt.isRequired()); // TODO: lock required options
1215 enabled.setFont(new Font("Verdana", Font.PLAIN, 11));
1216 enabled.setText("");
1217 enabled.setText(opt.getName());
1218 enabled.addActionListener(this);
1219 finfo = option.getFurtherDetails();
1223 // optlabel.setToolTipText("<html><p>"+opt.getDescription()+"</p><img src=\""+linkImageURL+"\"/></html>");
1224 enabled.setToolTipText("<html><p>" + opt.getDescription()
1225 + "</p><img src=\"" + linkImageURL + "\"/></html>");
1226 // optlabel.addMouseListener(this);
1227 enabled.addMouseListener(this);
1231 // optlabel.setToolTipText(opt.getDescription());
1232 enabled.setToolTipText(opt.getDescription());
1234 add(enabled, BorderLayout.NORTH);
1235 if (opt.getPossibleValues().size() > 1)
1237 setLayout(new GridLayout(1, 2));
1238 for (Object str : opt.getPossibleValues())
1240 val.addItem((String) str);
1242 val.setSelectedItem((String) opt.getDefaultValue());
1243 val.addActionListener(this);
1244 add(val, BorderLayout.SOUTH);
1246 // TODO: add actionListeners for popup (to open further info),
1247 // and to update list of parameters if an option is enabled
1248 // that takes a value.
1252 public void resetToDefault()
1254 enabled.setSelected(false);
1255 if (option.isRequired())
1257 // Apply default value
1258 selectOption(option, option.getDefaultValue());
1262 boolean initEnabled = false;
1264 String initVal = null;
1266 public void setInitialValue()
1268 initEnabled = enabled.isSelected();
1269 if (option.getPossibleValues() != null
1270 && option.getPossibleValues().size() > 1)
1272 initVal = (String) val.getSelectedItem();
1276 initVal = (initEnabled) ? option.getDefaultValue() : null;
1280 public OptionI getOptionIfEnabled()
1282 if (!enabled.isSelected())
1286 OptionI opt = option.copy();
1288 if (val.getSelectedItem() != null)
1290 opt.setDefaultValue((String) val.getSelectedItem());
1295 public void actionPerformed(ActionEvent e)
1297 if (e.getSource() != enabled)
1299 enabled.setSelected(true);
1304 private void checkIfModified()
1306 boolean notmod = (initEnabled == enabled.isSelected());
1307 if (enabled.isSelected())
1309 if (initVal != null)
1311 notmod &= initVal.equals(val.getSelectedItem());
1315 // compare against default service setting
1316 notmod &= option.getDefaultValue() == null
1317 || option.getDefaultValue().equals(val.getSelectedItem());
1322 notmod &= initVal == null;
1324 argSetModified(this, !notmod);
1327 public void mouseClicked(MouseEvent e)
1329 if (javax.swing.SwingUtilities.isRightMouseButton(e))
1331 showUrlPopUp(this, finfo.toString(), e.getX(), e.getY());
1335 public void mousePressed(MouseEvent e)
1337 // TODO Auto-generated method stub
1341 public void mouseReleased(MouseEvent e)
1343 // TODO Auto-generated method stub
1347 public void mouseEntered(MouseEvent e)
1349 // TODO Auto-generated method stub
1353 public void mouseExited(MouseEvent e)
1355 // TODO Auto-generated method stub
1361 private OptionBox addOption(OptionI opt)
1363 OptionBox cb = optSet.get(opt.getName());
1366 cb = new OptionBox(opt);
1367 optSet.put(opt.getName(), cb);
1373 public static void showUrlPopUp(JComponent invoker, final String finfo,
1377 JPopupMenu mnu = new JPopupMenu();
1378 JMenuItem mitem = new JMenuItem("View " + finfo);
1379 mitem.addActionListener(new ActionListener()
1383 public void actionPerformed(ActionEvent e)
1385 Desktop.showUrl(finfo);
1390 mnu.show(invoker, x, y);
1393 protected void refreshParamLayout()
1395 FlowLayout fl = new FlowLayout();
1396 paramList.setLayout(fl);
1397 int s = 2 * fl.getVgap();
1398 for (ParamBox pbox : paramSet.values())
1400 s += fl.getVgap() + pbox.getBoxHeight(); // getBoxHeight();
1402 paramList.setPreferredSize(new Dimension(PARAM_WIDTH, s));
1407 * testing method - grab a service and parameter set and show the window
1411 public static void main(String[] args)
1413 jalview.ws.jws2.Jws2Discoverer disc = jalview.ws.jws2.Jws2Discoverer
1416 if (args.length > 3)
1418 Vector<String> services = new Vector<String>();
1419 services.addElement(args[p++]);
1420 Jws2Discoverer.setServiceUrls(services);
1425 } catch (Exception e)
1427 System.err.println("Aborting. Problem discovering services.");
1428 e.printStackTrace();
1431 Jws2Discoverer.Jws2Instance lastserv = null;
1432 for (Jws2Discoverer.Jws2Instance service : disc.getServices())
1435 if (p >= args.length || service.serviceType.equalsIgnoreCase(args[p]))
1437 if (lastserv != null)
1439 List<Preset> prl = null;
1441 if (++p < args.length)
1443 PresetManager prman = lastserv.getPresets();
1446 pr = prman.getPresetByName(args[p]);
1449 // just grab the last preset.
1450 prl = prman.getPresets();
1456 PresetManager prman = lastserv.getPresets();
1459 prl = prman.getPresets();
1462 Iterator<Preset> en = (prl == null) ? null : prl.iterator();
1463 while (en != null && en.hasNext())
1469 en = prl.iterator();
1474 System.out.println("Testing opts dupes for "
1475 + lastserv.getUri() + " : "
1476 + lastserv.getActionText() + ":" + pr.getName());
1477 List<Option> rg = lastserv.getRunnerConfig().getOptions();
1482 Option cpy = jalview.ws.jws2.ParameterUtils.copyOption(o);
1483 } catch (Exception e)
1485 System.err.println("Failed to copy " + o.getName());
1486 e.printStackTrace();
1489 System.err.println("Failed to copy " + o.getName());
1490 e.printStackTrace();
1495 System.out.println("Testing param dupes:");
1496 List<Parameter> rg = lastserv.getRunnerConfig()
1498 for (Parameter o : rg)
1502 Parameter cpy = jalview.ws.jws2.ParameterUtils
1504 } catch (Exception e)
1506 System.err.println("Failed to copy " + o.getName());
1507 e.printStackTrace();
1510 System.err.println("Failed to copy " + o.getName());
1511 e.printStackTrace();
1516 System.out.println("Testing param write:");
1517 List<String> writeparam = null, readparam = null;
1520 writeparam = jalview.ws.jws2.ParameterUtils
1522 pr.getArguments(lastserv.getRunnerConfig()),
1524 System.out.println("Testing param read :");
1525 List<Option> pset = jalview.ws.jws2.ParameterUtils
1526 .processParameters(writeparam,
1527 lastserv.getRunnerConfig(), " ");
1528 readparam = jalview.ws.jws2.ParameterUtils
1529 .writeParameterSet(pset, " ");
1530 Iterator<String> o = pr.getOptions().iterator(), s = writeparam
1531 .iterator(), t = readparam.iterator();
1532 boolean failed = false;
1533 while (s.hasNext() && t.hasNext())
1535 String on = o.next(), sn = s.next(), st = t.next();
1538 System.out.println("Original was " + on
1539 + " Phase 1 wrote " + sn + "\tPhase 2 wrote "
1546 System.out.println("Original parameters:\n"
1548 System.out.println("Wrote parameters in first set:\n"
1550 System.out.println("Wrote parameters in second set:\n"
1554 } catch (Exception e)
1556 e.printStackTrace();
1559 WsJobParameters pgui = new WsJobParameters(lastserv,
1560 new JabaPreset(lastserv, pr));
1561 JFrame jf = new JFrame("Parameters for "
1562 + lastserv.getActionText());
1563 JPanel cont = new JPanel();
1564 // jf.setPreferredSize(new Dimension(600, 800));
1567 final Thread thr = Thread.currentThread();
1568 jf.addWindowListener(new WindowListener()
1571 public void windowActivated(WindowEvent e)
1573 // TODO Auto-generated method stub
1577 public void windowClosed(WindowEvent e)
1581 public void windowClosing(WindowEvent e)
1587 public void windowDeactivated(WindowEvent e)
1589 // TODO Auto-generated method stub
1593 public void windowDeiconified(WindowEvent e)
1595 // TODO Auto-generated method stub
1599 public void windowIconified(WindowEvent e)
1601 // TODO Auto-generated method stub
1605 public void windowOpened(WindowEvent e)
1607 // TODO Auto-generated method stub
1612 jf.setVisible(true);
1613 boolean inter = false;
1618 Thread.sleep(10000);
1619 } catch (Exception e)
1632 public List<ArgumentI> getJobParams()
1634 List<ArgumentI> argSet = new ArrayList<ArgumentI>();
1635 // recover options and parameters from GUI
1636 for (OptionBox opts : optSet.values())
1638 OptionI opt = opts.getOptionIfEnabled();
1644 for (ParamBox parambox : paramSet.values())
1646 ParameterI parm = parambox.getParameter();
1656 String lastParmSet = null;
1659 * Hashtable<String, Object[]> editedParams = new Hashtable<String,
1662 * store the given parameters in the user parameter set database.
1664 * @param storeSetName - lastParmSet
1666 * @param descr - setDescr.getText()
1668 * @param jobParams - getJobParams()
1670 * private void _storeUserPreset(String storeSetName, String descr,
1671 * List<ArgumentI> jobParams) { // this is a simple hash store. Object[] pset;
1672 * editedParams.put(storeSetName, pset = new Object[3]); pset[0] =
1673 * storeSetName; pset[1] = descr; pset[2] = jobParams; // writeParam("Saving "
1674 * + storeSetName + ": ", jobParams); }
1676 * private void writeParam(String nm, List<ArgumentI> params) { for (ArgumentI
1677 * p : params) { System.out.println(nm + ":" + System.identityHashCode(p) +
1678 * " Name: " + p.getName() + " Value: " + p.getDefaultValue()); } }
1680 * private Object[] _getUserPreset(String setName) { Object[] pset =
1681 * editedParams.get(setName); // if (pset != null) // writeParam("Retrieving "
1682 * + setName + ": ", (List<Argument>) pset[2]); return pset; }
1684 * * remove the given user preset from the preset stash
1688 * private void _deleteUserPreset(String setName) {
1689 * editedParams.remove(setName); }
1692 private void syncSetNamesWithStore()
1695 // remove any set names in the drop down menu that aren't either a reserved
1696 // setting, or a user defined or service preset.
1697 Vector items = new Vector();
1698 while (n < setName.getItemCount())
1700 String item = (String) setName.getItemAt(n);
1701 if (!item.equals(SVC_DEF) && !paramStore.presetExists(item))
1703 setName.removeItemAt(n);
1707 items.addElement(item);
1711 if (!items.contains(SVC_DEF))
1713 setName.addItem(SVC_DEF);
1715 for (WsParamSetI upn : paramStore.getPresets())
1717 if (!items.contains(upn.getName()))
1719 setName.addItem(upn.getName());
1725 * true if lastParmSet is a user preset
1727 boolean isUserPreset = false;
1729 private void reInitDialog(String nextPreset)
1731 settingDialog = true;
1732 // updateTable(null,null); // first reset to defaults
1733 WsParamSetI pset = null;
1734 if (nextPreset != null && nextPreset.length() > 0)
1736 pset = paramStore.getPreset(nextPreset);
1740 if (pset.isModifiable())
1742 isUserPreset = true;
1743 setDescr.setText(pset.getDescription());
1744 updateTable(null, pset.getArguments());
1745 lastParmSet = nextPreset;
1749 isUserPreset = false;
1750 setDescr.setText("");
1751 // must be a default preset from service
1752 updateTable(pset, null);
1753 lastParmSet = nextPreset;
1758 isUserPreset = false;
1760 updateTable(null, null);
1761 lastParmSet = SVC_DEF;
1764 initArgSetModified();
1765 syncSetNamesWithStore();
1766 setName.setSelectedItem(lastParmSet);
1768 settingDialog = false;
1772 String curSetName = null;
1774 public void itemStateChanged(ItemEvent e)
1776 if (e.getSource() == setName && e.getStateChange() == e.SELECTED)
1778 final String setname = (String) setName.getSelectedItem();
1779 System.out.println("Item state changed for " + setname
1780 + " (handling ? " + !settingDialog + ")");
1786 if (setname == null)
1790 javax.swing.SwingUtilities.invokeLater(new Runnable()
1794 doPreferenceComboStateChange(setname);
1800 private void doPreferenceComboStateChange(String setname)
1802 // user has selected a different item from combo-box
1805 String lsetname = (curSetName != null) ? curSetName : lastParmSet;
1806 if (lsetname.equals(setname))
1808 // setname was just edited - so ignore this event.
1811 settingDialog = true;
1812 System.out.println("Prompting to save " + lsetname);
1813 if (javax.swing.JOptionPane
1818 + "' is modifed, and your changes will be lost.\nReally change preset ?",
1819 "Warning: Unsaved Changes",
1820 javax.swing.JOptionPane.OK_CANCEL_OPTION) != JOptionPane.OK_OPTION)
1822 // revert the combobox to the current item
1823 settingDialog = true;
1824 setName.setSelectedItem(lsetname);
1825 settingDialog = false;
1828 // System.out.println("Saving for " + lsetname);
1829 // _storeCurrentPreset(lsetname);
1833 settingDialog = true;
1834 reInitDialog(setname);
1835 settingDialog = false;
1839 private void _renameExistingPreset(String oldName, String curSetName2)
1841 paramStore.updatePreset(oldName, curSetName2, setDescr.getText(),
1846 * store current settings as given name. You should then reset gui.
1848 * @param curSetName2
1850 private void _storeCurrentPreset(String curSetName2)
1852 paramStore.storePreset(curSetName2, setDescr.getText(), getJobParams());
1855 private void _updatePreset(String lastParmSet2, String curname)
1857 paramStore.updatePreset(lastParmSet2, curname, setDescr.getText(),
1863 * last saved name for this user preset
1865 String lastSetName = null;
1868 * last saved value of the description text for this user preset
1870 String lastDescrText = null;
1872 public void actionPerformed(ActionEvent e)
1874 if (e.getSource() instanceof Component)
1876 Component src = (Component) e.getSource();
1877 if (src.getParent() == setName)
1879 // rename any existing records we know about for this set.
1880 String newname = (String) e.getActionCommand().trim();
1882 if (isServicePreset(newname))
1884 final String oldname = curSetName!=null ? curSetName : lastParmSet;
1885 final Component ourframe=this;
1887 setName.getEditor().setItem(oldname);
1888 settingDialog=false;
1889 javax.swing.SwingUtilities.invokeLater(new Runnable() {public void run() {
1890 JOptionPane.showMessageDialog(ourframe,
1891 "Invalid name - preset already exists.", "Invalid name",
1892 JOptionPane.WARNING_MESSAGE);
1897 curSetName = newname;
1898 System.err.println("New name for user setting " + curSetName
1899 + " (was " + setName.getSelectedItem() + ")");
1900 if (curSetName.equals(setName.getSelectedItem()))
1904 if (curSetName != null)
1906 argSetModified(setName, true);
1914 private void checkDescrModified()
1921 (lastDescrText == null ? setDescr.getText().trim().length() > 0
1922 : !setDescr.getText().equals(lastDescrText)));
1927 public void insertUpdate(DocumentEvent e)
1929 checkDescrModified();
1932 public void removeUpdate(DocumentEvent e)
1934 checkDescrModified();
1937 public void changedUpdate(DocumentEvent e)
1939 checkDescrModified();
1944 * @return null or the service preset selected by the user
1946 public WsParamSetI getPreset()
1948 if (isUserPreset || isModified()
1949 || (lastParmSet != null && lastParmSet.equals(SVC_DEF)))
1955 return paramStore.getPreset(lastParmSet);