class %ZEN.Component.checkbox
extends control
Boolean checkbox control
This uses an HTML input=check control plus it displays a
caption (caption) next to the checkbox
and detects user mouse click on caption.
Unlike an HTML checkbox, this checkbox always submits a value.
It submits a value of 1 or 0 to the server; The client side
value is either true or false.
• parameter DEFAULTCLIENTTYPE = "boolean";
The default value for the clientType property.
• parameter DEFAULTCONTROLCLASS = "checkbox";
The default css class used for the main element within this control. This
is overridden by subclasses.
• parameter DOMAIN = "%ZEN";
• property caption
as %ZEN.Datatype.caption(ZENEXPRESSION=1);
Additional caption displayed next to actual checkbox.
This is a localized value.
• property captionClass
as %ZEN.Datatype.cssClass [ InitialExpression = "checkboxCaption" ];
CSS class to apply to the control's caption.
• property readonlyNobox
as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If this is true then no checkbox will be built. Instead, it will write "Yes" or "No" based on the checkbox's value.
• 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 clickCaption()
[ Language = javascript ]
User click on caption for checkbox; toggle value;
• method clickCheckbox()
[ Language = javascript ]
User click on checkbox; update hidden value;
• method getProperty(property, key)
as %String
[ Language = javascript ]
Override to get value of control
• method onSerialize()
[ Language = javascript ]
Get current value for serial state.
• method setProperty(property, value, value2)
[ Language = javascript ]
Set the value of a named property.
