JAL-1432 updated copyright notices
[jalview.git] / src / jalview / gui / WsJobParameters.java
index b199489..7c665a3 100644 (file)
@@ -1,19 +1,20 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
- * Copyright (C) 2011 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
+ * Copyright (C) 2014 The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
  * Jalview is free software: you can redistribute it and/or
  * modify it under the terms of the GNU General Public License 
  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
- * 
+ *  
  * Jalview is distributed in the hope that it will be useful, but 
  * WITHOUT ANY WARRANTY; without even the implied warranty 
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
  * PURPOSE.  See the GNU General Public License for more details.
  * 
  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.gui;
 
@@ -22,17 +23,15 @@ import jalview.gui.OptsAndParamsPage.ParamBox;
 import jalview.ws.jws2.JabaParamStore;
 import jalview.ws.jws2.JabaPreset;
 import jalview.ws.jws2.Jws2Discoverer;
-import jalview.ws.jws2.Jws2Discoverer.Jws2Instance;
+import jalview.ws.jws2.jabaws2.Jws2Instance;
 import jalview.ws.params.ArgumentI;
 import jalview.ws.params.OptionI;
 import jalview.ws.params.ParamDatastoreI;
 import jalview.ws.params.ParameterI;
-import jalview.ws.params.ValueConstrainI;
 import jalview.ws.params.WsParamSetI;
 
 import java.awt.BorderLayout;
 import java.awt.Component;
-import java.awt.Container;
 import java.awt.Dimension;
 import java.awt.FlowLayout;
 import java.awt.Font;
@@ -42,50 +41,40 @@ import java.awt.GridLayout;
 import java.awt.Rectangle;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
+import java.awt.event.HierarchyBoundsListener;
+import java.awt.event.HierarchyEvent;
 import java.awt.event.ItemEvent;
 import java.awt.event.ItemListener;
-import java.awt.event.MouseEvent;
-import java.awt.event.MouseListener;
 import java.awt.event.WindowEvent;
 import java.awt.event.WindowListener;
 import java.net.URL;
-import java.util.ArrayList;
 import java.util.Hashtable;
 import java.util.Iterator;
 import java.util.List;
-import java.util.Map;
 import java.util.Vector;
 
 import javax.swing.JButton;
-import javax.swing.JCheckBox;
 import javax.swing.JComboBox;
-import javax.swing.JComponent;
 import javax.swing.JDialog;
 import javax.swing.JFrame;
 import javax.swing.JLabel;
-import javax.swing.JMenuItem;
 import javax.swing.JOptionPane;
 import javax.swing.JPanel;
-import javax.swing.JPopupMenu;
 import javax.swing.JScrollPane;
-import javax.swing.JSlider;
 import javax.swing.JSplitPane;
-import javax.swing.JTabbedPane;
 import javax.swing.JTextArea;
-import javax.swing.JTextField;
 import javax.swing.border.TitledBorder;
-import javax.swing.event.ChangeEvent;
-import javax.swing.event.ChangeListener;
 import javax.swing.event.DocumentEvent;
 import javax.swing.event.DocumentListener;
 
+import net.miginfocom.swing.MigLayout;
+
 import compbio.metadata.Argument;
 import compbio.metadata.Option;
 import compbio.metadata.Parameter;
 import compbio.metadata.Preset;
 import compbio.metadata.PresetManager;
 import compbio.metadata.RunnerConfig;
-import compbio.metadata.ValueConstrain.Type;
 
 /**
  * job parameter editing/browsing dialog box. User can browse existing settings
@@ -126,21 +115,16 @@ public class WsJobParameters extends JPanel implements ItemListener,
    */
   JPanel paramList = new JPanel();
 
-  
-  
   JPanel SetNamePanel = new JPanel();
 
   JPanel setDetails = new JPanel();
 
   JSplitPane settingsPanel = new JSplitPane();
 
-  JSplitPane jobPanel = new JSplitPane();
-
+  JPanel jobPanel = new JPanel();
 
   JScrollPane jobOptionsPane = new JScrollPane();
 
-  JPanel jobParameters = new JPanel();
-
   JButton createpref = new JButton();
 
   JButton deletepref = new JButton();
@@ -159,7 +143,7 @@ public class WsJobParameters extends JPanel implements ItemListener,
 
   JScrollPane paramPane = new JScrollPane();
 
-
+  // ScrollablePanel optsAndparams = new ScrollablePanel();
   JPanel optsAndparams = new JPanel();
 
   RunnerConfig serviceOptions;
@@ -234,22 +218,24 @@ public class WsJobParameters extends JPanel implements ItemListener,
     frame.setTitle("Edit parameters for " + service.getActionText());
     Rectangle deskr = Desktop.instance.getBounds();
     Dimension pref = this.getPreferredSize();
-    frame.setBounds(new Rectangle((int) (deskr.getCenterX() - pref.width/2),
-            (int) (deskr.getCenterY() - pref.height/2), pref.width, pref.height));
+    frame.setBounds(new Rectangle(
+            (int) (deskr.getCenterX() - pref.width / 2), (int) (deskr
+                    .getCenterY() - pref.height / 2), pref.width,
+            pref.height));
     frame.setContentPane(this);
-    
+
     // should perhaps recover defaults from user prefs.
 
     frame.validate();
     javax.swing.SwingUtilities.invokeLater(new Runnable()
     {
-        public void run()
-        {
-          jobPanel.setDividerLocation(0.25); 
+      public void run()
+      {
+        // jobPanel.setDividerLocation(0.25);
 
-        }
-      });
-  frame.setVisible(true);
+      }
+    });
+    frame.setVisible(true);
 
     if (response > 0)
     {
@@ -260,6 +246,22 @@ public class WsJobParameters extends JPanel implements ItemListener,
 
   private void jbInit()
   {
+    this.addHierarchyBoundsListener(new HierarchyBoundsListener()
+    {
+
+      @Override
+      public void ancestorResized(HierarchyEvent arg0)
+      {
+        refreshParamLayout();
+      }
+
+      @Override
+      public void ancestorMoved(HierarchyEvent arg0)
+      {
+        // TODO Auto-generated method stub
+
+      }
+    });
     updatepref = JvSwingUtils.makeButton("Update",
             "Update this existing user parameter set.",
             new ActionListener()
@@ -338,10 +340,10 @@ public class WsJobParameters extends JPanel implements ItemListener,
 
     JLabel setNameLabel = new JLabel("Current parameter set name :");
     setNameLabel.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
-    
+
     setNameInfo.add(setNameLabel);
     setNameInfo.add(setName);
-    
+
     // initial button visibility
     updatepref.setVisible(false);
     deletepref.setVisible(false);
@@ -352,13 +354,13 @@ public class WsJobParameters extends JPanel implements ItemListener,
     ((FlowLayout) setsavebuts.getLayout()).setHgap(10);
     ((FlowLayout) setsavebuts.getLayout()).setVgap(0);
     JPanel spacer = new JPanel();
-    spacer.setPreferredSize(new Dimension(2,30));
+    spacer.setPreferredSize(new Dimension(2, 30));
     setsavebuts.add(spacer);
     setsavebuts.add(deletepref);
     setsavebuts.add(revertpref);
     setsavebuts.add(createpref);
     setsavebuts.add(updatepref);
-//    setsavebuts.setSize(new Dimension(150, 30));
+    // setsavebuts.setSize(new Dimension(150, 30));
     JPanel buttonArea = new JPanel(new GridLayout(1, 1));
     buttonArea.add(setsavebuts);
     SetNamePanel.add(setNameInfo);
@@ -373,25 +375,34 @@ public class WsJobParameters extends JPanel implements ItemListener,
     gbl.setConstraints(buttonArea, gbc);
     setDetails.add(setDescrView, BorderLayout.CENTER);
 
-    jobParameters.setBorder(new TitledBorder("Parameters"));
-    paramPane.setPreferredSize(new Dimension(360, 400));
+    // paramPane.setPreferredSize(new Dimension(360, 400));
+    // paramPane.setPreferredSize(null);
     jobOptions.setBorder(new TitledBorder("Options"));
-    
+    jobOptions.setOpaque(true);
     paramList.setBorder(new TitledBorder("Parameters"));
-    
-    JPanel bjo=new JPanel(new BorderLayout()),bjp=new JPanel(new BorderLayout());
+    paramList.setOpaque(true);
+    JPanel bjo = new JPanel(new BorderLayout()), bjp = new JPanel(
+            new BorderLayout());
     bjo.add(jobOptions, BorderLayout.CENTER);
     bjp.add(paramList, BorderLayout.CENTER);
-    optsAndparams.setLayout(new BorderLayout()); 
-
-    optsAndparams.add(bjo, BorderLayout.CENTER);
-    optsAndparams.add(bjp, BorderLayout.SOUTH);
-    paramPane.setViewportView(optsAndparams);
+    bjp.setOpaque(true);
+    bjo.setOpaque(true);
+    // optsAndparams.setScrollableWidth(ScrollableSizeHint.FIT);
+    // optsAndparams.setScrollableHeight(ScrollableSizeHint.NONE);
+    // optsAndparams.setLayout(new BorderLayout());
+    optsAndparams.setLayout(new BorderLayout());
+    optsAndparams.add(jobOptions, BorderLayout.NORTH);
+    optsAndparams.add(paramList, BorderLayout.CENTER);
+    JPanel jp = new JPanel(new BorderLayout());
+    jp.add(optsAndparams, BorderLayout.CENTER);
+    paramPane.getViewport().setView(jp);
+    paramPane.setBorder(null);
     setLayout(new BorderLayout());
-    jobPanel.setLeftComponent(setDetails);
-    jobPanel.setRightComponent(paramPane);
-    jobPanel.setOrientation(JSplitPane.VERTICAL_SPLIT);
+    jobPanel.setPreferredSize(null);
+    jobPanel.setLayout(new BorderLayout());
+    jobPanel.add(setDetails, BorderLayout.NORTH);
+    jobPanel.add(paramPane, BorderLayout.CENTER);
+    // jobPanel.setOrientation(JSplitPane.VERTICAL_SPLIT);
 
     add(SetNamePanel, BorderLayout.NORTH);
     add(jobPanel, BorderLayout.CENTER);
@@ -400,6 +411,7 @@ public class WsJobParameters extends JPanel implements ItemListener,
     dialogpanel.add(startjob);
     dialogpanel.add(canceljob);
     add(dialogpanel, BorderLayout.SOUTH);
+    validate();
   }
 
   protected void revert_actionPerformed(ActionEvent e)
@@ -537,7 +549,10 @@ public class WsJobParameters extends JPanel implements ItemListener,
       if (jobArgset != null && jobArgset.size() > 0)
       {
         curSetName = "Supplied Settings";
+        isUserPreset = false;
         updateTable(p, jobArgset);
+        setName.setSelectedItem(curSetName);
+        updateButtonDisplay();
       }
       else
       {
@@ -552,18 +567,32 @@ public class WsJobParameters extends JPanel implements ItemListener,
   @SuppressWarnings("unchecked")
   private void updateTable(WsParamSetI p, List<ArgumentI> jobArgset)
   {
+    boolean setDefaultParams=false;
+    if (lastParmSet == null)
+    {
+      isUserPreset = false;
+      // First call - so provide Service default settings
+      setName.setSelectedItem(lastSetName = SVC_DEF);
+    }
+    if (p==null && SVC_DEF.equals(""+setName.getSelectedItem()))
+    {
+      // indicate that service defaults should be set if available
+      setDefaultParams=true;
+    }
     // populate table from default parameter set.
     List<ArgumentI> args = paramStore.getServiceParameters();
 
     // split to params and required arguments
     {
+      int cw = 0;
+      boolean optset=false;
       for (ArgumentI myarg : args)
-      {
+      { 
         // Ideally, Argument would implement isRequired !
         if (myarg instanceof ParameterI)
         {
           ParameterI parm = (ParameterI) myarg;
-          paramList.add(opanp.addParameter(parm));
+          opanp.addParameter(parm).validate();
         }
         else
         {
@@ -571,13 +600,13 @@ public class WsJobParameters extends JPanel implements ItemListener,
           {
             OptionI opt = (OptionI) myarg;
             OptionBox ob = opanp.addOption(opt);
-            jobOptions.add(ob, FlowLayout.LEFT);
-            ob.resetToDefault();
+            ob.resetToDefault(setDefaultParams);
             if (MAX_OPTWIDTH < ob.getPreferredSize().width)
             {
               MAX_OPTWIDTH = ob.getPreferredSize().width;
             }
-
+            ob.validate();
+            cw += ob.getPreferredSize().width + 5;
           }
           else
           {
@@ -605,16 +634,6 @@ public class WsJobParameters extends JPanel implements ItemListener,
       // TODO: check if args should be unselected prior to resetting using the
       // preset
     }
-    else
-    {
-      if (lastParmSet == null)
-      {
-        isUserPreset = false;
-        // first call - so create a dummy name
-
-        setName.setSelectedItem(lastSetName = SVC_DEF);
-      }
-    }
 
     if (jobArgset != null)
     {
@@ -784,62 +803,121 @@ public class WsJobParameters extends JPanel implements ItemListener,
     settingDialog = stn;
   }
 
-
   public void refreshParamLayout()
   {
+    // optsAndparams.setPreferredSize(null);
     FlowLayout fl = new FlowLayout(FlowLayout.LEFT);
-    int sep=fl.getVgap();
-    int os=0,s = jobOptions.getBorder().getBorderInsets(jobOptions).bottom+jobOptions.getBorder().getBorderInsets(jobOptions).top+2 * sep;
-    int w = 2 * fl.getHgap() + (MAX_OPTWIDTH > OptsAndParamsPage.PARAM_WIDTH ? MAX_OPTWIDTH : OptsAndParamsPage.PARAM_WIDTH);
-    jobOptions.setLayout(fl);
+    int sep = fl.getVgap();
+    boolean fh = true;
+    int os = 0, s = jobOptions.getBorder().getBorderInsets(jobOptions).bottom
+            + jobOptions.getBorder().getBorderInsets(jobOptions).top
+            + 2
+            * sep;
+    /**
+     * final height for viewport
+     */
+    int finalh = s;
+    int panewidth = paramPane.getViewport().getSize().width - 120
+            - jobOptions.getBorder().getBorderInsets(jobOptions).left
+            + jobOptions.getBorder().getBorderInsets(jobOptions).right;
+
+    int w = 2
+            * fl.getHgap()
+            + (MAX_OPTWIDTH > OptsAndParamsPage.PARAM_WIDTH ? MAX_OPTWIDTH
+                    : OptsAndParamsPage.PARAM_WIDTH);
+    int hgap = fl.getHgap(), cw = hgap;
+
     if (opanp.getOptSet().size() > 0)
     {
-      
+
+      jobOptions.setLayout(new MigLayout("", "", ""));
+      jobOptions.removeAll();
+
       for (OptionBox pbox : opanp.getOptSet().values())
       {
-         pbox.revalidate();
-        s += sep + pbox.getPreferredSize().height; 
+        pbox.validate();
+        cw += pbox.getSize().width + hgap;
+        if (cw + 120 > panewidth)
+        {
+          jobOptions.add(pbox, "wrap");
+          // System.out.println("Wrap on "+pbox.option.getName());
+          cw = hgap + pbox.getSize().width;
+          fh = true;
+        }
+        else
+        {
+          jobOptions.add(pbox);
+        }
+        if (fh)
+        {
+          finalh += pbox.getSize().height + fl.getVgap();
+          fh = false;
+        }
       }
-      jobOptions.setPreferredSize(new Dimension(w, s));
-      jobOptions.setLayout(new GridLayout(opanp.getOptSet().size(),1));
-      os=s;
+      jobOptions.revalidate();
     }
     else
     {
       jobOptions.setVisible(false);
     }
 
-    // Now layout the parameters assuming they occupy one column - to calculate total height of options+parameters
-    fl = new FlowLayout(FlowLayout.CENTER);
-    // helpful hint from http://stackoverflow.com/questions/2743177/top-alignment-for-flowlayout
+    // Now layout the parameters assuming they occupy one column - to calculate
+    // total height of options+parameters
+    fl = new FlowLayout(FlowLayout.LEFT);
+    // helpful hint from
+    // http://stackoverflow.com/questions/2743177/top-alignment-for-flowlayout
     fl.setAlignOnBaseline(true);
     if (opanp.getParamSet().size() > 0)
     {
-      paramList.setLayout(fl);
-
-      s = 2 * sep;
+      paramList.removeAll();
+      paramList.setLayout(new MigLayout("", "", ""));
+      fh = true;
       for (ParamBox pbox : opanp.getParamSet().values())
       {
         pbox.validate();
-        s += sep + pbox.getPreferredSize().height+pbox.getBorder().getBorderInsets(pbox).bottom; 
+        cw += pbox.getSize().width + hgap;
+        if (cw + 160 > panewidth)
+        {
+          paramList.add(pbox, "wrap");
+          cw = pbox.getSize().width + hgap;
+          fh = true;
+        }
+        else
+        {
+          paramList.add(pbox);
+        }
+        if (fh)
+        {
+          finalh += pbox.getSize().height + fl.getVgap();
+          fh = false;
+        }
+
       }
-      
-      paramList.setPreferredSize(new Dimension(w, s));
-      os+=s+2*sep+paramList.getBorder().getBorderInsets(paramList).bottom+paramList.getBorder().getBorderInsets(paramList).top;
+      /*
+       * s = 2 * sep; for (ParamBox pbox : opanp.getParamSet().values()) {
+       * pbox.validate(); s += sep +
+       * pbox.getPreferredSize().height+pbox.getBorder
+       * ().getBorderInsets(pbox).bottom; }
+       * 
+       * // paramList.setPreferredSize(new Dimension(w, s));
+       * os+=s+2*sep+paramList
+       * .getBorder().getBorderInsets(paramList).bottom+paramList
+       * .getBorder().getBorderInsets(paramList).top;
+       */
+      paramList.revalidate();
     }
     else
     {
       paramList.setVisible(false);
     }
-    // TODO: waste some time trying to eliminate any unnecessary .validate calls here
-    paramList.validate();
-    jobOptions.validate();
+    // TODO: waste some time trying to eliminate any unnecessary .validate calls
+    // here
     // System.out.println("Size will be : "+w+","+os);
-    optsAndparams.validate();
-    paramPane.getViewport().validate();
-    paramPane.getVerticalScrollBar().setBlockIncrement(OptsAndParamsPage.PARAM_CLOSEDHEIGHT*2);
-    paramPane.validate();
-    validate();
+    // optsAndparams.setPreferredSize(null);
+    // paramPane.getViewport().setView(optsAndparams);
+    paramPane.getViewport().setAutoscrolls(true);
+    paramPane.revalidate();
+    revalidate();
   }
 
   /**
@@ -867,8 +945,8 @@ public class WsJobParameters extends JPanel implements ItemListener,
       e.printStackTrace();
       return;
     }
-    Jws2Discoverer.Jws2Instance lastserv = null;
-    for (Jws2Discoverer.Jws2Instance service : disc.getServices())
+    Jws2Instance lastserv = null;
+    for (Jws2Instance service : disc.getServices())
     {
       lastserv = service;
       if (p >= args.length || service.serviceType.equalsIgnoreCase(args[p]))
@@ -1071,6 +1149,12 @@ public class WsJobParameters extends JPanel implements ItemListener,
     }
   }
 
+  public boolean isServiceDefaults()
+  {
+    return (!isModified() && (lastParmSet != null && lastParmSet
+            .equals(SVC_DEF)));
+  }
+
   public List<ArgumentI> getJobParams()
   {
     return opanp.getCurrentSettings();