blob: f57be59e580d695e3db04b7913e05faae4bdd9d9 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<meta name="Date-Revision-yyyymmdd" content="20140918"/>
<meta http-equiv="Content-Language" content="en"/>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Client Side Validation</title>
<link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css">
<link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet">
<link href="/css/main.css" rel="stylesheet">
<link href="/css/custom.css" rel="stylesheet">
<link href="/highlighter/github-theme.css" rel="stylesheet">
<script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
<script type="text/javascript" src="/bootstrap/js/bootstrap.js"></script>
<script type="text/javascript" src="/js/community.js"></script>
</head>
<body>
<a href="http://github.com/apache/struts" class="github-ribbon">
<img style="position: absolute; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png" alt="Fork me on GitHub">
</a>
<header>
<nav>
<div role="navigation" class="navbar navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<button type="button" data-toggle="collapse" data-target="#struts-menu" class="navbar-toggle">
Menu
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a href="/index.html" class="navbar-brand logo"><img src="/img/struts-logo.svg"></a>
</div>
<div id="struts-menu" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li class="dropdown">
<a data-toggle="dropdown" href="#" class="dropdown-toggle">
Home<b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="/index.html">Welcome</a></li>
<li><a href="/download.cgi">Download</a></li>
<li><a href="/releases.html">Releases</a></li>
<li><a href="/announce-2021.html">Announcements</a></li>
<li><a href="http://www.apache.org/licenses/">License</a></li>
<li><a href="https://www.apache.org/foundation/thanks.html">Thanks!</a></li>
<li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
</ul>
</li>
<li class="dropdown">
<a data-toggle="dropdown" href="#" class="dropdown-toggle">
Support<b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="/mail.html">User Mailing List</a></li>
<li><a href="https://issues.apache.org/jira/browse/WW">Issue Tracker</a></li>
<li><a href="/security.html">Reporting Security Issues</a></li>
<li class="divider"></li>
<li><a href="https://cwiki.apache.org/confluence/display/WW/Migration+Guide">Version Notes</a></li>
<li><a href="https://cwiki.apache.org/confluence/display/WW/Security+Bulletins">Security Bulletins</a></li>
<li class="divider"></li>
<li><a href="/maven/project-info.html">Maven Project Info</a></li>
<li><a href="/maven/struts2-core/dependencies.html">Struts Core Dependencies</a></li>
<li><a href="/maven/struts2-plugins/modules.html">Plugin Dependencies</a></li>
</ul>
</li>
<li class="dropdown">
<a data-toggle="dropdown" href="#" class="dropdown-toggle">
Documentation<b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="/birdseye.html">Birds Eye</a></li>
<li><a href="/primer.html">Key Technologies</a></li>
<li><a href="/kickstart.html">Kickstart FAQ</a></li>
<li><a href="https://cwiki.apache.org/confluence/display/WW/Home">Wiki</a></li>
<li class="divider"></li>
<li><a href="/getting-started/">Getting Started</a></li>
<li><a href="/security/">Security Guide</a></li>
<li><a href="/core-developers/">Core Developers Guide</a></li>
<li><a href="/tag-developers/">Tag Developers Guide</a></li>
<li><a href="/maven-archetypes/">Maven Archetypes</a></li>
<li><a href="/plugins/">Plugins</a></li>
<li><a href="/maven/struts2-core/apidocs/index.html">Struts Core API</a></li>
<li><a href="/tag-developers/tag-reference.html">Tag reference</a></li>
<li><a href="https://cwiki.apache.org/confluence/display/WW/FAQs">FAQs</a></li>
<li><a href="http://cwiki.apache.org/S2PLUGINS/home.html">Plugin registry</a></li>
</ul>
</li>
<li class="dropdown">
<a data-toggle="dropdown" href="#" class="dropdown-toggle">
Contributing<b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="/youatstruts.html">You at Struts</a></li>
<li><a href="/helping.html">How to Help FAQ</a></li>
<li><a href="/dev-mail.html">Development Lists</a></li>
<li><a href="/contributors/">Contributors Guide</a></li>
<li class="divider"></li>
<li><a href="/submitting-patches.html">Submitting patches</a></li>
<li><a href="/builds.html">Source Code and Builds</a></li>
<li><a href="/coding-standards.html">Coding standards</a></li>
<li><a href="https://cwiki.apache.org/confluence/display/WW/Contributors+Guide">Contributors Guide</a></li>
<li class="divider"></li>
<li><a href="/release-guidelines.html">Release Guidelines</a></li>
<li><a href="/bylaws.html">PMC Charter</a></li>
<li><a href="/volunteers.html">Volunteers</a></li>
<li><a href="https://gitbox.apache.org/repos/asf?p=struts.git">Source Repository</a></li>
<li><a href="/updating-website.html">Updating the website</a></li>
</ul>
</li>
<li class="apache"><a href="http://www.apache.org/"><img src="/img/apache.png"></a></li>
</ul>
</div>
</div>
</div>
</nav>
</header>
<article class="container">
<section class="col-md-12">
<a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/core-developers/client-side-validation.md" title="Edit this page on GitHub">Edit on GitHub</a>
<a href="validation" title="back to Validation"><< back to Validation</a>
<h1 class="no_toc" id="client-side-validation">Client Side Validation</h1>
<ul id="markdown-toc">
<li><a href="#basics" id="markdown-toc-basics">Basics</a></li>
<li><a href="#referencing-submitprofile-in-the-user-namespace" id="markdown-toc-referencing-submitprofile-in-the-user-namespace">Referencing “submitProfile” in the “/user” namespace</a></li>
<li><a href="#wont-work-with-client-side-validation" id="markdown-toc-wont-work-with-client-side-validation">Won’t work with client-side validation!</a></li>
<li><a href="#the-left-hand-doesnt-know-" id="markdown-toc-the-left-hand-doesnt-know-">The left hand doesn’t know …</a></li>
<li><a href="#client-side-validation-types" id="markdown-toc-client-side-validation-types">Client Side Validation Types</a></li>
</ul>
<h2 id="basics">Basics</h2>
<p>The framework adds support for client-side validation on top of the standard validation framework.</p>
<p>Client-side validation can be enabled on a per-form basis by specifying <code class="highlighter-rouge">validate="true"</code> in the <em>form</em> tag.</p>
<pre><code class="language-jsp">&lt;s:form name="test" action="javascriptValidation" validate="true"&gt;
...
&lt;/s:form&gt;
</code></pre>
<p>If a <code class="highlighter-rouge">name</code> for the form is not given, the action mapping name will be used as the form name. Otherwise, a correct
<code class="highlighter-rouge">action</code> and <code class="highlighter-rouge">namespace</code> attributes must be provided to the <code class="highlighter-rouge">&lt;saf:form&gt;</code> tag.</p>
<h2 id="referencing-submitprofile-in-the-user-namespace">Referencing “submitProfile” in the “/user” namespace</h2>
<pre><code class="language-jsp">&lt;s:form namespace="/user" action="submitProfile" validate="true"&gt;
...
&lt;/s:form&gt;
</code></pre>
<p>Technically, the form’s action attribute can refer to a “path” that includes the namespace and action as a URI.
But, client-side validation <strong>requires</strong> that the action name and namespeact to be set separately.</p>
<h2 id="wont-work-with-client-side-validation">Won’t work with client-side validation!</h2>
<pre><code class="language-jsp">&lt;s:form action="/user/submitProfile.action" validate="true"&gt;
...
&lt;/s:form&gt;
</code></pre>
<p>All the usual <a href="validation">validation configuration</a> steps apply to client-side validation. Client-side validation
uses the same validation rules as server-side validation. If server-side validation doesn’t work, then client-side
validation won’t work either.</p>
<h2 id="the-left-hand-doesnt-know-">The left hand doesn’t know …</h2>
<blockquote>
<p>The required attribute on many <em>Struts Tags</em> is not integrated with client-side validation! The tag attribute is used
by certain themes (like xhtml) to put a visual marker (usually ‘*’) next to the field. The tag doesn’t know
if the validation system actually “requires” the field or not.</p>
</blockquote>
<h2 id="client-side-validation-types">Client Side Validation Types</h2>
<p>There are two styles of client side validation.</p>
<table>
<thead>
<tr>
<th><a href="pure-java-script-client-side-validation">Pure JavaScript Client Side Validation</a></th>
<th>Used by the <em>xhtml theme</em> and <em>css_xhtml theme</em></th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="ajax-client-side-validation">AJAX Client Side Validation</a></td>
<td>Use to used by the <em>ajax theme</em></td>
</tr>
</tbody>
</table>
</section>
</article>
<footer class="container">
<div class="col-md-12">
Copyright &copy; 2000-2018 <a href="http://www.apache.org/">The Apache Software Foundation </a>.
All Rights Reserved.
</div>
<div class="col-md-12">
Apache Struts, Struts, Apache, the Apache feather logo, and the Apache Struts project logos are
trademarks of The Apache Software Foundation.
</div>
<div class="col-md-12">Logo and website design donated by <a href="https://softwaremill.com/">SoftwareMill</a>.</div>
</footer>
<script>!function (d, s, id) {
var js, fjs = d.getElementsByTagName(s)[0];
if (!d.getElementById(id)) {
js = d.createElement(s);
js.id = id;
js.src = "//platform.twitter.com/widgets.js";
fjs.parentNode.insertBefore(js, fjs);
}
}(document, "script", "twitter-wjs");</script>
<script src="https://apis.google.com/js/platform.js" async="async" defer="defer"></script>
<div id="fb-root"></div>
<script>(function (d, s, id) {
var js, fjs = d.getElementsByTagName(s)[0];
if (d.getElementById(id)) return;
js = d.createElement(s);
js.id = id;
js.src = "//connect.facebook.net/en_GB/all.js#xfbml=1";
fjs.parentNode.insertBefore(js, fjs);
}(document, 'script', 'facebook-jssdk'));</script>
</body>
</html>