Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

SPR-3389 Nicer handling of Java 5 enums by the Spring MVC form taglib.

Browse Source 
The form:options and form:radiobuttons tags will now render a set of options automatically if the bind target is an Enum and items are not otherwise specified.  The values of the enum are converted into form inputs where by default the form value is the enum's name() and the form label is the enum's toString().
This commit is contained in:
Scott Andrews
2009-01-22 20:36:36 +00:00
parent ad2cc34b79
commit 8e261e5833
7 changed files with 219 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
org.springframework.web.servlet/src/test/java/org/springframework/web/servlet/tags/form/OptionsTagTests.java
View File

@@ -24,12 +24,13 @@ import java.util.List;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.jsp.tagext.BodyTag;
import javax.servlet.jsp.tagext.Tag;
import org.dom4j.Document;
import org.dom4j.Element;
import org.dom4j.Node;
import org.dom4j.io.SAXReader;
import org.springframework.beans.TestBean;
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockPageContext;
@@ -43,11 +44,13 @@ import org.springframework.web.servlet.tags.RequestContextAwareTag;
/**
* @author Rob Harrop
* @author Juergen Hoeller
* @author Scott Andrews
*/
public class OptionsTagTests extends AbstractHtmlElementTagTests {
public final class OptionsTagTests extends AbstractHtmlElementTagTests {
private static final String COMMAND_NAME = "testBean";
private SelectTag selectTag;
private OptionsTag tag;
protected void onSetUp() {
@@ -56,7 +59,13 @@ public class OptionsTagTests extends AbstractHtmlElementTagTests {
return new TagWriter(getWriter());
}
};
this.tag.setParent(new SelectTag());
selectTag = new SelectTag() {
protected TagWriter createTagWriter() {
return new TagWriter(getWriter());
}
};
selectTag.setPageContext(getPageContext());
this.tag.setParent(selectTag);
this.tag.setPageContext(getPageContext());
}
@@ -148,24 +157,81 @@ public class OptionsTagTests extends AbstractHtmlElementTagTests {
}
public void testWithoutItems() throws Exception {
getPageContext().setAttribute(
SelectTag.LIST_VALUE_PAGE_ATTRIBUTE, new BindStatus(getRequestContext(), "testBean.country", false));
this.tag.setItemValue("isoCode");
this.tag.setItemLabel("name");
this.selectTag.setPath("testBean");
this.selectTag.doStartTag();
int result = this.tag.doStartTag();
assertEquals(Tag.SKIP_BODY, result);
this.tag.doEndTag();
this.selectTag.doEndTag();
String output = getOutput();
output = "<doc>" + output + "</doc>";
SAXReader reader = new SAXReader();
Document document = reader.read(new StringReader(output));
Element rootElement = document.getRootElement();
List children = rootElement.elements();
assertEquals("Incorrect number of children", 0, children.size());
}
public void testWithoutItemsEnumParent() throws Exception {
BeanWithEnum testBean = new BeanWithEnum();
testBean.setTestEnum(TestEnum.VALUE_2);
getPageContext().getRequest().setAttribute("testBean", testBean);
this.selectTag.setPath("testBean.testEnum");
this.selectTag.doStartTag();
int result = this.tag.doStartTag();
assertEquals(BodyTag.SKIP_BODY, result);
result = this.tag.doEndTag();
assertEquals(Tag.EVAL_PAGE, result);
this.selectTag.doEndTag();
String output = getWriter().toString();
SAXReader reader = new SAXReader();
Document document = reader.read(new StringReader(output));
Element rootElement = document.getRootElement();
assertEquals(2, rootElement.elements().size());
Node value1 = rootElement.selectSingleNode("option[@value = 'VALUE_1']");
Node value2 = rootElement.selectSingleNode("option[@value = 'VALUE_2']");
assertEquals("TestEnum: VALUE_1", value1.getText());
assertEquals("TestEnum: VALUE_2", value2.getText());
assertEquals(value2, rootElement.selectSingleNode("option[@selected]"));
}
public void testWithoutItemsEnumParentWithExplicitLabelsAndValues() throws Exception {
BeanWithEnum testBean = new BeanWithEnum();
testBean.setTestEnum(TestEnum.VALUE_2);
getPageContext().getRequest().setAttribute("testBean", testBean);
this.selectTag.setPath("testBean.testEnum");
this.tag.setItemLabel("enumLabel");
this.tag.setItemValue("enumValue");
this.selectTag.doStartTag();
int result = this.tag.doStartTag();
assertEquals(BodyTag.SKIP_BODY, result);
result = this.tag.doEndTag();
assertEquals(Tag.EVAL_PAGE, result);
this.selectTag.doEndTag();
String output = getWriter().toString();
SAXReader reader = new SAXReader();
Document document = reader.read(new StringReader(output));
Element rootElement = document.getRootElement();
assertEquals(2, rootElement.elements().size());
Node value1 = rootElement.selectSingleNode("option[@value = 'Value: VALUE_1']");
Node value2 = rootElement.selectSingleNode("option[@value = 'Value: VALUE_2']");
assertEquals("Label: VALUE_1", value1.getText());
assertEquals("Label: VALUE_2", value2.getText());
assertEquals(value2, rootElement.selectSingleNode("option[@selected]"));
}
protected void extendRequest(MockHttpServletRequest request) {
TestBean bean = new TestBean();
bean.setName("foo");

51
org.springframework.web.servlet/src/test/java/org/springframework/web/servlet/tags/form/RadioButtonsTagTests.java
View File

@@ -31,8 +31,8 @@ import javax.servlet.jsp.tagext.Tag;
import org.dom4j.Document;
import org.dom4j.Element;
import org.dom4j.Node;
import org.dom4j.io.SAXReader;
import org.springframework.beans.Colour;
import org.springframework.beans.Pet;
import org.springframework.beans.TestBean;
@@ -43,8 +43,9 @@ import org.springframework.validation.BindingResult;
/**
* @author Thomas Risberg
* @author Juergen Hoeller
* @author Scott Andrews
*/
public class RadioButtonsTagTests extends AbstractFormTagTests {
public final class RadioButtonsTagTests extends AbstractFormTagTests {
private RadioButtonsTag tag;
@@ -404,6 +405,52 @@ public class RadioButtonsTagTests extends AbstractFormTagTests {
assertEquals("Mufty", radioButtonElement5.attribute("value").getValue());
assertEquals("MUFTY", spanElement5.getStringValue());
}
public void testWithoutItemsEnumBindTarget() throws Exception {
BeanWithEnum testBean = new BeanWithEnum();
testBean.setTestEnum(TestEnum.VALUE_2);
getPageContext().getRequest().setAttribute("testBean", testBean);
this.tag.setPath("testEnum");
int result = this.tag.doStartTag();
assertEquals(Tag.SKIP_BODY, result);
String output = "<div>" + getOutput() + "</div>";
SAXReader reader = new SAXReader();
Document document = reader.read(new StringReader(output));
Element rootElement = document.getRootElement();
assertEquals(2, rootElement.elements().size());
Node value1 = rootElement.selectSingleNode("//input[@value = 'VALUE_1']");
Node value2 = rootElement.selectSingleNode("//input[@value = 'VALUE_2']");
assertEquals("TestEnum: VALUE_1", rootElement.selectSingleNode("//label[@for = '" + value1.valueOf("@id") + "']").getText());
assertEquals("TestEnum: VALUE_2", rootElement.selectSingleNode("//label[@for = '" + value2.valueOf("@id") + "']").getText());
assertEquals(value2, rootElement.selectSingleNode("//input[@checked]"));
}
public void testWithoutItemsEnumBindTargetWithExplicitLabelsAndValues() throws Exception {
BeanWithEnum testBean = new BeanWithEnum();
testBean.setTestEnum(TestEnum.VALUE_2);
getPageContext().getRequest().setAttribute("testBean", testBean);
this.tag.setPath("testEnum");
this.tag.setItemLabel("enumLabel");
this.tag.setItemValue("enumValue");
int result = this.tag.doStartTag();
assertEquals(Tag.SKIP_BODY, result);
String output = "<div>" + getOutput() + "</div>";
SAXReader reader = new SAXReader();
Document document = reader.read(new StringReader(output));
Element rootElement = document.getRootElement();
assertEquals(2, rootElement.elements().size());
Node value1 = rootElement.selectSingleNode("//input[@value = 'Value: VALUE_1']");
Node value2 = rootElement.selectSingleNode("//input[@value = 'Value: VALUE_2']");
assertEquals("Label: VALUE_1", rootElement.selectSingleNode("//label[@for = '" + value1.valueOf("@id") + "']").getText());
assertEquals("Label: VALUE_2", rootElement.selectSingleNode("//label[@for = '" + value2.valueOf("@id") + "']").getText());
assertEquals(value2, rootElement.selectSingleNode("//input[@checked]"));
}
public void testWithNullValue() throws Exception {
try {

40
org.springframework.web.servlet/src/test/java/org/springframework/web/servlet/tags/form/TestTypes.java Normal file
View File

@@ -0,0 +1,40 @@
package org.springframework.web.servlet.tags.form;
/**
* Test related data types for <code>org.springframework.web.servlet.tags.form</code> package.
*
* @author Scott Andrews
*/
public class TestTypes { }
class BeanWithEnum {
private TestEnum testEnum;
public TestEnum getTestEnum() {
return testEnum;
}
public void setTestEnum(TestEnum customEnum) {
this.testEnum = customEnum;
}
}
enum TestEnum {
VALUE_1, VALUE_2;
public String getEnumLabel() {
return "Label: " + name();
}
public String getEnumValue() {
return "Value: " + name();
}
public String toString() {
return "TestEnum: " + name();
}
}