| <?xml version="1.0"?> |
| <document url="./struts-template.xml"> |
| |
| <properties> |
| <author>David Geary</author> |
| <title>The Struts Framework Project - Template Tags</title> |
| </properties> |
| |
| <body> |
| |
| |
| <taglib> |
| |
| <tlibversion>1.0</tlibversion> |
| <jspversion>1.1</jspversion> |
| <shortname>template</shortname> |
| <display-name>Template Tags</display-name> |
| <uri>http://jakarta.apache.org/struts/tags-template-1.0.2</uri> |
| <info> |
| This tag library contains three tags: put, get, and insert. Put tags |
| put content into request scope, which is retrieved by a get tag in |
| a different JSP page (the template). That template is included with the |
| insert tag. |
| </info> |
| |
| |
| <tag> |
| |
| <name>insert</name> |
| <summary> |
| Inserts (includes, actually) a template. Templates are JSP pages that |
| include parameterized content. That content comes from put tags that |
| are children of insert tags. |
| </summary> |
| <tagclass>org.apache.struts.taglib.template.InsertTag</tagclass> |
| <bodycontent>JSP</bodycontent> |
| <info> |
| This tag's enclosed put tags put content (URIs or text) into request |
| scope. That content is retrieved by get tags in a template (templates |
| are JSP pages). That template is included by this tag's end tag. |
| </info> |
| |
| <attribute> |
| <name>template</name> |
| <required>true</required> |
| <rtexprvalue>true</rtexprvalue> |
| <info> |
| A string representing the URI of a template (a JSP page). |
| </info> |
| </attribute> |
| |
| |
| </tag> |
| |
| |
| <tag> |
| |
| <name>put</name> |
| <summary> |
| Puts content into request scope. |
| </summary> |
| <tagclass>org.apache.struts.taglib.template.PutTag</tagclass> |
| <bodycontent>JSP</bodycontent> |
| <info> |
| Put content into request scope. |
| </info> |
| |
| <attribute> |
| <name>name</name> |
| <required>true</required> |
| <rtexprvalue>true</rtexprvalue> |
| <info> |
| The name of the content. |
| </info> |
| </attribute> |
| |
| <attribute> |
| <name>role</name> |
| <required>false</required> |
| <rtexprvalue>true</rtexprvalue> |
| <info> |
| If the user is in the specified role, the content is stored for |
| subsequent access by the get tag; otherwise, the content is ignored. |
| </info> |
| </attribute> |
| |
| <attribute> |
| <name>content</name> |
| <required>false</required> |
| <rtexprvalue>true</rtexprvalue> |
| <info> |
| Content that's put into request scope. |
| </info> |
| </attribute> |
| |
| <attribute> |
| <name>direct</name> |
| <required>false</required> |
| <rtexprvalue>true</rtexprvalue> |
| <info> |
| Determines how content is handled: true means content is |
| printed <i>direct</i>ly; false, the default, means content |
| is included. |
| </info> |
| </attribute> |
| </tag> |
| |
| |
| <tag> |
| |
| <name>get</name> |
| <summary> |
| Gets the content from request scope that was put there by a |
| put tag. |
| </summary> |
| <tagclass>org.apache.struts.taglib.template.GetTag</tagclass> |
| <bodycontent>empty</bodycontent> |
| <info> |
| Retrieve content from request scope and include it. |
| </info> |
| |
| <attribute> |
| <name>flush</name> |
| <required>false</required> |
| <rtexprvalue>true</rtexprvalue> |
| <info> |
| If set to <code>true</code>, flush the response buffer prior to |
| including the content specified by the <code>name</code> attribute. |
| By default, the response is not flushed. <strong>NOTE</strong> - |
| this attribute exists only to work around problems on some containers; |
| flushing should never be required. |
| </info> |
| </attribute> |
| |
| <attribute> |
| <name>name</name> |
| <required>true</required> |
| <rtexprvalue>true</rtexprvalue> |
| <info> |
| The name of the content to get from request scope. |
| </info> |
| </attribute> |
| |
| <attribute> |
| <name>role</name> |
| <required>false</required> |
| <rtexprvalue>true</rtexprvalue> |
| <info> |
| If the user is in the specified role, the content is retrieved, |
| otherwise, the content is ignored. |
| </info> |
| </attribute> |
| |
| </tag> |
| |
| |
| </taglib> |
| |
| </body> |
| |
| </document> |
