cmlenz 01/09/27 08:32:38
Modified: src/doc struts-taglib.xml
Log:
Add the iterateLocks and iterateMembers tags to the documentation
Revision Changes Path
1.4 +269 -5 jakarta-slide/src/doc/struts-taglib.xml
Index: struts-taglib.xml
===================================================================
RCS file: /home/cvs/jakarta-slide/src/doc/struts-taglib.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- struts-taglib.xml 2001/09/25 07:40:36 1.3
+++ struts-taglib.xml 2001/09/27 15:32:38 1.4
@@ -43,7 +43,9 @@
<summary>
Expose the Slide domain as bean.
</summary>
- <tagclass>org.apache.slide.taglib.tag.struts.DomainTag</tagclass>
+ <tagclass>
+ org.apache.slide.taglib.tag.struts.DomainTag
+ </tagclass>
<bodycontent>JSP</bodycontent>
<info>
<p>
@@ -93,7 +95,9 @@
<summary>
Expose a specific Slide namespace as bean.
</summary>
- <tagclass>org.apache.slide.taglib.tag.struts.NamespaceTag</tagclass>
+ <tagclass>
+ org.apache.slide.taglib.tag.struts.NamespaceTag
+ </tagclass>
<bodycontent>JSP</bodycontent>
<info>
<p>
@@ -142,7 +146,9 @@
<summary>
Expose a particular ObjectNode in the Slide namespace as bean.
</summary>
- <tagclass>org.apache.slide.taglib.tag.struts.NodeTag</tagclass>
+ <tagclass>
+ org.apache.slide.taglib.tag.struts.NodeTag
+ </tagclass>
<bodycontent>JSP</bodycontent>
<info>
<p>
@@ -254,7 +260,9 @@
<summary>
Expose a revision-descriptor of an ObjectNode as bean.
</summary>
- <tagclass>org.apache.slide.taglib.tag.struts.RevisionTag</tagclass>
+ <tagclass>
+ org.apache.slide.taglib.tag.struts.RevisionTag
+ </tagclass>
<bodycontent>JSP</bodycontent>
<info>
<p>
@@ -319,7 +327,9 @@
<summary>
Expose a property of a node as bean.
</summary>
- <tagclass>org.apache.slide.taglib.tag.struts.PropertyTag</tagclass>
+ <tagclass>
+ org.apache.slide.taglib.tag.struts.PropertyTag
+ </tagclass>
<bodycontent>JSP</bodycontent>
<info>
<p>
@@ -372,6 +382,260 @@
<info>
<p>
Specifies the name of the property.
+ </p>
+ </info>
+ </attribute>
+ </tag>
+
+ <tag>
+ <name>iterateLocks</name>
+ <summary>
+ Iterate over all locks in a scope of the namespace, up to a specified
+ depth.
+ </summary>
+ <tagclass>
+ org.apache.slide.taglib.tag.struts.IterateLocksTag
+ </tagclass>
+ <bodycontent>JSP</bodycontent>
+ <info>
+ <p>
+ This tag extends the Struts <b>iterate</b> tag to provide an
+ iteration over the active locks in the namespace, starting at a
+ certain scope and up to a configurable depth.
+ </p>
+ <p>
+ The scope of the locks iteration is defined by the URI of the
+ parent node tag, thus the iterateLocks tag must be nested in a node
+ tag.
+ </p>
+ <p>
+ This tag exposes a <code>LockBean</code> for every step of the
+ iteration, which has the following properties:
+ <ul>
+ <li>
+ <b>objectUri:</b> the URI of the locked object
+ </li>
+ <li>
+ <b>subjectUri:</b> the URI of the subject that owns the lock
+ </li>
+ <li>
+ <b>typeUri:</b> the URI that defines the type of the lock,
+ pointing to an action node.
+ </li>
+ <li>
+ <b>expirationDate:</b> the expiration date of the lock, as
+ <code>java.util.Date</code> object
+ </li>
+ <li>
+ <b>isExclusive:</b> whether the lock is exclusive.
+ </li>
+ <li>
+ <b>isShared:</b> whether the lock is shared.
+ </li>
+ </ul>
+ The bean is only exposed inside the body of the iteration tag.
+ </p>
+ </info>
+ <attribute>
+ <name>id</name>
+ <required>false</required>
+ <rtexprvalue>false</rtexprvalue>
+ <info>
+ <p>
+ Specifies the name of the scripting variable (and associated page
+ scope attribute) under which the <code>LockBean</code>s will
+ be made available.
+ </p>
+ </info>
+ </attribute>
+ <attribute>
+ <name>depth</name>
+ <required>false</required>
+ <rtexprvalue>true</rtexprvalue>
+ <info>
+ <p>
+ Specifies the depth of the lock discovery.
+ </p>
+ </info>
+ </attribute>
+ <attribute>
+ <name>indexId</name>
+ <required>false</required>
+ <rtexprvalue>true</rtexprvalue>
+ <info>
+ <p>
+ The name of a page scope JSP bean that will contain the current
+ index of the collection on each iteration.
+ </p>
+ </info>
+ </attribute>
+ <attribute>
+ <name>length</name>
+ <required>false</required>
+ <rtexprvalue>true</rtexprvalue>
+ <info>
+ <p>
+ The maximum number of locks to be iterated through on this page.
+ This can be either an integer that directly expresses the
+ desired value, or the name of a JSP bean (in any scope) of type
+ <code>java.lang.Integer</code> that defines the desired value.
+ If not present, there will be no limit on the number of
+ iterations performed.
+ </p>
+ </info>
+ </attribute>
+ <attribute>
+ <name>offset</name>
+ <required>false</required>
+ <rtexprvalue>true</rtexprvalue>
+ <info>
+ <p>
+ The zero-relative index of the starting point at which the locks
+ will be iterated through. This can be either an integer that
+ directly expresses the desired value, or the name of a JSP bean
+ (in any scope) of type <code>java.lang.Integer</code> that
+ defines the desired value. If not present, zero is assumed
+ (meaning that the collection will be iterated from the beginning.
+ </p>
+ </info>
+ </attribute>
+ </tag>
+
+ <tag>
+ <name>iterateMembers</name>
+ <summary>
+ Iterate over all the children of a node, up to a specified depth.
+ </summary>
+ <tagclass>
+ org.apache.slide.taglib.tag.struts.IterateMembersTag
+ </tagclass>
+ <bodycontent>JSP</bodycontent>
+ <info>
+ <p>
+ This tag extends the Struts <b>iterate</b> tag to provide an
+ iteration over all the direct or indirect members of a node, up
+ to a specified depth. Optionally, nodes can be included or excluded
+ by their role and/or type.
+ </p>
+ <p>
+ The scope of the members iteration is defined by the URI of the
+ parent node tag, thus the iterateMembers tag must be nested in a
+ node tag.
+ </p>
+ <p>
+ This tag exposes a <code>NodeBean</code> for every step of the
+ iteration. See the documentation of the node tag for a list of
+ properties of the <code>NodeBean</code>.
+ </p>
+ </info>
+ <attribute>
+ <name>id</name>
+ <required>false</required>
+ <rtexprvalue>false</rtexprvalue>
+ <info>
+ <p>
+ Specifies the name of the scripting variable (and associated page
+ scope attribute) under which the <code>NodeBean</code>s will
+ be made available.
+ </p>
+ </info>
+ </attribute>
+ <attribute>
+ <name>depth</name>
+ <required>false</required>
+ <rtexprvalue>true</rtexprvalue>
+ <info>
+ <p>
+ Specifies the depth of the member traversal.
+ </p>
+ </info>
+ </attribute>
+ <attribute>
+ <name>excludeTypes</name>
+ <required>false</required>
+ <rtexprvalue>true</rtexprvalue>
+ <info>
+ <p>
+ Comma-separated list of node types (e.g. subject, action, group)
+ that should be excluded from the iteration.
+ </p>
+ </info>
+ </attribute>
+ <attribute>
+ <name>excludeRoles</name>
+ <required>false</required>
+ <rtexprvalue>true</rtexprvalue>
+ <info>
+ <p>
+ Comma-separated list of node roles (e.g. user, root) that should
+ be excluded from the iteration.
+ </p>
+ </info>
+ </attribute>
+ <attribute>
+ <name>includeTypes</name>
+ <required>false</required>
+ <rtexprvalue>true</rtexprvalue>
+ <info>
+ <p>
+ Comma-separated list of node types (e.g. subject, action, group)
+ that should be included in the iteration. Note that types listed
+ in excludeTypes will not be included, even if they are also
+ specified in this attribute.
+ </p>
+ </info>
+ </attribute>
+ <attribute>
+ <name>includeRoles</name>
+ <required>false</required>
+ <rtexprvalue>true</rtexprvalue>
+ <info>
+ <p>
+ Comma-separated list of node roles (e.g. user, root) that should
+ be included in the iteration. Note that roles listed
+ in includeRoles will not be included, even if they are also
+ specified in this attribute.
+ </p>
+ </info>
+ </attribute>
+ <attribute>
+ <name>indexId</name>
+ <required>false</required>
+ <rtexprvalue>true</rtexprvalue>
+ <info>
+ <p>
+ The name of a page scope JSP bean that will contain the current
+ index of the collection on each iteration.
+ </p>
+ </info>
+ </attribute>
+ <attribute>
+ <name>length</name>
+ <required>false</required>
+ <rtexprvalue>true</rtexprvalue>
+ <info>
+ <p>
+ The maximum number of members to be iterated through on this
+ page. This can be either an integer that directly expresses the
+ desired value, or the name of a JSP bean (in any scope) of type
+ <code>java.lang.Integer</code> that defines the desired value.
+ If not present, there will be no limit on the number of
+ iterations performed.
+ </p>
+ </info>
+ </attribute>
+ <attribute>
+ <name>offset</name>
+ <required>false</required>
+ <rtexprvalue>true</rtexprvalue>
+ <info>
+ <p>
+ The zero-relative index of the starting point at which members
+ will be iterated through. This can be either an integer that
+ directly expresses the desired value, or the name of a JSP bean
+ (in any scope) of type <code>java.lang.Integer</code> that
+ defines the desired value. If not present, zero is assumed
+ (meaning that the collection will be iterated from the beginning.
</p>
</info>
</attribute>
