• Java
    • JAXB Tutorial
      • What is JAXB
      • JAXB Marshalling Example
      • JAXB UnMarshalling Example
  • Spring Tutorial
    • Spring Core Tutorial
    • Spring MVC Tutorial
      • Quick Start
        • Flow Diagram
        • Hello World Example
        • Form Handling Example
      • Handler Mapping
        • BeanNameUrlHandlerMapping
        • ControllerClassNameHandlerMapping
        • SimpleUrlHandlerMapping
      • Validation & Exception Handling
        • Validation+Annotations
        • Validation+ResourceBundle
        • @ExceptionHandler
        • @ControllerAdvice
        • Custom Exception Handling
      • Form Tag Library
        • Textbox Example
        • TextArea Example
        • Password Example
        • Dropdown Box Example
        • Checkboxes Example
        • Radiobuttons Example
        • HiddenValue Example
      • Misc
        • Change Config file name
    • Spring Boot Tutorial
  • Hibernate Tutorial
  • REST Tutorial
    • JAX-RS REST @PathParam Example
    • JAX-RS REST @QueryParam Example
    • JAX-RS REST @DefaultValue Example
    • JAX-RS REST @Context Example
    • JAX-RS REST @MatrixParam Example
    • JAX-RS REST @FormParam Example
    • JAX-RS REST @Produces Example
    • JAX-RS REST @Consumes Example
    • JAX-RS REST @Produces both XML and JSON Example
    • JAX-RS REST @Consumes both XML and JSON Example
  • Miscellaneous
    • JSON Parser
      • Read a JSON file
      • Write JSON object to File
      • Read / Write JSON using GSON
      • Java Object to JSON using JAXB
    • CSV Parser
      • Read / Write CSV file
      • Read/Parse/Write CSV File – OpenCSV
      • Export data into a CSV File
      • CsvToBean and BeanToCsv – OpenCSV

JavaInterviewPoint

Java Development Tutorials

Spring MVC Checkbox And Checkboxes Example

December 22, 2014 by javainterviewpoint Leave a Comment

In this example, we will learn how to create checkbox in a Simple Spring MVC Form using Spring tag library. We will learn how to use the <form:checkbox> and <form:checkboxes> and the difference between those two. Here we will create a Spring MVC form with a checkbox through which we will get the users favoritesport and we will add validation support to check if the user is selecting at-least 1 checkbox.

In Spring MVC we will use <form:checkboxes> tag to render multiple check boxes

<form:checkboxes items="${favouriteList}" path="favourite"/>

Which produces the below HTML code.

 <span><input id="favourite1" name="favourite" type="checkbox" value="Football"/><label for="favourite1">Football</label></span>
<span><input id="favourite2" name="favourite" type="checkbox" value="Cricket"/><label for="favourite2">Cricket</label></span>
<span><input id="favourite3" name="favourite" type="checkbox" value="Hockey"/><label for="favourite3">Hockey</label></span>

Folder Structure :

  1. Create a Dynamic Web Project SpringMVCFormHandling and create a package for our src files “com.javainterviewpoint“
  2. Place the Spring 3 jar files under WEB-INF/Lib 

    commons-logging-1.1.1.jar
    log4j-1.2.16.jar
    slf4j-api-1.7.5.jar
    slf4j-log4j12-1.7.5.jar
    hibernate-validator-4.2.0.Final.jar
    spring-aspects-3.2.4.RELEASE.jar
    spring-beans-3.2.4.RELEASE.jar
    spring-context-3.2.4.RELEASE.jar
    spring-core-3.2.4.RELEASE.jar
    spring-expression-3.2.4.RELEASE.jar
    spring-web-3.2.4.RELEASE.jar
    spring-webmvc-3.2.4.RELEASE.jar
    validation-api-1.1.0.Final.jar
    jstl-1.1.2.jar

  3. Create the Java classes Checkbox_Controller.java and CheckboxBean.java under com.javainterviewpoint folder.
  4. Place the SpringConfig-servlet.xml and web.xml  under the WEB-INF directory
  5. View files SpringMVC_CheckboxExample.jsp and checkbox_Success.jsp are put under the sub directory under WEB-INF/Jsp

Controller

Checkbox_Controller.java

  • The DispatcherServlet mapping which we make in the web.xml will delegate the all the request to our Checkbox_Controller as we have annotated it with @Controller annotation.
  • We use the @RequestMapping annotation to map each of the requests which we get to individual methods. Our controller has three methods getFavouriteSports(),initializeForm() and  processForm(). 
  • The getFavouriteSports() method returns a list of sports which will be used by view for populating the favorite sports checkboxes.
  • The initializeForm() will take the user to the “SpringMVC_CheckboxExample” which is our view component with form backing object CheckboxBean.
  •  The processForm() method will get called when the user submits the form. The CheckboxBean object “cb”  will be validated as we have annotated it with @Valid annotation and the validation results will be added to the BindingResult. Based on the result we will re-direct the user back to the “SpringMVC_CheckboxExample” or “checkbox_Success” page.

Now lets see the difference between <form:checkbox> and <form:checkboxes>

If we use <form:checkbox> then we have to hard-code each value for example

<form:checkbox path="favourite" value="Football"/>Football
<form:checkbox path="favourite" value="Cricket"/>Cricket
<form:checkbox path="favourite" value="Hockey"/>Hockey

Where as when we use <form:checkboxes> we can dynamically pass in a list to populate the checkboxes.

<form:checkboxes items="${favouriteList}" path="favourite"/>

Here we have passed in a list “favouriteList” which gets the value from the controller class.

package com.javainterviewpoint;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import javax.validation.Valid;

import org.springframework.stereotype.Controller;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

@Controller
public class Checkbox_Controller 
{
	ModelAndView mav = null;
	@ModelAttribute("favouriteList")
	public List getFavouriteSports()
	{
		List favouriteList = new ArrayList();
		favouriteList.add("Football");
		favouriteList.add("Cricket");
		favouriteList.add("Hockey");
		return favouriteList;
	}
	
	@RequestMapping("/CheckboxExample")
	public String initializeForm(Map model)
	{
		CheckboxBean cb = new CheckboxBean();
		model.put("cb",cb);
		return "SpringMVC_CheckboxExample";
		
	}
	@RequestMapping("/processCheckbox")
	public String processForm(@Valid @ModelAttribute("cb") CheckboxBean cb,BindingResult result)
	{
		if(result.hasErrors())
		{
			System.out.println("Validation Failed");
			
			System.out.println(">>>>"+cb.getFavourite());
			return "SpringMVC_CheckboxExample";
		}
		else
		{
			System.out.println("Validated Successfully");
			System.out.println(">>>>"+cb.getFavourite());
			return "checkbox_Success";
		}
	}
}

Model

CheckboxBean.java

Here CheckboxBean acts as a Model which has a favorite property. We have added the annotation @NotEmpty to validate if the user has at least selected one of his favorite sports. The custom validation messages are added in the props.properties file.

package com.javainterviewpoint;

import java.util.List;

import org.hibernate.validator.constraints.NotEmpty;

public class CheckboxBean 
{
	@NotEmpty
	private List favourite;

	
	public List getFavourite() {
		return favourite;
	}

	public void setFavourite(List favourite) {
		this.favourite = favourite;
	}
}

View

SpringMVC_CheckboxExample.jsp

Our view component has multiple checkboxes generated using the Spring form tag library. The checkboxes gets its value from our controller class. @ModelAttribute(“favouriteList”) of our controller will be called and it will return a list of favourite sports when  <form:checkboxes items=”${favouriteList}” path=”favourite”/>  is called.<form:errors> tag displays the error message which occurs during the validation

<%@ page language="java" contentType="text/html; charset=ISO-8859-1"
 pageEncoding="ISO-8859-1"%>
 <%@ taglib uri="http://www.springframework.org/tags/form" prefix="form" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Insert title here</title>
<style>
.error {
 color: #ff0000;
}
 
.commonerrorblock {
 color: #000;
 background-color: #ffEEEE;
 border: 3px solid #ff0000;
 
}
</style>
</head>
<body>
 <form:form method="post" action="processCheckbox" commandName="cb">
 <form:errors path="*" element="div" cssClass="commonerrorblock"/>
 <table>
 <tr>
 <td>Favourite Sports</td>
 <td>
 <form:checkboxes items="${favouriteList}" path="favourite"/>
 </td>
 <td>
 <form:errors path="favourite" cssStyle="error"/>
 </td>
 </tr>
 <tr>
 <td></td><td><input type="submit"></td>
 </tr>
 </table>
 </form:form>
</body>
</html>

props.properties

NotEmpty.cb.favourite = Please select atleast on sports!!

checkbox_Success.jsp

<%@ page language="java" contentType="text/html; charset=ISO-8859-1"
 pageEncoding="ISO-8859-1"%>
 <%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Insert title here</title>
</head>
<body>
Favourite Sports selected : 
 <c:forEach items="${cb.favourite}" var="fav">
 <p><c:out value="${fav}"></c:out></p>
 </c:forEach>
</body>
</html>

Configurations

web.xml

The web.xml has everything about the application that a server needs to know, which is placed under the WEB-INF directory. <servlet-name> contains the name of the SpringConfiguration, when the DispatcherServlet is initialized the framework will try to load a configuration file “[servlet-name]-servlet.xml” under the WEB-INF directory.

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
	xsi:schemaLocation="http://java.sun.com/xml/ns/javaee	http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
	id="WebApp_ID" version="2.5">
	<display-name>SpringMVCFormHandling</display-name>
	<welcome-file-list>
		<welcome-file>index.html</welcome-file>
		<welcome-file>index.htm</welcome-file>
		<welcome-file>index.jsp</welcome-file>
		<welcome-file>default.html</welcome-file>
		<welcome-file>default.htm</welcome-file>
		<welcome-file>default.jsp</welcome-file>
	</welcome-file-list>
	<servlet>
		<servlet-name>SpringConfig</servlet-name>
		<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
	</servlet>
	<servlet-mapping>
		<servlet-name>SpringConfig</servlet-name>
		<url-pattern>/</url-pattern>
	</servlet-mapping>
</web-app>

SpringConfig-servlet.xml

  • The SpringConfig-servlet.xml is also placed under the WEB-INF directory.
  • <context:component-scan> will let the Spring Container to search for all the annotation under the package “com.javainteriviewpoint”. 
  • <mvc:annotation-driven/> annotation will activate the @Controller, @RequestMapping, @Valid etc annotations.
  • The view is resolved through “org.springframework.web.servlet.view.InternalResourceViewResolver” which searches for the jsp files under the /WEB-INF/Jsp/ directory.
  • Resource Bundle is accessed through the “org.springframework.context.support.ResourceBundleMessageSource”  through its property “basename” which has the value “props”, and hence our property file should “props.properties”
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation=" http://www.springframework.org/schema/beans	http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
 	http://www.springframework.org/schema/context	http://www.springframework.org/schema/context/spring-context-3.0.xsd
 	http://www.springframework.org/schema/mvc	http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd">

	<context:component-scan base-package="com.javainterviewpoint" />
	<mvc:annotation-driven />

	<bean
		class="org.springframework.web.servlet.view.InternalResourceViewResolver">
		<property name="prefix" value="/WEB-INF/Jsp/" />
		<property name="suffix" value=".jsp" />
	</bean>

	<bean id="messageSource"
		class="org.springframework.context.support.ResourceBundleMessageSource">
		<property name="basename" value="props"></property>
	</bean>
</beans>

Lets run our application

Now lets run our application, do a clean build and deploy the application in the Server

Hit on the url “http://localhost:8080/SpringMVCFormHandling/CheckboxExample”

SpringMVC_CheckBoxExample

Submit the form without selecting any checkbox

SpringMVC_CheckBoxExample_Validation

Upon successful validation, success page will be rendered to the user

SpringMVC_CheckBoxExample_Success

Other interesting articles which you may like …

  • Spring 3 MVC Hello World Example
  • Spring MVC Form Handling Example
  • Spring MVC Form Validation Tutorial (With Annotations)
  • Spring MVC Form Validation -Annotations and ResourceBundle
  • Spring MVC Exception Handling @ExceptionHandler
  • Spring MVC Exception Handling @ControllerAdvice and @ExceptionHandler
  • Spring MVC Custom Exception Handling
  • Spring MVC Textbox Example
  • Spring MVC Password Example
  • Spring MVC Dropdown Box Example
  • Spring MVC Radiobutton And Radiobuttons Example
  • Spring MVC TextArea Example
  • Spring MVC HiddenValue Example

Filed Under: J2EE, Java, Spring, Spring MVC, Spring Tutorial Tagged With: Checkbox And Checkboxes Example, Spring MVC, Spring MVC Checkbox, Spring MVC Checkbox Example

Leave a Reply Cancel reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Java Basics

  • JVM Architecture
  • Object in Java
  • Class in Java
  • How to Set Classpath for Java in Windows
  • Components of JDK
  • Decompiling a class file
  • Use of Class.forName in java
  • Use Class.forName in SQL JDBC

Oops Concepts

  • Inheritance in Java
  • Types of Inheritance in Java
  • Single Inheritance in Java
  • Multiple Inheritance in Java
  • Multilevel Inheritance in Java
  • Hierarchical Inheritance in Java
  • Hybrid Inheritance in Java
  • Polymorphism in Java – Method Overloading and Overriding
  • Types of Polymorphism in java
  • Method Overriding in Java
  • Can we Overload static methods in Java
  • Can we Override static methods in Java
  • Java Constructor Overloading
  • Java Method Overloading Example
  • Encapsulation in Java with Example
  • Constructor in Java
  • Constructor in an Interface?
  • Parameterized Constructor in Java
  • Constructor Chaining with example
  • What is the use of a Private Constructors in Java
  • Interface in Java
  • What is Marker Interface
  • Abstract Class in Java

Java Keywords

  • Java this keyword
  • Java super keyword
  • Final Keyword in Java
  • static Keyword in Java
  • Static Import
  • Transient Keyword

Miscellaneous

  • newInstance() method
  • How does Hashmap works internally in Java
  • Java Ternary operator
  • How System.out.println() really work?
  • Autoboxing and Unboxing Examples
  • Serialization and Deserialization in Java with Example
  • Generate SerialVersionUID in Java
  • How to make a class Immutable in Java
  • Differences betwen HashMap and Hashtable
  • Difference between Enumeration and Iterator ?
  • Difference between fail-fast and fail-safe Iterator
  • Difference Between Interface and Abstract Class in Java
  • Difference between equals() and ==
  • Sort Objects in a ArrayList using Java Comparable Interface
  • Sort Objects in a ArrayList using Java Comparator

Follow

  • Coding Utils

Useful Links

  • Spring 4.1.x Documentation
  • Spring 3.2.x Documentation
  • Spring 2.5.x Documentation
  • Java 6 API
  • Java 7 API
  • Java 8 API
  • Java EE 5 Tutorial
  • Java EE 6 Tutorial
  • Java EE 7 Tutorial
  • Maven Repository
  • Hibernate ORM

About JavaInterviewPoint

javainterviewpoint.com is a tech blog dedicated to all Java/J2EE developers and Web Developers. We publish useful tutorials on Java, J2EE and all latest frameworks.

All examples and tutorials posted here are very well tested in our development environment.

Connect with us on Facebook | Privacy Policy | Sitemap

Copyright ©2023 · Java Interview Point - All Rights Are Reserved ·