added support for the dynamic listbox update.

git-svn-id: https://hudson.dev.java.net/svn/hudson/trunk/hudson/main@3887 71c3de6d-444a-0410-be80-ed276b4c234a

core/src/main/java/hudson/util/ListBoxModel.java

+package hudson.util;
+
+import org.kohsuke.stapler.StaplerRequest;
+import org.kohsuke.stapler.StaplerResponse;
+import org.kohsuke.stapler.export.Exported;
+import org.kohsuke.stapler.export.ExportedBean;
+import org.kohsuke.stapler.export.Flavor;
+
+import javax.servlet.ServletException;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+
+/**
+ * Model object of dynamically filled list box.
+ *
+ * <h2>Usage</h2>
+ * <p>
+ * The dynamic list box support allows the SELECT element to change its options dynamically
+ * by using the values given by the server.
+ *
+ * <p>
+ * To use this, HTML needs to declare the SELECT element:
+ *
+ * <pre><xmp>
+ * <select id='foo'>
+ *   <option>Fetching values...</optoin>
+ * </select>
+ * </xmp></pre>
+ *
+ * <p>
+ * The SELECT element may have initial option values (in fact in most cases having initial
+ * values are desirable to avoid the client from submitting the form before the AJAX call
+ * updates the SELECT element.) It should also have an ID (although if you can get
+ * to the DOM element by other means, that's fine, too.)
+ *
+ * <p>
+ * Other parts of the HTML can initiate the SELECT element update by using the "updateListBox"
+ * function, defined in <tt>hudson-behavior.js</tt>. The following example does it
+ * when the value of the textbox changes:
+ *
+ * <pre><xmp>
+ * <input type="textbox" onchange="updateListBox('list','optionValues?value='+encode(this.value))"/>
+ * </xmp></pre>
+ *
+ * <p>
+ * The first argument is the SELECT element or the ID of it (see Prototype.js <tt>$(...)</tt> function.)
+ * The second arugment is the URL that returns the options list.
+ *
+ * <p>
+ * The URL usually maps to the <tt>doXXX</tt> method on the server, which uses {@link ListBoxModel}
+ * for producing option values. See the following example:
+ *
+ * <pre>
+ * public void doOptionValues(StaplerRequest req, StaplerResponse rsp, @QueryParameter("value") String value) throws IOException, ServletException {
+ *   ListBoxModel m = new ListBoxModel();
+ *   for(int i=0; i<5; i++)
+ *     m.add(value+i,value+i);
+ *   // make the third option selected initially
+ *   m.get(3).selected = true;
+ *   m.writeTo(req,rsp);
+ * }
+ * </pre>
+ * @since 1.123
+ * @author Kohsuke Kawaguchi
+ */
+@ExportedBean
+public class ListBoxModel extends ArrayList<ListBoxModel.Option> {
+
+    @ExportedBean(defaultVisibility=999)
+    public static final class Option {
+        /**
+         * Text to be displayed to user.
+         */
+        @Exported
+        public String name;
+        /**
+         * The value that gets sent to the server when the form is submitted.
+         */
+        @Exported
+        public String value;
+
+        /**
+         * True to make this item selected.
+         */
+        @Exported
+        public boolean selected;
+
+        public Option(String name, String value) {
+            this(name,value,false);
+        }
+
+        public Option(String name, String value, boolean selected) {
+            this.name = name;
+            this.value = value;
+            this.selected = selected;
+        }
+    }
+
+    public ListBoxModel(int initialCapacity) {
+        super(initialCapacity);
+    }
+
+    public ListBoxModel() {
+    }
+
+    public ListBoxModel(Collection<Option> c) {
+        super(c);
+    }
+
+    public ListBoxModel(Option... data) {
+        super(Arrays.asList(data));
+    }
+
+    public void add(String name, String value) {
+        add(new Option(name,value));
+    }
+
+    public void writeTo(StaplerRequest req,StaplerResponse rsp) throws IOException, ServletException {
+        rsp.serveExposedBean(req,this,Flavor.JSON);
+    }
+
+    /**
+     * @deprecated
+     *      Exposed for stapler. Not meant for programatic consumption.
+     */
+    @Exported
+    public Option[] values() {
+        return toArray(new Option[size()]);
+    }
+}

war/resources/scripts/hudson-behavior.js

@@ -616,3 +616,22 @@ function updateBuildHistory(nBuild) {
     }
     window.setTimeout(updateBuilds, 5000);
 }
+
+// send async request to the given URL (which will send back serialized ListBoxModel object),
+// then use the result to fill the list box.
+function updateListBox(listBox,url) {
+    new Ajax.Request(url, {
+        method: "post",
+        onSuccess: function(rsp,_) {
+            var l = $(listBox);
+            while(l.length>0)   l.options[0] = null;
+
+            var opts = eval('('+rsp.responseText+')').values;
+            for( var i=0; i<opts.length; i++ ) {
+                l.options[i] = new Option(opts[i].name,opts[i].value);
+                if(opts[i].selected)
+                    l.selectedIndex = i;
+            }
+        }
+    });
+}
\ No newline at end of file