<checkbox>

The checkbox tag provides a simple toggle button.

JavaScript: checkbox

Extends Baseformitem

The <checkbox> tag provides a simple toggle button that represents a value of true or false. It has a disabled state where it does not respond to mouse events when enabled=false.

Example 1. simple checkbox
<canvas debug="true" height="160">
  <debug x="135" y="15"/>
  <checkbox id="checkMe" text="Show Green Square"/>
  <view visible="${checkMe.value}" bgcolor="green" width="20" height="20"/>

  <button text="Toggle" onclick="checkMe.setAttribute('value', !checkMe.value)"/>
  <button text="Disable" onclick="checkMe.setAttribute('enabled', false)"/>
  <button text="Enable" onclick="checkMe.setAttribute('enabled', true)"/>
  <button text="status" onclick="Debug.write('value: '+checkMe.value)"/>
  <simplelayout axis="y" spacing="4"/>
</canvas>

Note that checkbox attributes may be used as constraints for other attributes. In the example above, clicking the checkbox toggles the visibility of the green square. Whenever the value of the checkbox changes, so does the visibility attribute of the green view.

See Also:
Attributes
Name Usage Type (Tag) Type (JS) Default Category
text_y Tag & JS number Number   setter
 

the y position of the text label. default: centered



Attributes inherited from Basecomponent

doesenter, enabled, hasdefault, isdefault, style, styleable, text

Attributes inherited from Baseformitem

changed, ignoreform, onchanged, onvalue, rollbackvalue, submit, submitname

Attributes inherited from Basevaluecomponent

value

Attributes inherited from Node

class, classroot, cloneManager, datapath, id, ignoreAttribute, ignoreplacement, immediateparent, initstage, name, nodeLevel, onconstruct, oninit, parent, placement, subnodes

Attributes inherited from View

aaactive, aadescription, aaname, aasilent, aatabindex, align, bgcolor, clickable, clickregion, clip, cursor, defaultplacement, fgcolor, focusable, focustrap, font, fontsize, fontstyle, frame, framesloadratio, hassetheight, hassetwidth, height, layout, loadratio, mask, onblur, onclick, ondata, ondblclick, onfocus, onkeydown, onkeyup, onmousedown, onmouseout, onmouseover, onmouseup, onselect, opacity, options, pixellock, play, resource, resourceheight, resourcewidth, rotation, selectiontype, showhandcursor, source, stretches, subviews, totalframes, unstretchedheight, unstretchedwidth, valign, visible, width, x, xoffset, y, yoffset


Methods

doSpaceUp()
checkbox.doSpaceUp()

toggles the value when the space bar is pressed while focused



setValue()
checkbox.setValue(val)

setter for 'value' attribute. The checkbox value is always true or false.

Parameters
Name Type Desc
val can be any Javascript type and is evaluated as its boolean equivalent, strings "true" and "false" are treated specially to represent true and false respectively


Methods inherited from basecomponent

doEnterDown, doEnterUp, doSpaceDown, doSpaceUp, setStyle, setTint, updateDefault

Methods inherited from baseformitem

applyData, commit, findForm, init, rollback, setChanged, setValue, toXML, updateData

Methods inherited from basevaluecomponent

getValue

Methods inherited from LzNode

animate, applyConstraint, childOf, completeInstantiation, createChildren, dataBindAttribute, destroy, determinePlacement, getAttribute, getOption, getUID, lookupSourceLocator, searchImmediateSubnodes, searchSubnodes, setAttribute, setDatapath, setID, setName, setOption

Methods inherited from LzView

addProxyPolicy, addSubview, bringToFront, construct, containsPt, getAttributeRelative, getBounds, getColor, getColorTransform, getContextMenu, getCurrentTime, getDepthList, getHeight, getID3, getMouse, getPan, getTotalTime, getVolume, getWidth, measureHeight, measureWidth, play, releaseLayouts, removeProxyPolicy, searchParents, searchSubviews, seek, sendBehind, sendInFrontOf, sendToBack, setAAActive, setAADescription, setAAName, setAASilent, setAATabIndex, setAlign, setAttributeRelative, setBGColor, setClickable, setColor, setColorTransform, setContextMenu, setCursor, setHeight, setLayout, setOpacity, setPan, setPlay, setResource, setResourceNumber, setRotation, setShowHandCursor, setSource, setValign, setVisible, setVolume, setWidth, setX, setY, shouldYieldFocus, stop, stretchResource, unload, updateResourceSize


Events

Events inherited from LzNode

onconstruct, ondata, oninit

Events inherited from LzView

onaddsubresource, onaddsubview, onblur, onclick, ondblclick, onerror, onfocus, onframe, onheight, onlastframe, onload, onmousedown, onmousedragin, onmousedragout, onmouseout, onmouseover, onmouseup, onmouseupoutside, onopacity, onplay, onremovesubview, onstop, ontimeout, onwidth, onx, ony