From 5d14ae12be15c25f8acbd16d73b1807038153af8 Mon Sep 17 00:00:00 2001
From: kohsuke <kohsuke@71c3de6d-444a-0410-be80-ed276b4c234a>
Date: Fri, 12 Mar 2010 23:14:47 +0000
Subject: [PATCH] added a new plugin that serves as the UI showcase and test
 bed for various controls.

git-svn-id: https://hudson.dev.java.net/svn/hudson/trunk/hudson/main@28542 71c3de6d-444a-0410-be80-ed276b4c234a
---
 pom.xml                                       |  1 +
 .../plugins/ui_samples/DynamicComboBox.java   | 52 +++++++++++++++++++
 .../java/hudson/plugins/ui_samples/Root.java  | 37 +++++++++++++
 .../hudson/plugins/ui_samples/UISample.java   | 45 ++++++++++++++++
 .../ui_samples/UISampleDescriptor.java        | 13 +++++
 .../ui_samples/DynamicComboBox/index.jelly    | 51 ++++++++++++++++++
 .../plugins/ui_samples/Root/index.jelly       | 44 ++++++++++++++++
 .../main/resources/lib/samples/sample.jelly   | 34 ++++++++++++
 .../src/main/resources/lib/samples/taglib     |  0
 war/pom.xml                                   |  4 +-
 10 files changed, 279 insertions(+), 2 deletions(-)
 create mode 100644 ui-samples-plugin/src/main/java/hudson/plugins/ui_samples/DynamicComboBox.java
 create mode 100644 ui-samples-plugin/src/main/java/hudson/plugins/ui_samples/Root.java
 create mode 100644 ui-samples-plugin/src/main/java/hudson/plugins/ui_samples/UISample.java
 create mode 100644 ui-samples-plugin/src/main/java/hudson/plugins/ui_samples/UISampleDescriptor.java
 create mode 100644 ui-samples-plugin/src/main/resources/hudson/plugins/ui_samples/DynamicComboBox/index.jelly
 create mode 100644 ui-samples-plugin/src/main/resources/hudson/plugins/ui_samples/Root/index.jelly
 create mode 100644 ui-samples-plugin/src/main/resources/lib/samples/sample.jelly
 create mode 100644 ui-samples-plugin/src/main/resources/lib/samples/taglib

diff --git a/pom.xml b/pom.xml
index 941693db88..8efd1e8f0f 100644
--- a/pom.xml
+++ b/pom.xml
@@ -43,6 +43,7 @@ THE SOFTWARE.
     <module>remoting</module>
     <module>core</module>
     <module>maven-plugin</module>
+    <module>ui-samples-plugin</module>
     <module>maven-agent</module>
     <module>maven-interceptor</module>
     <module>war</module>
diff --git a/ui-samples-plugin/src/main/java/hudson/plugins/ui_samples/DynamicComboBox.java b/ui-samples-plugin/src/main/java/hudson/plugins/ui_samples/DynamicComboBox.java
new file mode 100644
index 0000000000..6611eb3081
--- /dev/null
+++ b/ui-samples-plugin/src/main/java/hudson/plugins/ui_samples/DynamicComboBox.java
@@ -0,0 +1,52 @@
+package hudson.plugins.ui_samples;
+
+import hudson.Extension;
+import hudson.util.ListBoxModel;
+import org.kohsuke.stapler.QueryParameter;
+
+import static java.util.Arrays.asList;
+
+/**
+ * @author Kohsuke Kawaguchi
+ */
+@Extension
+public class DynamicComboBox extends UISample {
+
+    @Override
+    public String getDescription() {
+        return "Updates the contents of a &lt;select> control dynamically based on selections of other controls";
+    }
+
+    // these getter methods should return the current value, which form the initial selection.
+
+    public String getCountry() {
+        return "USA";
+    }
+
+    public String getState() {
+        return "USA:B";
+    }
+
+    public String getCity() {
+        return "USA:B:Z";
+    }
+
+    @Extension
+    public static final class DescriptorImpl extends UISampleDescriptor {
+        public ListBoxModel doFillStateItems(@QueryParameter String country) {
+            ListBoxModel m = new ListBoxModel();
+            for (String s : asList("A","B","C"))
+                m.add(String.format("State %s in %s", s, country),
+                        country+':'+s);
+            return m;
+        }
+
+        public ListBoxModel doFillCityItems(@QueryParameter String country, @QueryParameter String state) {
+            ListBoxModel m = new ListBoxModel();
+            for (String s : asList("X","Y","Z"))
+                m.add(String.format("City %s in %s %s", s, state, country),
+                        state+':'+s);
+            return m;
+        }
+    }
+}
diff --git a/ui-samples-plugin/src/main/java/hudson/plugins/ui_samples/Root.java b/ui-samples-plugin/src/main/java/hudson/plugins/ui_samples/Root.java
new file mode 100644
index 0000000000..ebe927e1e6
--- /dev/null
+++ b/ui-samples-plugin/src/main/java/hudson/plugins/ui_samples/Root.java
@@ -0,0 +1,37 @@
+package hudson.plugins.ui_samples;
+
+import hudson.Extension;
+import hudson.model.RootAction;
+
+import java.util.List;
+
+/**
+ * Entry point to all the UI samples.
+ * 
+ * @author Kohsuke Kawaguchi
+ */
+@Extension
+public class Root implements RootAction {
+    public String getIconFileName() {
+        return "gear.gif";
+    }
+
+    public String getDisplayName() {
+        return "UI Samples";
+    }
+
+    public String getUrlName() {
+        return "ui-samples";
+    }
+
+    public UISample getDynamic(String name) {
+        for (UISample ui : getAll())
+            if (ui.getUrlName().equals(name))
+                return ui;
+        return null;
+    }
+
+    public List<UISample> getAll() {
+        return UISample.all();
+    }
+}
diff --git a/ui-samples-plugin/src/main/java/hudson/plugins/ui_samples/UISample.java b/ui-samples-plugin/src/main/java/hudson/plugins/ui_samples/UISample.java
new file mode 100644
index 0000000000..84cfcaf4fe
--- /dev/null
+++ b/ui-samples-plugin/src/main/java/hudson/plugins/ui_samples/UISample.java
@@ -0,0 +1,45 @@
+package hudson.plugins.ui_samples;
+
+import hudson.ExtensionList;
+import hudson.ExtensionPoint;
+import hudson.model.Action;
+import hudson.model.Describable;
+import hudson.model.Hudson;
+
+/**
+ * @author Kohsuke Kawaguchi
+ */
+public abstract class UISample implements ExtensionPoint, Action, Describable<UISample> {
+    public String getIconFileName() {
+        return "gear.gif";
+    }
+
+    public String getUrlName() {
+        return getClass().getSimpleName();
+    }
+
+    /**
+     * Default display name.
+     */
+    public String getDisplayName() {
+        return getClass().getSimpleName();
+    }
+
+    /**
+     * Returns a paragraph of natural text that describes this sample.
+     * Interpreted as HTML.
+     */
+    public abstract String getDescription();
+
+    public UISampleDescriptor getDescriptor() {
+        return (UISampleDescriptor)Hudson.getInstance().getDescriptorOrDie(getClass());
+    }
+
+    /**
+     * Returns all the registered {@link UISample}s.
+     */
+    public static ExtensionList<UISample> all() {
+        return Hudson.getInstance().getExtensionList(UISample.class);
+    }
+
+}
diff --git a/ui-samples-plugin/src/main/java/hudson/plugins/ui_samples/UISampleDescriptor.java b/ui-samples-plugin/src/main/java/hudson/plugins/ui_samples/UISampleDescriptor.java
new file mode 100644
index 0000000000..415e4a16e5
--- /dev/null
+++ b/ui-samples-plugin/src/main/java/hudson/plugins/ui_samples/UISampleDescriptor.java
@@ -0,0 +1,13 @@
+package hudson.plugins.ui_samples;
+
+import hudson.model.Descriptor;
+
+/**
+ * @author Kohsuke Kawaguchi
+ */
+public abstract class UISampleDescriptor extends Descriptor<UISample> {
+    @Override
+    public String getDisplayName() {
+        return clazz.getSimpleName();
+    }
+}
diff --git a/ui-samples-plugin/src/main/resources/hudson/plugins/ui_samples/DynamicComboBox/index.jelly b/ui-samples-plugin/src/main/resources/hudson/plugins/ui_samples/DynamicComboBox/index.jelly
new file mode 100644
index 0000000000..3e88adf551
--- /dev/null
+++ b/ui-samples-plugin/src/main/resources/hudson/plugins/ui_samples/DynamicComboBox/index.jelly
@@ -0,0 +1,51 @@
+<!--
+The MIT License
+
+Copyright (c) 2004-2010, Oracle Corporation
+
+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.
+-->
+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form" xmlns:s="/lib/samples">
+	<l:layout title="Dynamic ComboBox Sample">
+		<l:main-panel>
+      <h1>Dynamic ComboBox Sample</h1>
+
+      <p>
+        <j:out value="${it.description}"/>
+      </p>
+
+      <s:sample>
+        <form>
+          <table>
+            <f:entry title="Country" field="country">
+              <f:textbox />
+            </f:entry>
+            <f:entry title="State" field="state">
+              <f:select />
+            </f:entry>
+            <f:entry title="City" field="city">
+              <f:select />
+            </f:entry>
+          </table>
+        </form>
+      </s:sample>
+    </l:main-panel>
+	</l:layout>
+</j:jelly>
diff --git a/ui-samples-plugin/src/main/resources/hudson/plugins/ui_samples/Root/index.jelly b/ui-samples-plugin/src/main/resources/hudson/plugins/ui_samples/Root/index.jelly
new file mode 100644
index 0000000000..f79de82119
--- /dev/null
+++ b/ui-samples-plugin/src/main/resources/hudson/plugins/ui_samples/Root/index.jelly
@@ -0,0 +1,44 @@
+<!--
+The MIT License
+
+Copyright (c) 2004-2010, Oracle Corporation
+
+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.
+-->
+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form" xmlns:s="/lib/samples">
+	<l:layout title="Dynamic ComboBox Sample">
+		<l:main-panel>
+      <h1>UI Samples</h1>
+
+      <table>
+        <j:forEach var="s" items="${it.all}">
+          <t:summary icon="document.gif"
+                     href="${s.urlName}" iconOnly="true">
+            <div class="link"><a href="${href}">${s.displayName}</a></div>
+            <div style="color:gray; text-decoration:none;">
+              <j:out value="${s.description}"/>
+            </div>
+          </t:summary>
+
+        </j:forEach>
+      </table>
+    </l:main-panel>
+	</l:layout>
+</j:jelly>
diff --git a/ui-samples-plugin/src/main/resources/lib/samples/sample.jelly b/ui-samples-plugin/src/main/resources/lib/samples/sample.jelly
new file mode 100644
index 0000000000..8126459365
--- /dev/null
+++ b/ui-samples-plugin/src/main/resources/lib/samples/sample.jelly
@@ -0,0 +1,34 @@
+<!--
+The MIT License
+
+Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
+
+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.
+-->
+<?jelly escape-by-default='true'?>
+
+<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form" xmlns:i="jelly:fmt">
+  <st:documentation>
+    Set up variable bindings that emulate the form environment.
+    
+  </st:documentation>
+  <j:set var="instance" value="${it}" />
+  <j:set var="descriptor" value="${it.descriptor}" />
+  <d:invokeBody />
+</j:jelly>
diff --git a/ui-samples-plugin/src/main/resources/lib/samples/taglib b/ui-samples-plugin/src/main/resources/lib/samples/taglib
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/war/pom.xml b/war/pom.xml
index 5da6fcfc72..446517d6ac 100644
--- a/war/pom.xml
+++ b/war/pom.xml
@@ -195,9 +195,9 @@ THE SOFTWARE.
               <value>../core/src/main/resources</value>
             </systemProperty>
             <systemProperty>
-              <!-- enable the maven plugin by default -->
+              <!-- enable the plugins in main by default -->
               <name>hudson.bundled.plugins</name>
-              <value>${basedir}/../maven-plugin/target/test-classes/the.hpl</value>
+              <value>${basedir}/../maven-plugin/target/test-classes/the.hpl,${basedir}/../ui-samples-plugin/target/test-classes/the.hpl</value>
             </systemProperty>
             <systemProperty>
               <!-- stat collection pointless -->
-- 
GitLab