Auto-completion can be now easily added to text boxes by plugins.

git-svn-id: https://hudson.dev.java.net/svn/hudson/trunk/hudson/main@34002 71c3de6d-444a-0410-be80-ed276b4c234a
2026-11-13 12:02:20 +00:00 · 2010-08-20 23:04:33 +00:00
1 parent 1c78940275
commit dfdcecccb1
@@ -0,0 +1,113 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2010, InfraDNA, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package hudson.plugins.ui_samples;
+
+import hudson.Extension;
+import hudson.model.AutoCompletionCandidates;
+import org.kohsuke.stapler.QueryParameter;
+
+/**
+ * Adding auto-completion to the text box.
+ *
+ * @author Kohsuke Kawaguchi
+ */
+@Extension
+public class AutoCompleteTextBox extends UISample {
+    @Override
+    public String getDescription() {
+        return "Provide auto-completion to the text box";
+    }
+
+    @Extension
+    public static final class DescriptorImpl extends UISampleDescriptor {
+        /**
+         * This method provides auto-completion items for the 'state' field.
+         * Stapler finds this method via the naming convention.
+         *
+         * @param value
+         *      The text that the user entered.
+         */
+        public AutoCompletionCandidates doAutoCompleteState(@QueryParameter String value) {
+            AutoCompletionCandidates c = new AutoCompletionCandidates();
+            for (String state : STATES)
+                if (state.toLowerCase().startsWith(value.toLowerCase()))
+                    c.add(state);
+            return c;
+        }
+    }
+
+    private static final String[] STATES = new String[]{
+            "Alabama",
+            "Alaska",
+            "Arizona",
+            "Arkansas",
+            "California",
+            "Colorado",
+            "Connecticut",
+            "Delaware",
+            "Florida",
+            "Georgia",
+            "Hawaii",
+            "Idaho",
+            "Illinois",
+            "Indiana",
+            "Iowa",
+            "Kansas",
+            "Kentucky",
+            "Louisiana",
+            "Maine",
+            "Maryland",
+            "Massachusetts",
+            "Michigan",
+            "Minnesota",
+            "Mississippi",
+            "Missouri",
+            "Montana",
+            "Nebraska",
+            "Nevada",
+            "New Hampshire",
+            "New Jersey",
+            "New Mexico",
+            "New York",
+            "North Carolina",
+            "North Dakota",
+            "Ohio",
+            "Oklahoma",
+            "Oregon",
+            "Pennsylvania",
+            "Rhode Island",
+            "South Carolina",
+            "South Dakota",
+            "Tennessee",
+            "Texas",
+            "Utah",
+            "Vermont",
+            "Virginia",
+            "Washington",
+            "West Virginia",
+            "Wisconsin",
+            "Wyoming"
+    };
+}