WOPopUpButton

Element Description

WOPopUpButton, when clicked, displays itself as a selection list that allows the user to select only one item at a time. The related element WOBrowser is similar to WOPopUpButton except that it allows the user to select more than one item at a time.

You should provide the title of an item in displayString rather than in value. If there is no binding for displayString, the string assigned to value is used for the item.

Synopsis

WOPopUpButton { list=anArray; item=anItem; displayString=displayedValue; [value=optionValue;] [selection=theSelection; | selectedValue=selectedValue;] [name=fieldName;] [disabled=aBoolean;] [escapeHTML=aBoolean;] [noSelectionString=aString]... };

Bindings

list: Array of objects from which the WOPopUpButton derives its values.

item: Identifier for the elements of the list. For example, aCollege could represent an object in a colleges array.

displayString: Value to display in the selection list; for example, aCollege.name for each college object in the list.

value: For each OPTION tag within the selection, this is the "value" attribute (that is, <OPTION value="someValue">). You can use this binding to specify additional identifiers of each item in the menu.

selection: Object that the user chose from the selection list. For the college example, selection would be a college object.

selectedValue: Value that is used with DirectActions to specify which option in the list is selected.

name: Name that uniquely identifies this element within the form. You can specify a name or let WebObjects automatically assign one at runtime.

disabled: If disabled evaluates to true (or YES), this element appears in the page but is not active. That is, selection does not contain the user's selection when the page is submitted.

escapeHTML: If escapeHTML evaluates to true (or YES), the string rendered by displayString is converted so that characters which would be interpreted as HTML control characters become their escaped equivalent (this is the default). Thus, if a your displayString is "a bold idea", the string passed to the client browser would be "a bold idea", but it would display in the browser as "a bold idea". If escapeHTML evaluates to false (or NO), WebObjects simply passes your data to the client browser "as is." In this case, the above example would display in the client browser as "a bold idea". If you are certain that your strings have no characters in them which might be interpreted as HTML control characters, you get better performance if you set escapeHTML to false (or NO).

noSelectionString: Enables the first item to be "empty." Bind this attribute to a string (such as an empty string) that, if chosen, represents an empty selection. When this item is selected, the selection attribute is set to nil or null.