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

%ZEN.Component.multiSelectSet


class %ZEN.Component.multiSelectSet extends 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.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 5 11


Summary


Properties
%condition %import %includeFiles %page
%resource align aux captionClass
choiceColumn clientType composite containerStyle
controlClass controlStyle dataBinding disabled
displayList dragEnabled dropEnabled emptyCaption
enclosingClass enclosingStyle error height
hidden hint hintClass hintStyle
id index invalid invalidMessage
label labelClass labelDisabledClass labelStyle
layout maxRows name onafterdrag
onbeforedrag onblur onchange onclick
ondblclick ondrag ondrop onfocus
onhide onkeydown onkeypress onkeyup
onmousedown onmouseout onmouseover onmouseup
onrefresh onshow onsubmit ontouchend
ontouchmove ontouchstart onupdate onvalidate
optionCount originalValue parameters parent
queryClass queryName readOnly required
requiredMessage showLabel slice sql
tabIndex title titleList tuple
valign value valueColumn valueList
visible width window

Methods
%AddToSaveSet %Attr %BindExport %BuildValueLists
%ClassIsLatestVersion %ClassName %ConstructClone %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %DrawComponentHTML %DrawHTML
%DrawJSStrings %EnclosingDivId %Eval %EvalC
%Extends %ForceClientRender %GetEventHandlers %GetForm
%GetParameter %GetXMLName %IsA %IsModified
%MakeId %Name %New %NormalizeObject
%ObjectModified %OnAddToPageAfter %OnAddToPageBefore %OnDrawEnclosingDiv
%OnDrawObjectProperties %OnObjectSynch %OnZENDeserialize %OriginalNamespace
%PackageName %QuoteValue %QuoteValueL10N %RemoveFromSaveSet
%Self %SerializeObject %SetDefaultValues %SetModified
%ValidateObject XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType clickItem dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
exposeComponent findElement fireOnUpdateEvent focus
formatValue getDisabled getDragData getEnclosingDiv
getForm getHidden getHintElement getInvalidReason
getLabelElement getProperty getReadOnly getSettings
getType getValue invokeSuper isModified
isOfType isValid makeId normalizeValue
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onStartModalHandler
onchangeHandler onloadHandler onunloadHandler onupdateHandler
refreshContents render renderContents renderSVG
select selectAll selectNone setDisabled
setHidden setOverlayMode setProperty setReadOnly
setValue startProgressBar stopProgressBar sysName
unformatValue validationHandler


Parameters


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

Properties


• property captionClass as %ZEN.Datatype.cssClass [ InitialExpression = "multiSelectSetCaption" ];
CSS class to apply to the control's captions.
• 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 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 optionCount as %ZEN.Datatype.integer [ InitialExpression = 0 ];
Count of options within this multiSelectSet.
• 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.

Methods


• method %DrawHTML()
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.
• method clickItem(choice) [ Language = javascript ]
User click on checkbox or caption for choice; select associated button and invoke callbacks.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method onupdateHandler() [ Language = javascript ]
This client method, if present, is fired when the object is updated from the server.
• method selectAll() [ Language = javascript ]
Selects all options in the set
• method selectNone() [ Language = javascript ]
Deselects all options in the set
• method setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.