ZUML Reference/ZUML/Attributes/forEach

Syntax:

forEach="${an-EL-expr}"
forEach="an-value, ${an-EL-expr}"

The forEach attribute is used to specify a collection of object such that the XML element it belongs will be evaluated repeatedly for each object of the collection.

There are two formats. First, you specify a value without comma. The value is usually a collection of objects, such that the associated element will be evaluated repeatedly against each object in the collection. If not specified or empty, this attribute is ignored. If non-collection object is specified, it is evaluated only once as if a single-element collection is specified.

Second, you can specify a list of values by separating them with comma. Then, the associated element will be evaluated repeatedly against each value in the list.

For each iteration, two variables, each and forEachStatus, are assigned automatically to let developers control how to evaluate the associated element.

<hbox>
	<zscript>
		classes = new String[] {"College", "Graduate"};
		grades = new Object[] {
			new String[] {"Best", "Better"}, new String[] {"A++", "A+", "A"}
		};
	</zscript>
	<listbox width="200px" forEach="${classes}">
		<listhead>
			<listheader label="${each}" />
		</listhead>
		<listitem label="${forEachStatus.previous.each}: ${each}"
			forEach="${grades[forEachStatus.index]}" />
	</listbox>
</hbox>

When ZK Loader iterates through items of the give collection, it will update two implicit objects: each and forEachStatus. The each variable represents the item being iterated, while forEachStatus is an instance of ForEachStatus, from which you could retrieve the index and the previous forEach, if any.

If you prefer to iterate only a portion of a collection, you could specify forEachBegin and/or forEachEnd.

Version History

Version	Date	Content