PATH WebObjects 4.0 Documentation > Dynamic Elements

WOCheckBoxList

Synopsis

WOCheckBoxList { list=anObjectList; item=anIteratedObject; displayString=displayedValue; [value=aValue;] [index=aNumber;] [prefix=prefixString;] [suffix=suffixString;] [selections=selectedValues;] [name=fieldName;] [disabled=YES|NO;] [escapeHTML=YES|NO;]... };

Description

WOCheckBoxList displays a list of check boxes. The user may select several of the objects in the list, and this sublist is returned as selections.

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

Bindings

list Array of objects that the WOCheckBoxList will iterate through.
item Current item in the list array. (This attribute's value is updated with each iteration.)
displayString String to display beside the check box for the current item.
value Value for the INPUT tag of the current item (INPUT type="Checkbox" value="someValue">. You can use this binding as an additional identifier of the itme.
index Index of the current iteration of the WOCheckBoxList.
prefix An arbitrary HTML string inserted before each value.
suffix An arbitrary HTML string inserted after each value.
selections An array of objects that the user chose from the list.
name Name that uniquely identifies this element within the form. You may specify a name or let WebObjects automatically assign one at runtime.
disabled If disabled evaluates to YES, this element appears in the page but is not active.
escapeHTML If escapeHTML is YES (the default), the string rendered by displayString is converted so that characters which would be interpretted as HTML control characters become their escaped equivalent. By default, WebObjects tries to ensure that data displays in the client browser just as it does in a normal editor. 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 is 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 NO.