isselect Element

Syntax

<isselect
  name        = simple_name       \\required
  iterator    = loop_var          \\required
  description = box_text          \\required
  value       = text_value        \\required
  condition   = "true" | "false"
  encoding    = "on" | "off"
/>
name = simple_name

Allowed data type: string or expression.

simple_name is a name for your list box. Note that the name you specify here is used when the browser sends the user selection as a key-value pair to the server. Therefore, the specified name must be equal to the input parameter required by the pipeline that processes the form values.

iterator = loop_var

loop_var specifies a loop variable. All elements of the loop variable are added to the list box.

description = box_text

box_text is text that is shown in the drop-down list box.

value = text_value

text_value is text sent back by the browser to the server as the value of a key-value pair. This can be used, for example, to return an internal product ID instead of the product name shown in the drop-down list box. The string specified by value is stored in the pipeline dictionary. The appropriate key is determined by the <isselect> attribute name.

condition = "true" | "false"

Allowed data type: expression. String is not allowed.

If condition is true, the appropriate list element is preselected. This has its counterpart in the selected attribute of the <option> HTML tag. Make sure that only one list element matches the condition to avoid undefined results in the browser.

encoding = "on" | "off"

Allowed data type: expression. String is not allowed.

Default value is on. With this attribute you can explicitly switch automatic HTML encoding of the output on and off. Encoding means converting any special characters, such as `<,' `>,' `&,' `",' as well as the named characters of the HTML 3.2 (Unicode 160-255) into their HTML counterparts. For example, the character ">" is converted to the string "&gt;."

Purpose

<isselect> can be used for easily implementing drop-down list boxes in an HTML form. <isselect> replaces the HTML tag <select> and its supporting tags. With the iterator attribute you can specify an iterator, whose elements appear in the list box. One element in the list box can be preselected by specifying a condition with the condition attribute. Make sure that the specified condition evaluates to true for only one element of the list, otherwise the browser might not show the list properly.

Example

In this example, <isselect> adds all elements of the iterator to an HTML list box that is generated.

<form action =... >
<isselect name = "PaymentMethodUserSelection"
iterator = "${PaymentMethodChoices}"
condition = "${PaymentMethod == PaymentMethodChoices}"
value = "${PaymentMethodChoices.UUID}"
description = "${PaymentMethodChoices.description}">
...
</form>