src/jalview/gui/OptsAndParamsPage.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.gui;
  22
  23 import jalview.util.MessageManager;
  24 import jalview.ws.params.ArgumentI;
  25 import jalview.ws.params.OptionI;
  26 import jalview.ws.params.ParameterI;
  27 import jalview.ws.params.ValueConstrainI;
  28 import jalview.ws.params.ValueConstrainI.ValueType;
  29
  30 import java.awt.BorderLayout;
  31 import java.awt.Component;
  32 import java.awt.Dimension;
  33 import java.awt.Font;
  34 import java.awt.GridLayout;
  35 import java.awt.Rectangle;
  36 import java.awt.event.ActionEvent;
  37 import java.awt.event.ActionListener;
  38 import java.awt.event.KeyEvent;
  39 import java.awt.event.KeyListener;
  40 import java.awt.event.MouseEvent;
  41 import java.awt.event.MouseListener;
  42 import java.net.URL;
  43 import java.util.ArrayList;
  44 import java.util.List;
  45 import java.util.Map;
  46
  47 import javax.swing.JButton;
  48 import javax.swing.JCheckBox;
  49 import javax.swing.JComboBox;
  50 import javax.swing.JComponent;
  51 import javax.swing.JLabel;
  52 import javax.swing.JMenuItem;
  53 import javax.swing.JPanel;
  54 import javax.swing.JPopupMenu;
  55 import javax.swing.JScrollPane;
  56 import javax.swing.JTextArea;
  57 import javax.swing.JTextField;
  58 import javax.swing.border.TitledBorder;
  59 import javax.swing.event.ChangeEvent;
  60 import javax.swing.event.ChangeListener;
  61
  62 import net.miginfocom.swing.MigLayout;
  63
  64 /**
  65  * GUI generator/manager for options and parameters. Originally abstracted from
  66  * the WsJobParameters dialog box.
  67  *
  68  * @author jprocter
  69  *
  70  */
  71 public class OptsAndParamsPage
  72 {
  73   /**
  74    * compact or verbose style parameters
  75    */
  76   boolean compact = false;
  77
  78   public class OptionBox extends JPanel
  79           implements MouseListener, ActionListener
  80   {
  81     JCheckBox enabled = new JCheckBox();
  82
  83     final URL finfo;
  84
  85     boolean hasLink = false;
  86
  87     boolean initEnabled = false;
  88
  89     String initVal = null;
  90
  91     OptionI option;
  92
  93     JLabel optlabel = new JLabel();
  94
  95     JComboBox val = new JComboBox();
  96
  97     public OptionBox(OptionI opt)
  98     {
  99       option = opt;
 100       setLayout(new BorderLayout());
 101       enabled.setSelected(opt.isRequired()); // TODO: lock required options
 102       enabled.setFont(new Font("Verdana", Font.PLAIN, 11));
 103       enabled.setText("");
 104       enabled.setText(opt.getName());
 105       enabled.addActionListener(this);
 106       finfo = option.getFurtherDetails();
 107       String desc = opt.getDescription();
 108       if (finfo != null)
 109       {
 110         hasLink = true;
 111
 112         enabled.setToolTipText(JvSwingUtils.wrapTooltip(true,
 113                 ((desc == null || desc.trim().length() == 0)
 114                         ? MessageManager.getString(
 115                                 "label.opt_and_params_further_details")
 116                         : desc) + "<br><img src=\"" + linkImageURL
 117                         + "\"/>"));
 118         enabled.addMouseListener(this);
 119       }
 120       else
 121       {
 122         if (desc != null && desc.trim().length() > 0)
 123         {
 124           enabled.setToolTipText(
 125                   JvSwingUtils.wrapTooltip(true, opt.getDescription()));
 126         }
 127       }
 128       add(enabled, BorderLayout.NORTH);
 129       for (Object str : opt.getPossibleValues())
 130       {
 131         val.addItem(str);
 132       }
 133       val.setSelectedItem(opt.getValue());
 134       if (opt.getPossibleValues().size() > 1)
 135       {
 136         setLayout(new GridLayout(1, 2));
 137         val.addActionListener(this);
 138         add(val, BorderLayout.SOUTH);
 139       }
 140       // TODO: add actionListeners for popup (to open further info),
 141       // and to update list of parameters if an option is enabled
 142       // that takes a value. JBPNote: is this TODO still valid ?
 143       setInitialValue();
 144     }
 145
 146     @Override
 147     public void actionPerformed(ActionEvent e)
 148     {
 149       if (e.getSource() != enabled)
 150       {
 151         enabled.setSelected(true);
 152       }
 153       checkIfModified();
 154     }
 155
 156     private void checkIfModified()
 157     {
 158       boolean notmod = (initEnabled == enabled.isSelected());
 159       if (enabled.isSelected())
 160       {
 161         if (initVal != null)
 162         {
 163           notmod &= initVal.equals(val.getSelectedItem());
 164         }
 165         else
 166         {
 167           // compare against default service setting
 168           notmod &= option.getValue() == null
 169                   || option.getValue().equals(val.getSelectedItem());
 170         }
 171       }
 172       else
 173       {
 174         notmod &= (initVal != null) ? initVal.equals(val.getSelectedItem())
 175                 : val.getSelectedItem() != initVal;
 176       }
 177       poparent.argSetModified(this, !notmod);
 178     }
 179
 180     public OptionI getOptionIfEnabled()
 181     {
 182       if (!enabled.isSelected())
 183       {
 184         return null;
 185       }
 186       OptionI opt = option.copy();
 187       if (opt.getPossibleValues() != null
 188               && opt.getPossibleValues().size() == 1)
 189       {
 190         // Hack to make sure the default value for an enabled option with only
 191         // one value is actually returned
 192         opt.setValue(opt.getPossibleValues().get(0));
 193       }
 194       if (val.getSelectedItem() != null)
 195       {
 196         opt.setValue((String) val.getSelectedItem());
 197       }
 198       else
 199       {
 200         if (option.getValue() != null)
 201         {
 202           opt.setValue(option.getValue());
 203         }
 204       }
 205       return opt;
 206     }
 207
 208     @Override
 209     public void mouseClicked(MouseEvent e)
 210     {
 211       if (e.isPopupTrigger()) // for Windows
 212       {
 213         showUrlPopUp(this, finfo.toString(), e.getX(), e.getY());
 214       }
 215     }
 216
 217     @Override
 218     public void mouseEntered(MouseEvent e)
 219     {
 220       // TODO Auto-generated method stub
 221
 222     }
 223
 224     @Override
 225     public void mouseExited(MouseEvent e)
 226     {
 227       // TODO Auto-generated method stub
 228
 229     }
 230
 231     @Override
 232     public void mousePressed(MouseEvent e)
 233     {
 234       if (e.isPopupTrigger()) // Mac
 235       {
 236         showUrlPopUp(this, finfo.toString(), e.getX(), e.getY());
 237       }
 238     }
 239
 240     @Override
 241     public void mouseReleased(MouseEvent e)
 242     {
 243     }
 244
 245     public void resetToDefault(boolean setDefaultParams)
 246     {
 247       enabled.setSelected(false);
 248       if (option.isRequired()
 249               || (setDefaultParams && option.getValue() != null))
 250       {
 251         // Apply default value
 252         selectOption(option, option.getValue());
 253       }
 254     }
 255
 256     public void setInitialValue()
 257     {
 258       initEnabled = enabled.isSelected();
 259       if (option.getPossibleValues() != null
 260               && option.getPossibleValues().size() > 1)
 261       {
 262         initVal = (String) val.getSelectedItem();
 263       }
 264       else
 265       {
 266         initVal = (initEnabled) ? (String) val.getSelectedItem() : null;
 267       }
 268     }
 269
 270   }
 271
 272   public class ParamBox extends JPanel
 273           implements ChangeListener, ActionListener, MouseListener
 274   {
 275     boolean adjusting = false;
 276
 277     boolean choice = false;
 278
 279     JComboBox<String> choicebox;
 280
 281     JPanel controlPanel = new JPanel();
 282
 283     boolean descisvisible = false;
 284
 285     JScrollPane descPanel = new JScrollPane();
 286
 287     final URL finfo;
 288
 289     boolean integ = false;
 290
 291     Object lastVal;
 292
 293     ParameterI parameter;
 294
 295     final OptsParametersContainerI pmdialogbox;
 296
 297     JPanel settingPanel = new JPanel();
 298
 299     JButton showDesc = new JButton();
 300
 301     Slider slider = null;
 302
 303     JTextArea string = new JTextArea();
 304
 305     ValueConstrainI validator = null;
 306
 307     JTextField valueField = null;
 308
 309     public ParamBox(final OptsParametersContainerI pmlayout,
 310             ParameterI parm)
 311     {
 312       pmdialogbox = pmlayout;
 313       finfo = parm.getFurtherDetails();
 314       validator = parm.getValidValue();
 315       parameter = parm;
 316       if (validator != null)
 317       {
 318         integ = validator.getType() == ValueType.Integer;
 319       }
 320       else
 321       {
 322         if (parameter.getPossibleValues() != null)
 323         {
 324           choice = true;
 325         }
 326       }
 327
 328       if (!compact)
 329       {
 330         makeExpanderParam(parm);
 331       }
 332       else
 333       {
 334         makeCompactParam(parm);
 335
 336       }
 337     }
 338
 339     private void makeCompactParam(ParameterI parm)
 340     {
 341       setLayout(new MigLayout("", "[][grow]"));
 342
 343       String ttipText = null;
 344
 345       controlPanel.setLayout(new BorderLayout());
 346
 347       if (parm.getDescription() != null
 348               && parm.getDescription().trim().length() > 0)
 349       {
 350         // Only create description boxes if there actually is a description.
 351         ttipText = (JvSwingUtils.wrapTooltip(true,
 352                 parm.getDescription() + (finfo != null ? "<br><img src=\""
 353                         + linkImageURL + "\"/>"
 354                         + MessageManager.getString(
 355                                 "label.opt_and_params_further_details")
 356                         : "")));
 357       }
 358
 359       JvSwingUtils.mgAddtoLayout(this, ttipText, new JLabel(parm.getName()),
 360               controlPanel, "");
 361       updateControls(parm);
 362       validate();
 363     }
 364
 365     private void makeExpanderParam(final ParameterI parm)
 366     {
 367       setPreferredSize(new Dimension(PARAM_WIDTH, PARAM_CLOSEDHEIGHT));
 368       setBorder(new TitledBorder(parm.getName()));
 369       setLayout(null);
 370       showDesc.setFont(new Font("Verdana", Font.PLAIN, 6));
 371       showDesc.setText("+");
 372       string.setFont(new Font("Verdana", Font.PLAIN, 11));
 373       string.setBackground(getBackground());
 374
 375       string.setEditable(false);
 376       descPanel.getViewport().setView(string);
 377
 378       descPanel.setVisible(false);
 379
 380       JPanel firstrow = new JPanel();
 381       firstrow.setLayout(null);
 382       controlPanel.setLayout(new BorderLayout());
 383       controlPanel.setBounds(new Rectangle(39, 10, PARAM_WIDTH - 70,
 384               PARAM_CLOSEDHEIGHT - 50));
 385       firstrow.add(controlPanel);
 386       firstrow.setBounds(new Rectangle(10, 20, PARAM_WIDTH - 30,
 387               PARAM_CLOSEDHEIGHT - 30));
 388
 389       final ParamBox me = this;
 390
 391       if (parm.getDescription() != null
 392               && parm.getDescription().trim().length() > 0)
 393       {
 394         // Only create description boxes if there actually is a description.
 395         if (finfo != null)
 396         {
 397           showDesc.setToolTipText(JvSwingUtils.wrapTooltip(true,
 398                   MessageManager.formatMessage(
 399                           "label.opt_and_params_show_brief_desc_image_link",
 400                           new String[]
 401                           { linkImageURL.toExternalForm() })));
 402           showDesc.addMouseListener(this);
 403         }
 404         else
 405         {
 406           showDesc.setToolTipText(
 407                   JvSwingUtils.wrapTooltip(true, MessageManager.getString(
 408                           "label.opt_and_params_show_brief_desc")));
 409         }
 410         showDesc.addActionListener(new ActionListener()
 411         {
 412
 413           @Override
 414           public void actionPerformed(ActionEvent e)
 415           {
 416             descisvisible = !descisvisible;
 417             descPanel.setVisible(descisvisible);
 418             descPanel.getVerticalScrollBar().setValue(0);
 419             me.setPreferredSize(new Dimension(PARAM_WIDTH,
 420                     (descisvisible) ? PARAM_HEIGHT : PARAM_CLOSEDHEIGHT));
 421             me.validate();
 422             pmdialogbox.refreshParamLayout();
 423           }
 424         });
 425         string.setWrapStyleWord(true);
 426         string.setLineWrap(true);
 427         string.setColumns(32);
 428         string.setText(parm.getDescription());
 429         showDesc.setBounds(new Rectangle(10, 10, 16, 16));
 430         firstrow.add(showDesc);
 431       }
 432       add(firstrow);
 433       validator = parm.getValidValue();
 434       parameter = parm;
 435       if (validator != null)
 436       {
 437         integ = validator.getType() == ValueType.Integer;
 438       }
 439       else
 440       {
 441         if (parameter.getPossibleValues() != null)
 442         {
 443           choice = true;
 444         }
 445       }
 446       updateControls(parm);
 447       descPanel.setBounds(new Rectangle(10, PARAM_CLOSEDHEIGHT,
 448               PARAM_WIDTH - 20, PARAM_HEIGHT - PARAM_CLOSEDHEIGHT - 5));
 449       add(descPanel);
 450       validate();
 451     }
 452
 453     /**
 454      * Action on input in text field
 455      */
 456     @Override
 457     public void actionPerformed(ActionEvent e)
 458     {
 459       if (adjusting)
 460       {
 461         return;
 462       }
 463       if (!choice)
 464       {
 465         updateSliderFromValueField();
 466       }
 467       checkIfModified();
 468     }
 469
 470     private void checkIfModified()
 471     {
 472       Object cstate = getCurrentValue();
 473       boolean modified = !cstate.equals(lastVal);
 474       pmdialogbox.argSetModified(this, modified);
 475     }
 476
 477     /**
 478      * Answers the current value of the parameter, as text
 479      *
 480      * @return
 481      */
 482     private Object getCurrentValue()
 483     {
 484       return choice ? choicebox.getSelectedItem() : valueField.getText();
 485     }
 486
 487     @Override
 488     public int getBaseline(int width, int height)
 489     {
 490       return 0;
 491     }
 492
 493     // from
 494     // http://stackoverflow.com/questions/2743177/top-alignment-for-flowlayout
 495     // helpful hint of using the Java 1.6 alignBaseLine property of FlowLayout
 496     @Override
 497     public Component.BaselineResizeBehavior getBaselineResizeBehavior()
 498     {
 499       return Component.BaselineResizeBehavior.CONSTANT_ASCENT;
 500     }
 501
 502     public int getBoxHeight()
 503     {
 504       return (descisvisible ? PARAM_HEIGHT : PARAM_CLOSEDHEIGHT);
 505     }
 506
 507     public ParameterI getParameter()
 508     {
 509       ParameterI prm = parameter.copy();
 510       if (choice)
 511       {
 512         prm.setValue((String) choicebox.getSelectedItem());
 513       }
 514       else
 515       {
 516         prm.setValue(valueField.getText());
 517       }
 518       return prm;
 519     }
 520
 521     public void init()
 522     {
 523       // reset the widget's initial value.
 524       lastVal = null;
 525     }
 526
 527     @Override
 528     public void mouseClicked(MouseEvent e)
 529     {
 530       if (e.isPopupTrigger()) // for Windows
 531       {
 532         showUrlPopUp(this, finfo.toString(), e.getX(), e.getY());
 533       }
 534     }
 535
 536     @Override
 537     public void mouseEntered(MouseEvent e)
 538     {
 539       // TODO Auto-generated method stub
 540
 541     }
 542
 543     @Override
 544     public void mouseExited(MouseEvent e)
 545     {
 546       // TODO Auto-generated method stub
 547
 548     }
 549
 550     @Override
 551     public void mousePressed(MouseEvent e)
 552     {
 553       if (e.isPopupTrigger()) // for Mac
 554       {
 555         showUrlPopUp(this, finfo.toString(), e.getX(), e.getY());
 556       }
 557     }
 558
 559     @Override
 560     public void mouseReleased(MouseEvent e)
 561     {
 562       // TODO Auto-generated method stub
 563
 564     }
 565
 566     /**
 567      * Action on change of slider value
 568      */
 569     @Override
 570     public void stateChanged(ChangeEvent e)
 571     {
 572       if (!adjusting)
 573       {
 574         float value = slider.getSliderValue();
 575         valueField.setText(
 576                 integ ? Integer.toString((int) value)
 577                         : Float.toString(value));
 578         checkIfModified();
 579       }
 580     }
 581
 582     public void updateControls(ParameterI parm)
 583     {
 584       adjusting = true;
 585       boolean init = (choicebox == null && valueField == null);
 586       if (init)
 587       {
 588         if (choice)
 589         {
 590           choicebox = new JComboBox();
 591           choicebox.addActionListener(this);
 592           controlPanel.add(choicebox, BorderLayout.CENTER);
 593         }
 594         else
 595         {
 596           valueField = new JTextField();
 597           valueField.addActionListener(this);
 598           valueField.addKeyListener(new KeyListener()
 599           {
 600
 601             @Override
 602             public void keyTyped(KeyEvent e)
 603             {
 604             }
 605
 606             @Override
 607             public void keyReleased(KeyEvent e)
 608             {
 609               if (e.isActionKey())
 610               {
 611                 if (valueField.getText().trim().length() > 0)
 612                 {
 613                   actionPerformed(null);
 614                 }
 615               }
 616             }
 617
 618             @Override
 619             public void keyPressed(KeyEvent e)
 620             {
 621             }
 622           });
 623           valueField.setPreferredSize(new Dimension(60, 25));
 624           slider = makeSlider(parm.getValidValue());
 625           slider.addChangeListener(this);
 626
 627           controlPanel.add(slider, BorderLayout.WEST);
 628           controlPanel.add(valueField, BorderLayout.EAST);
 629         }
 630       }
 631
 632       if (parm != null)
 633       {
 634         if (choice)
 635         {
 636           if (init)
 637           {
 638             List<String> vals = parm.getPossibleValues();
 639             for (String val : vals)
 640             {
 641               choicebox.addItem(val);
 642             }
 643           }
 644
 645           if (parm.getValue() != null)
 646           {
 647             choicebox.setSelectedItem(parm.getValue());
 648           }
 649         }
 650         else
 651         {
 652           valueField.setText(parm.getValue());
 653         }
 654       }
 655       lastVal = getCurrentValue();
 656       adjusting = false;
 657     }
 658
 659     private Slider makeSlider(ValueConstrainI validValue)
 660     {
 661       if (validValue != null)
 662       {
 663         final Number minValue = validValue.getMin();
 664         final Number maxValue = validValue.getMax();
 665         if (minValue != null && maxValue != null)
 666         {
 667           return new Slider(minValue.floatValue(), maxValue.floatValue(),
 668                   minValue.floatValue());
 669         }
 670       }
 671
 672       /*
 673        * otherwise, a nominal slider which will not be visible
 674        */
 675       return new Slider(0, 100, 50);
 676     }
 677
 678     public void updateSliderFromValueField()
 679     {
 680       if (validator != null)
 681       {
 682         final Number minValue = validator.getMin();
 683         final Number maxValue = validator.getMax();
 684         if (integ)
 685         {
 686           int iVal = 0;
 687           try
 688           {
 689             valueField.setText(valueField.getText().trim());
 690             iVal = Integer.valueOf(valueField.getText());
 691             if (minValue != null
 692                     && minValue.intValue() > iVal)
 693             {
 694               iVal = minValue.intValue();
 695               // TODO: provide visual indication that hard limit was reached for
 696               // this parameter
 697             }
 698             if (maxValue != null && maxValue.intValue() < iVal)
 699             {
 700               iVal = maxValue.intValue();
 701             }
 702           } catch (NumberFormatException e)
 703           {
 704             System.err.println(e.toString());
 705           }
 706           if (minValue != null || maxValue != null)
 707           {
 708             valueField.setText(String.valueOf(iVal));
 709             slider.setSliderValue(iVal);
 710           }
 711           else
 712           {
 713             slider.setVisible(false);
 714           }
 715         }
 716         else
 717         {
 718           float fVal = 0f;
 719           try
 720           {
 721             valueField.setText(valueField.getText().trim());
 722             fVal = Float.valueOf(valueField.getText());
 723             if (minValue != null
 724                     && minValue.floatValue() > fVal)
 725             {
 726               fVal = minValue.floatValue();
 727               // TODO: provide visual indication that hard limit was reached for
 728               // this parameter
 729               // update value field to reflect any bound checking we performed.
 730               valueField.setText("" + fVal);
 731             }
 732             if (maxValue != null
 733                     && maxValue.floatValue() < fVal)
 734             {
 735               fVal = maxValue.floatValue();
 736               // TODO: provide visual indication that hard limit was reached for
 737               // this parameter
 738               // update value field to reflect any bound checking we performed.
 739               valueField.setText("" + fVal);
 740             }
 741           } catch (NumberFormatException e)
 742           {
 743             System.err.println(e.toString());
 744           }
 745           if (minValue != null && maxValue != null)
 746           {
 747             slider.setSliderModel(minValue.floatValue(),
 748                     maxValue.floatValue(), fVal);
 749           }
 750           else
 751           {
 752             slider.setVisible(false);
 753           }
 754         }
 755       }
 756       else
 757       {
 758         if (!choice)
 759         {
 760           slider.setVisible(false);
 761         }
 762       }
 763     }
 764   }
 765
 766   public static final int PARAM_WIDTH = 340;
 767
 768   public static final int PARAM_HEIGHT = 150;
 769
 770   public static final int PARAM_CLOSEDHEIGHT = 80;
 771
 772   public OptsAndParamsPage(OptsParametersContainerI paramContainer)
 773   {
 774     this(paramContainer, false);
 775   }
 776
 777   public OptsAndParamsPage(OptsParametersContainerI paramContainer,
 778           boolean compact)
 779   {
 780     poparent = paramContainer;
 781     this.compact = compact;
 782   }
 783
 784   public static void showUrlPopUp(JComponent invoker, final String finfo,
 785           int x, int y)
 786   {
 787
 788     JPopupMenu mnu = new JPopupMenu();
 789     JMenuItem mitem = new JMenuItem(
 790             MessageManager.formatMessage("label.view_params", new String[]
 791             { finfo }));
 792     mitem.addActionListener(new ActionListener()
 793     {
 794
 795       @Override
 796       public void actionPerformed(ActionEvent e)
 797       {
 798         Desktop.showUrl(finfo);
 799
 800       }
 801     });
 802     mnu.add(mitem);
 803     mnu.show(invoker, x, y);
 804   }
 805
 806   URL linkImageURL = getClass().getResource("/images/link.gif");
 807
 808   Map<String, OptionBox> optSet = new java.util.LinkedHashMap<>();
 809
 810   Map<String, ParamBox> paramSet = new java.util.LinkedHashMap<>();
 811
 812   public Map<String, OptionBox> getOptSet()
 813   {
 814     return optSet;
 815   }
 816
 817   public void setOptSet(Map<String, OptionBox> optSet)
 818   {
 819     this.optSet = optSet;
 820   }
 821
 822   public Map<String, ParamBox> getParamSet()
 823   {
 824     return paramSet;
 825   }
 826
 827   public void setParamSet(Map<String, ParamBox> paramSet)
 828   {
 829     this.paramSet = paramSet;
 830   }
 831
 832   OptsParametersContainerI poparent;
 833
 834   OptionBox addOption(OptionI opt)
 835   {
 836     OptionBox cb = optSet.get(opt.getName());
 837     if (cb == null)
 838     {
 839       cb = new OptionBox(opt);
 840       optSet.put(opt.getName(), cb);
 841       // jobOptions.add(cb, FlowLayout.LEFT);
 842     }
 843     return cb;
 844   }
 845
 846   ParamBox addParameter(ParameterI arg)
 847   {
 848     ParamBox pb = paramSet.get(arg.getName());
 849     if (pb == null)
 850     {
 851       pb = new ParamBox(poparent, arg);
 852       paramSet.put(arg.getName(), pb);
 853       // paramList.add(pb);
 854     }
 855     pb.init();
 856     // take the defaults from the parameter
 857     pb.updateControls(arg);
 858     return pb;
 859   }
 860
 861   void selectOption(OptionI option, String string)
 862   {
 863     OptionBox cb = optSet.get(option.getName());
 864     if (cb == null)
 865     {
 866       cb = addOption(option);
 867     }
 868     cb.enabled.setSelected(string != null); // initial state for an option.
 869     if (string != null)
 870     {
 871       if (option.getPossibleValues().contains(string))
 872       {
 873         cb.val.setSelectedItem(string);
 874       }
 875       else
 876       {
 877         throw new Error(MessageManager.formatMessage(
 878                 "error.invalid_value_for_option", new String[]
 879                 { string, option.getName() }));
 880       }
 881
 882     }
 883     if (option.isRequired() && !cb.enabled.isSelected())
 884     {
 885       // TODO: indicate paramset is not valid.. option needs to be selected!
 886     }
 887     cb.setInitialValue();
 888   }
 889
 890   void setParameter(ParameterI arg)
 891   {
 892     ParamBox pb = paramSet.get(arg.getName());
 893     if (pb == null)
 894     {
 895       addParameter(arg);
 896     }
 897     else
 898     {
 899       pb.updateControls(arg);
 900     }
 901
 902   }
 903
 904   /**
 905    * recover options and parameters from GUI
 906    *
 907    * @return
 908    */
 909   public List<ArgumentI> getCurrentSettings()
 910   {
 911     List<ArgumentI> argSet = new ArrayList<>();
 912     for (OptionBox opts : getOptSet().values())
 913     {
 914       OptionI opt = opts.getOptionIfEnabled();
 915       if (opt != null)
 916       {
 917         argSet.add(opt);
 918       }
 919     }
 920     for (ParamBox parambox : getParamSet().values())
 921     {
 922       ParameterI parm = parambox.getParameter();
 923       if (parm != null)
 924       {
 925         argSet.add(parm);
 926       }
 927     }
 928
 929     return argSet;
 930   }
 931
 932 }