Home > Class Reference > ENSLIB namespace > %ZEN.Component.multiSelectSet

%ZEN.Component.multiSelectSet

class %ZEN.Component.multiSelectSet extends %ZEN.Component.listControl

This is a specialized control that displays a set of checkBoxes based on a list of values.
The list of values is specified by the valueList. This is a csv-list of values that the user can select. If displayList is provided, it is used to provide the displayed captions for the buttons.
If there is an empty value ("") within the items in valueList (e.g., ",A,B,C"), then an additional button will be displayed for the empty value. The caption for this empty value is specified by the emptyCaption.
It is assumed that every value within the set of value is distinct; A valueList containing duplicate items (e.g., "A,A,A") will lead to strange beahavior for the user.
The nominal value of the multiSelectSet is a csv-list of all options currently checked. The order of items appearing in this list will be the same as their listings in the original valueList provided.
It is possible to programmatically set the value of the multiSelectSet to any arbitary value using the setValue() method and providing either a single value or a csv-list of values. If no values in the list provided to the multiSelectSet corresponds to an item in the set of values, then all buttons in the set will be unchecked.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter DEFAULTLAYOUT = vertical;
Subclasses can set this to change the the default orientation of the options

Properties (Including Private)

property captionClass as %ZEN.Datatype.cssClass [ InitialExpression = "multiSelectSetCaption" ];
CSS class to apply to the control's captions.
Property methods: captionClassDisplayToLogical(), captionClassGet(), captionClassIsValid(), captionClassLogicalToDisplay(), captionClassLogicalToOdbc(), captionClassNormalize(), captionClassSet()
property emptyCaption as %ZEN.Datatype.caption [ InitialExpression = "None" ];
This caption is used for any radio buttons within this multiSelectSet that have an empty ("") display value.
Property methods: emptyCaptionDisplayToLogical(), emptyCaptionGet(), emptyCaptionIsValid(), emptyCaptionLogicalToDisplay(), emptyCaptionLogicalToOdbc(), emptyCaptionNormalize(), emptyCaptionSet()
property layout as %ZEN.Datatype.string (MAXLEN = 12, VALUELIST = ",horizontal,vertical") [ InitialExpression = ..#DEFAULTLAYOUT ];
Specifies how options within this group should be layed out. Valid values are "horizontal" and "vertical"
Property methods: layoutDisplayToLogical(), layoutGet(), layoutIsValid(), layoutLogicalToDisplay(), layoutLogicalToOdbc(), layoutNormalize(), layoutSet()
property optionCount as %ZEN.Datatype.integer [ InitialExpression = 0 ];
Count of options within this multiSelectSet.
Property methods: optionCountDisplayToLogical(), optionCountGet(), optionCountIsValid(), optionCountLogicalToDisplay(), optionCountLogicalToOdbc(), optionCountNormalize(), optionCountSet()
property titleList as %ZEN.Datatype.csv (ZENLOCALIZE = 1);
Defines set of titles (tooltip text) for each of the choices of this multiSelectSet as a csv-list.
Property methods: titleListDisplayToLogical(), titleListGet(), titleListIsValid(), titleListLogicalToDisplay(), titleListLogicalToOdbc(), titleListNormalize(), titleListSet()

Methods (Including Private)

method %DrawHTML()
Inherited description: Static HTML display method: draw the BODY of this component as HTML.
Subclasses implement this in order to render the static HTML contents of a component.
method %SetDefaultValues()
This method fills in reasonable default values for this control. Used by tools (such as Control Tester) to dynamically create controls.
clientmethod clickItem(choice) [ Language = javascript ]
User click on checkbox or caption for choice; select associated button and invoke callbacks.
clientmethod onloadHandler() [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is loaded.
clientmethod onupdateHandler() [ Language = javascript ]
Inherited description: This client method, if present, is fired when the object is updated from the server.
clientmethod selectAll() [ Language = javascript ]
Selects all options in the set
clientmethod selectNone() [ Language = javascript ]
Deselects all options in the set
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.

Inherited Members

Inherited Properties (Including Private)