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

 1<!--
 2The MIT License
 3
 4Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
 5
 6Permission is hereby granted, free of charge, to any person obtaining a copy
 7of this software and associated documentation files (the "Software"), to deal
 8in the Software without restriction, including without limitation the rights
 9to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10copies of the Software, and to permit persons to whom the Software is
11furnished to do so, subject to the following conditions:
12
13The above copyright notice and this permission notice shall be included in
14all copies or substantial portions of the Software.
15
16THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22THE SOFTWARE.
23-->
24
25<?jelly escape-by-default='true'?>
26<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">
27  <st:documentation>
28    Generate config pages from a list of Descriptors into a section.
29
30    <st:attribute name="title">
31      Human readable title of the section to be rendered in HTML.
32    </st:attribute>
33    <st:attribute name="descriptors" use="required">
34      hudson.model.Descriptor collection whose configuration page is rendered.
35    </st:attribute>
36    <st:attribute name="instances">
37      Map&lt;Descriptor,Describable> that defines current instances of those descriptors.
38      These are used to fill initial values. Other classes that define the get(Descriptor)
39      method works fine, too, such as DescribableList.
40    </st:attribute>
41    <st:attribute name="field">
42      Either @field or @instances are required (or @field needs to be inherited from the ancestor &lt;entry> elemetn.
43      If field is specified, instances are assumed to be instance[field].
44
45      When this attribute is specified, JSON structure is properly set up so that the databinding
46      can set the field (or pass this collection as a constructor parameter of the same name.
47
48      This is more modern way of doing databinding, and thus preferred approach.
49    </st:attribute>
50    <st:attribute name="targetType">
51      the type for which descriptors will be configured.
52      default to ${it.class}
53    </st:attribute>
54  </st:documentation>
55
56  <j:if test="${attrs.field==null}">
57    <!-- inherit @field if we should do so -->
58    <j:set target="${attrs}" property="field" value="${entry.field}" />
59  </j:if>
60
61  <j:set var="targetType" value="${attrs.targetType ?: it.class}"/>
62  <j:set var="instances" value="${attrs.instances ?: instance[field] ?: descriptor['default'+h.capitalize(field)]}"/>
63
64  <j:if test="${!empty(descriptors) or context['org.apache.commons.jelly.body']!=null}">
65    <f:section title="${attrs.title}" name="${attrs.field?:attrs.name}">
66      <j:if test="${attrs.field!=null}">
67        <tr>
68          <td>
69            <input type="hidden" name="stapler-class-bag" value="true" />
70          </td>
71        </tr>
72      </j:if>
73
74      <d:invokeBody />
75      <j:forEach var="d" items="${descriptors}">
76        <f:optionalBlock name="${d.jsonSafeClassName}" help="${d.helpFile}"
77          title="${d.displayName}" checked="${instances.get(d)!=null}">
78
79          <j:set var="descriptor" value="${d}" />
80          <j:set var="instance" value="${instances.get(d)}" />
81          <st:include from="${d}" page="${d.configPage}" optional="true" />
82        </f:optionalBlock>
83      </j:forEach>
84    </f:section>
85  </j:if>
86</j:jelly>