dmkarr 2002/10/19 17:24:24
Added: contrib/struts-el/src/share/org/apache/strutsel package.html
Log:
first draft of strutsel package description
Revision Changes Path
1.1
jakarta-struts/contrib/struts-el/src/share/org/apache/strutsel/package.html
Index: package.html
===================================================================
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<base/>
<title>Package Documentation for org.apache.strutsel Package</title>
</head>
<body bgcolor="white">
<p>
<a name="doc.Description">The "Struts-EL" library</a>
contains a set of tag libraries, all of whose classes are derived from
classes in the Struts tag libraries. The Struts-EL tags all implement the
same attributes as their counterparts in the base Struts tag libraries. The
difference provided by Struts-EL is that the tag attribute values are not
evaluated as run-time scriptlets (sometimes called "rtexprvalue"s), but are
instead evaluated by the expression language engine in the JavaServer Pages
Standard Tag Library (often called the JSTL).
</p>
<div align="Center">
<p>
<a href="#doc.Intro">[Introduction]</a>
<a href="#doc.Html">[HTML-EL Tag Library]</a>
<a href="#doc.Logic">[Logic-EL Tag Library]</a>
<a href="#doc.Bean">[Bean-EL Tag Library]</a>
</div>
<hr>
<h3><a name="doc.Intro">Introduction</a></h3>
<p>
The Struts-EL library is intended to be used alongside the Struts library,
and with the JSTL. In the development of the Struts-EL library, each tag in
the Struts tag libraries was examined to see if all of its functionality is
covered in an existing tag in the JSTL. If this was the case, then it was
decided to <strong>not</strong> include a version of this tag in the
Struts-EL library. The tags that were "ported" to Struts-EL were deemed to
have functionality which the JSTL could not directly cover.
</p>
<p>
The rest of this package description will briefly review the Struts tags
which were <strong>not</strong> ported to the Struts-EL library (or which
were "on the bubble", and why. The detailed package descriptions for each
section of the library (html-el, logic-el, and bean-el) will demonstrate in
detail the usage of the Struts-EL tags, focusing on attribute value
evaluation issues. Details of the operation of these tags in the Struts
framework can be learned from the package descriptions and documentation for
the base Struts library.
</p>
<hr>
<h3><a name="doc.Html">HTML-EL tag library</a></h3>
This is a short section. The JSTL does not include any functionality for
generating HTML elements, thus every tag in the "struts-html" tag library was
ported to the "struts-html-el" tag library.
<hr>
<h3><a name="doc.Logic">Logic-EL tag library</a></h3>
<p>
The following table lists the "struts-logic" tags which were not ported to
the "struts-logic-el" tag library, including which JSTL elements or features
will provide that functionality. Examples after the table will demonstrate
these.
</p>
<table border="1">
<tr>
<th>Struts-Logic tag</th>
<th>JSTL tags or feature</th>
</tr>
<tr>
<td>empty</td>
<td>c:if, c:when, EL</td>
</tr>
<tr>
<td>equal</td>
<td>c:if, c:when, EL</td>
</tr>
<tr>
<td>greaterEqual</td>
<td>c:if, c:when, EL</td>
</tr>
<tr>
<td>greaterThan</td>
<td>c:if, c:when, EL</td>
</tr>
<tr>
<td>lessEqual</td>
<td>c:if, c:when, EL</td>
</tr>
<tr>
<td>lessThan</td>
<td>c:if, c:when, EL</td>
</tr>
<tr>
<td>notEmpty</td>
<td>c:if, c:when, EL</td>
</tr>
<tr>
<td>notEqual</td>
<td>c:if, c:when, EL</td>
</tr>
<tr>
<td>notPresent</td>
<td>c:if, c:when, EL</td>
</tr>
<tr>
<td>present</td>
<td>c:if, c:when, EL</td>
</tr>
</table>
<p>
In general, the "conditional" features provided by these tags in the
"struts-logic" tag library are incorporated into the JSTL expression
language itself. Note that some features of the "logic:present" tag,
related to "roles" and "users" is not available in the JSTL. This will be
addressed in a future minor release of Struts-EL.
</p>
<p>
The following are some examples of "Before" and "After", where the first
example is pure Struts usage, and the second example will be pure JSTL
usage, not involving Struts-EL at all.
</p>
<p><i>Struts Example:</i></p>
<pre>
<logic:empty name="foo" property="stuff">
Some stuff
</logic:empty></pre>
<p><i>JSTL Version:</i> </p>
<pre>
<c:if test="${empty foo.stuff}">
Some stuff
</c:if></pre>
<p><i>Struts Example:</i></p>
<pre>
<logic:notEmpty name="foo" property="stuff">
Some stuff
</logic:notEmpty></pre>
<p><i>JSTL Version:</i></p>
<pre>
<c:if test="${!empty foo.stuff}">
Some stuff
</c:if></pre>
<p><i>Struts Example:</i></p>
<pre>
<logic:equal name="foo" property="stuff"
value="<%=thing.getStuff()%>">
Some stuff
</logic:equal></pre>
<p><i>JSTL Version:</i></p>
<pre>
<%-- Assumes "thing" is a scoped variable --%>
<c:if test="${foo.stuff eq thing.stuff}">
Some stuff
</c:if></pre>
<p><i>Struts Example:</i></p>
<pre>
<logic:greaterThan name="foo" property="stuff"
value="<%=thing.getStuff()%>">
Some stuff
</logic:empty></pre>
<p><i>JSTL Version:</i></p>
<pre>
<%-- Assumes "thing" is a scoped variable --%>
<c:if test="${foo.stuff ge thing.stuff}">
Some stuff
</c:if></pre>
<p><i>Struts Example:</i></p>
<pre>
<logic:present cookie="shoppingCart">
Some stuff
</logic:present></pre>
<p><i>JSTL Version:</i></p>
<pre>
<c:if test='${!empty cookie["shoppingCart"]}">
Some stuff
</c:if></pre>
<p><i>Struts Example:</i></p>
<pre>
<logic:present header="User-Agent">
Some stuff
</logic:present></pre>
<p><i>JSTL Version:</i></p>
<pre>
<c:if test='${!empty header["User-Agent"]}">
Some stuff
</c:if></pre>
<hr>
<h3><a name="doc.Bean">Bean-EL tag library</a></h3>
<p>
The following table lists the "struts-bean" tags which were not ported to
the "struts-bean-el" tag library, including which JSTL elements or features
will provide that functionality. Examples after the table will demonstrate
these.
</p>
<table border="1">
<tr>
<th>Struts-Bean tag</th>
<th>JSTL tags or feature</th>
</tr>
<tr>
<td>cookie</td>
<td>c:set, EL</td>
</tr>
<tr>
<td>define</td>
<td>c:set, EL</td>
</tr>
<tr>
<td>header</td>
<td>c:set, EL</td>
</tr>
<tr>
<td>include</td>
<td>c:import</td>
</tr>
<tr>
<td>parameter</td>
<td>c:set, EL</td>
</tr>
<tr>
<td>write</td>
<td>c:out</td>
</tr>
</table>
<p>
Note that the "bean:resource" Struts tag is similar, at least superficially,
to the functionality of the "c:import" tag, but "bean:resource"
<strong>was</strong> ported to the Struts-EL library. This is because
resources requested through the "c:import" tag may be processed through a
mapped servlet, preventing direct access to the resource. The
"bean:resource" tag allows direct access to the resource, without an
intervening servlet. For instance, if it is desired to obtain the raw text
of a JSP page, using "c:import" will not work, because the JSP page will be
processed by the JSP servlet. However, using "bean:resource" will retrieve
just the text of the JSP page, if that is desired.
</p>
<p>
Also note that some functionality of the "bean:include" tag, which was not
ported to the Struts-EL library, is not available in the JSTL. This
includes the ability to specify the name of a Struts forward, and the
ability to include the current transaction control token. These features
will be addressed in a future minor release of Struts-EL.
</p>
<p>
The following are some examples of "Before" and "After", where the first
example is pure Struts usage, and the second example will be pure JSTL
usage, not involving Struts-EL at all.
</p>
<p><i>Struts Example:</i></p>
<pre>
<bean:cookie id="cookieVal" name="stuff"/></pre>
<p><i>JSTL Version:</i></p>
<pre>
<c:set var="cookieVal" value='${cookie["stuff"]}'/></pre>
<p><i>Struts Example:</i></p>
<pre>
<bean:define id="thing" name="foo" property="stuff"/></pre>
<p><i>JSTL Version:</i></p>
<pre>
<c:set var="thing" value="${foo.stuff}"/></pre>
<p><i>Struts Example:</i></p>
<pre>
<bean:header id="headerVal" name="stuff"/></pre>
<p><i>JSTL Version:</i></p>
<pre>
<c:set var="headerVal" value='${header["stuff"]}'/></pre>
<p><i>Struts Example:</i></p>
<pre>
<bean:include id="stuffOut" href="http://somewhere.com/stuff.jsp"/></pre>
<p><i>JSTL Version:</i></p>
<pre>
<c:import var="stuffOut" value="http://somewhere.com/stuff.jsp"/></pre>
<p><i>Struts Example:</i></p>
<pre>
<bean:parameter id="parameterVal" name="stuff"/></pre>
<p><i>JSTL Version:</i></p>
<pre>
<c:set var="parameterVal" value='${param["stuff"]}'/></pre>
</body>
</html>
--
To unsubscribe, e-mail: <mailto:struts-dev-unsubscribe@;jakarta.apache.org>
For additional commands, e-mail: <mailto:struts-dev-help@;jakarta.apache.org>
