Support for databinding on descriptor list

Merging changes made by Kohsuke in nodeproperties branch

Revision: 14927
Author: kohsuke
Date: 20:44:52, vrijdag 30 januari 2009
Message:
added support for form databinding
----
Modified : /branches/nodeproperties/main/core/src/main/resources/lib/form/descriptorList.jelly

Revision: 14925
Author: kohsuke
Date: 20:41:35, vrijdag 30 januari 2009
Message:
handle overlapping nested <rowSet> correctly.
----
Modified : /branches/nodeproperties/main/war/resources/scripts/hudson-behavior.js

Revision: 14924
Author: kohsuke
Date: 20:33:48, vrijdag 30 januari 2009
Message:
added another convenience method.
----
Modified : /branches/nodeproperties/main/core/src/main/java/hudson/util/DescribableList.java

Revision: 14918
Author: kohsuke
Date: 19:02:44, vrijdag 30 januari 2009
Message:
added optional @name to create an JSON object
----
Modified : /branches/nodeproperties/main/core/src/main/resources/lib/form/section.jelly

Revision: 14917
Author: kohsuke
Date: 19:02:30, vrijdag 30 januari 2009
Message:
added documentation and supported graceful no-op.
----
Modified : /branches/nodeproperties/main/core/src/main/resources/lib/form/rowSet.jelly

Revision: 14915
Author: kohsuke
Date: 18:44:56, vrijdag 30 januari 2009
Message:
I hate cursor stealing
----
Modified : /branches/nodeproperties/main/core/src/main/resources/lib/form/descriptorList.jelly

Revision: 14914
Author: kohsuke
Date: 18:44:04, vrijdag 30 januari 2009
Message:
title is not mandatory
----
Modified : /branches/nodeproperties/main/core/src/main/resources/lib/form/descriptorList.jelly




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

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

@@ -97,6 +97,11 @@ public class DescribableList<T extends Describable<T>, D extends Descriptor<T>>
         onModified();
     }
 
+    public void replaceBy(Collection<? extends T> col) throws IOException {
+        data.replaceBy(col);
+        onModified();
+    }
+
     public T get(D descriptor) {
         for (T t : data)
             if(t.getDescriptor()==descriptor)

core/src/main/resources/lib/form/descriptorList.jelly

@@ -26,17 +26,26 @@ THE SOFTWARE.
   <st:documentation>
     Generate config pages from a list of Descriptors into a section.
 
-    <st:attribute name="title" use="required">
+    <st:attribute name="title">
       Human readable title of the section to be rendered in HTML.
     </st:attribute>
     <st:attribute name="descriptors" use="required">
       hudson.model.Descriptor collection whose configuration page is rendered.
     </st:attribute>
-    <st:attribute name="instances" use="required">
+    <st:attribute name="instances">
       Map&lt;Descriptor,Describable> that defines current instances of those descriptors.
       These are used to fill initial values. Other classes that define the get(Descriptor)
       method works fine, too.
     </st:attribute>
+    <st:attribute name="field">
+      Either @field or @instances are required. If field is specified, instances are assumed to be
+      instance[field].
+
+      When this attribute is specified, JSON structure is properly set up so that the databinding
+      can set the field (or pass this collection as a constructor parameter of the same name.
+
+      This is more modern way of doing databinding, and thus preferred approach.
+    </st:attribute>
     <st:attribute name="targetType">
       the type for which descriptors will be configured.
       default to ${it.class}
@@ -44,16 +53,26 @@ THE SOFTWARE.
   </st:documentation>
 
   <j:set var="targetType" value="${h.defaulted(attrs.targetType,it.class)}"/>
-  <f:section title="${attrs.title}">
+  <j:set var="instances" value="${h.ifThenElse(attrs.instances!=null,attrs.instances,instance[field])}"/>
+
+  <f:section title="${attrs.title}" name="${attrs.field}">
+    <j:if test="${attrs.field!=null}">
+      <tr>
+        <td>
+          <input type="hidden" name="stapler-class-bag" value="true" />
+        </td>
+      </tr>
+    </j:if>
+
     <d:invokeBody />
-	  <j:forEach var="d" items="${descriptors}">
+    <j:forEach var="d" items="${descriptors}">
       <f:optionalBlock name="${d.jsonSafeClassName}" help="${d.helpFile}"
-	      title="${d.displayName}" checked="${instances.get(d)!=null}">
+        title="${d.displayName}" checked="${instances.get(d)!=null}">
 
-	      <j:set var="descriptor" value="${d}" />
-	      <j:set var="instance" value="${instances.get(d)}" />
-	      <st:include from="${d}" page="${d.configPage}" optional="true" />
-	    </f:optionalBlock>
-	  </j:forEach>
+        <j:set var="descriptor" value="${d}" />
+        <j:set var="instance" value="${instances.get(d)}" />
+        <st:include from="${d}" page="${d.configPage}" optional="true" />
+      </f:optionalBlock>
+    </j:forEach>
 	</f:section>
 </j:jelly>
\ No newline at end of file

core/src/main/resources/lib/form/rowSet.jelly

@@ -22,25 +22,36 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 -->
 
-<!--
-  Adds @nameRef to all table rows inside this tag, so that when the form is submitted,
-  it gets grouped in one JSON object.
-
-  @ref: id of the thing that serves as the group head, if that's available separately
-
-  @name: if the group head is not available outside, use this attribute to specify the name.
-         @name and @ref are mutually exclusive.
--->
 <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">
-
-  <j:set var="id" value="${h.generateId()}" />
-  <j:set var="head" value="rowGroupStart${id}"/>
-  <j:set var="ref" value="${h.ifThenElse(attrs.ref!=null, attrs.ref, head)}"/>
-
-  <tr id="${head}" style="display:none" name="${attrs.name}" />
-  <d:invokeBody />
-  <tr id="rowGroupEnd${id}" style="display:none" />
-  <script>
-    applyNameRef($$('${head}') , $$('rowGroupEnd${id}') , '${ref}')
-  </script>
+  <st:documentation>
+    Adds @nameRef to all table rows inside this tag, so that when the form is submitted,
+    it gets grouped in one JSON object.
+
+    <st:attribute name="name">
+      if the group head is not available outside, use this attribute to specify the name.
+      @name and @ref are mutually exclusive.
+    </st:attribute>
+    <st:attribute name="ref">
+      id of the thing that serves as the group head, if that's available separately
+    </st:attribute>
+  </st:documentation>
+
+  <j:choose>
+    <j:when test="${attrs.ref==null and attrs.name==null}">
+      <!-- noop -->
+      <d:invokeBody />
+    </j:when>
+    <j:otherwise>
+      <j:set var="id" value="${h.generateId()}" />
+      <j:set var="head" value="rowGroupStart${id}"/>
+      <j:set var="ref" value="${h.ifThenElse(attrs.ref!=null, attrs.ref, head)}"/>
+
+      <tr id="${head}" style="display:none" name="${attrs.name}" />
+      <d:invokeBody />
+      <tr id="rowGroupEnd${id}" style="display:none" />
+      <script>
+        applyNameRef($$('${head}') , $$('rowGroupEnd${id}') , '${ref}')
+      </script>
+    </j:otherwise>
+  </j:choose>
 </j:jelly>
\ No newline at end of file

core/src/main/resources/lib/form/section.jelly

@@ -30,13 +30,19 @@ THE SOFTWARE.
       The section header text.
       If null is given, the entire <f:section> tag becomes no-op.
     </st:attribute>
+    <st:attribute name="name">
+      Optional attribute to create a JSON object from this section.
+    </st:attribute>
   </st:documentation>
-  <j:if test="${attrs.title!=null}">
-    <f:block>
-      <div style="font-weight:bold; border-bottom: 1px solid black; margin-bottom:0.2em; margin-top:0.4em">
-        ${title}
-      </div>
-    </f:block>
-  </j:if>
-	<d:invokeBody />
+
+  <f:rowSet name="${attrs.name}">
+    <j:if test="${attrs.title!=null}">
+      <f:block>
+        <div style="font-weight:bold; border-bottom: 1px solid black; margin-bottom:0.2em; margin-top:0.4em">
+          ${title}
+        </div>
+      </f:block>
+    </j:if>
+    <d:invokeBody />
+  </f:rowSet>
 </j:jelly>
\ No newline at end of file

war/resources/scripts/hudson-behavior.js

@@ -22,6 +22,7 @@
  * THE SOFTWARE.
  */
 //
+initOptionalBlock//
 // JavaScript for Hudson
 //     See http://www.ibm.com/developerworks/web/library/wa-memleak/?ca=dgr-lnxw97JavascriptLeaks
 //     for memory leak patterns and how to prevent them.
@@ -580,8 +581,11 @@ function replaceDescription() {
 function applyNameRef(s,e,id) {
     $(id).groupingNode = true;
     // s contains the node itself
-    for(var x=s.nextSibling; x!=e; x=x.nextSibling)
-        x.setAttribute("nameRef",id);
+    for(var x=s.nextSibling; x!=e; x=x.nextSibling) {
+        // to handle nested <f:rowSet> correctly, don't overwrite the existing value
+        if(x.getAttribute("nameRef")==null)
+            x.setAttribute("nameRef",id);
+    }
 }
 
 function initOptionalBlock(sid, eid, cid) {