blob: c5370c37a9b3bfa839d975d8cbe1c9ea2b2ecbaf [file] [log] [blame]
<!--
This file is generated during the build by processing Component class annotations.
Please do not edit it directly.
-->
<html>
<head>
<title>iterator</title>
</head>
<body>
<h1>Tag Name: iterator</h1>
<h2>Description</h2>
<p>
<!-- START SNIPPET: tagdescription -->
Iterate over a iterable value
<!-- END SNIPPET: tagdescription -->
</p>
<h2>Attributes</h2>
<!-- START SNIPPET: tagattributes -->
<table width="100%">
<tr>
<td colspan="6"><h4>Dynamic Attributes Allowed:</h4> false</td>
</tr>
<tr>
<td colspan="6">&nbsp;</td>
</tr>
<tr>
<th align="left" valign="top"><h4>Name</h4></th>
<th align="left" valign="top"><h4>Required</h4></th>
<th align="left" valign="top"><h4>Default</h4></th>
<th align="left" valign="top"><h4>Evaluated</h4></th>
<th align="left" valign="top"><h4>Type</h4></th>
<th align="left" valign="top"><h4>Description</h4></th>
</tr>
<tr>
<td align="left" valign="top">begin</td>
<td align="left" valign="top">false</td>
<td align="left" valign="top">0</td>
<td align="left" valign="top">false</td>
<td align="left" valign="top">Integer</td>
<td align="left" valign="top">if specified the iteration will start on that index</td>
</tr>
<tr>
<td align="left" valign="top">end</td>
<td align="left" valign="top">false</td>
<td align="left" valign="top">Size of the 'values' List or array, or 0 if 'step' is negative</td>
<td align="left" valign="top">false</td>
<td align="left" valign="top">Integer</td>
<td align="left" valign="top">if specified the iteration will end on that index(inclusive)</td>
</tr>
<tr>
<td align="left" valign="top">status</td>
<td align="left" valign="top">false</td>
<td align="left" valign="top">false</td>
<td align="left" valign="top">false</td>
<td align="left" valign="top">Boolean</td>
<td align="left" valign="top">If specified, an instanceof IteratorStatus will be pushed into stack upon each iteration</td>
</tr>
<tr>
<td align="left" valign="top">step</td>
<td align="left" valign="top">false</td>
<td align="left" valign="top">1</td>
<td align="left" valign="top">false</td>
<td align="left" valign="top">Integer</td>
<td align="left" valign="top">if specified the iteration index will be increased by this value on each iteration. It can be a negative value, in which case 'begin' must be greater than 'end'</td>
</tr>
<tr>
<td align="left" valign="top">value</td>
<td align="left" valign="top">false</td>
<td align="left" valign="top"></td>
<td align="left" valign="top">false</td>
<td align="left" valign="top">String</td>
<td align="left" valign="top">the iteratable source to iterate over, else an the object itself will be put into a newly created List</td>
</tr>
<tr>
<td align="left" valign="top">var</td>
<td align="left" valign="top">false</td>
<td align="left" valign="top"></td>
<td align="left" valign="top">false</td>
<td align="left" valign="top">String</td>
<td align="left" valign="top">Name used to reference the value pushed into the Value Stack</td>
</tr>
</table>
<!-- END SNIPPET: tagattributes -->
</body>
</html>