WOBrowser

Element Description

WOBrowser displays itself as a selection list that displays multiple items at a time. The related element WOPopUpButton is similar to WOBrowser except that it restricts the display to only 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

WOBrowser { list=anArray; item=anItem; [displayString=displayValue; value=optionValue;] [escapeHTML=aBoolean;] [selections=objectArray; | selectedValues=valueArray;] [name=fieldName;] [disabled=aBoolean;] [multiple = aBoolean;] [size=anInt;]... };

Bindings

list: Array of objects from which the browser derives its values. For example, colleges could name the list containing objects that represent individual schools.

item: Identifier for the elements of the list. For example, aCollege could represent an object in the 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>). This value can be used as an identifier of an item in the list.

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 interpretted as HTML control characters, you get better performance if you set escapeHTML to false (or NO).

selections: Array of objects that the user chose from list. For the college example, selections would hold college objects.

selectedValues: Array of values that is used with DirectActions to specify which options in a list are 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, selections won't contain the user's selection when the page is submitted.

multiple: If multiple evaluates to true (or YES), the user can select multiple items from the list. Otherwise, the user can select only one item from the list. The default is false (or NO).

size: How many items to display at one time. The default is 5. size must be greater than 1.