Class Index | File Index

Classes


Class zwt.ui.CheckBox


Extends zwt.ui.Widget.

A check box widget.

CSS rules

.zwt_checkBox {}
.zwt_checkBox .zwt_checkBox-box {}
.zwt_checkBox .zwt_checkBox-label {}

Defined in: CheckBox.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Construct a CheckBox object.
Field Summary
Field Attributes Field Name and Description
<static>  
zwt.ui.CheckBox.AFTER
Indicate the label should appear after the check box
<static>  
zwt.ui.CheckBox.BEFORE
Indicate the label should appear before the check box
Method Summary
Method Attributes Method Name and Description
 
Return the change event manager attached to the check box.
 
Return the check box's label HTML text.
 
Return the label position.
 
Return the check box's label text.
 
Determine whether this box is checked.
 
Determine whether this check box is disabled.
 
Return true if the check box is focusable and not disabled.
 
processChangeEvent(zwt_event_ChangeEvent_event)
Process the specified change event.
 
processEvent(zwt_event_Event_event)
Process the specified event.
 
processFocusEvent(zwt_event_FocusEvent_event)
Process the specified focus event.
 
setChecked(boolean_flag)
Check/uncheck the check box.
 
setDisabled(boolean_disabled)
Disable or enable the check box.
 
setHTML(string_html)
Set the check box's label HTML text.
 
setLabelPosition(int_position)
Set the label position.
 
setText(string_text)
Set the text of the check box's label.
Methods borrowed from class zwt.ui.Widget:
addStyle, draw, getContextFill, getDimension, getElement, getElementDimension, getFill, getFocusEventManager, getId, getKeyboardEventManager, getParent, getRelativeLeft, getRelativeTop, getStyle, getWheelEventManager, hasFocus, hasStyle, isVisible, onEvent, processContentEvent, processKeyboardEvent, processWheelEvent, redraw, removeStyle, replaceStyle, setFill, setFocusable, setId, setStyle, setVisible
Class Detail
zwt.ui.CheckBox()
Construct a CheckBox object.
Author: Jeremy KUHN.
Field Detail
<static> {Integer} zwt.ui.CheckBox.AFTER
Indicate the label should appear after the check box

<static> {Integer} zwt.ui.CheckBox.BEFORE
Indicate the label should appear before the check box
Method Detail
{zwt.event.ChangeEventManager} getChangeEventManager()
Return the change event manager attached to the check box.
Returns:
The change event manager

{String} getHTML()
Return the check box's label HTML text.
Returns:
The check box's label HTML text.

{Integer} getLabelPosition()
Return the label position.
Returns:
The label position.

{String} getText()
Return the check box's label text.
Returns:
The check box's label text.

{Boolean} isChecked()
Determine whether this box is checked.
Returns:
true if checked.

{Boolean} isDisabled()
Determine whether this check box is disabled. A disabled check box can't respond to user input and generate events. The check box is enabled initially by default.
Returns:
true if the check box is disabled, false otherwise

{Boolean} isFocusable()
Return true if the check box is focusable and not disabled.
Returns:
true if the check box is focusable

processChangeEvent(zwt_event_ChangeEvent_event)
Process the specified change event.
Parameters:
{zwt.event.ChangeEvent} zwt_event_ChangeEvent_event
The change event to process

processEvent(zwt_event_Event_event)
Process the specified event.
Parameters:
{zwt.event.Event} zwt_event_Event_event
The event to process

processFocusEvent(zwt_event_FocusEvent_event)
Process the specified focus event.
Parameters:
{zwt.event.FocusEvent} zwt_event_FocusEvent_event
The focus event to process

setChecked(boolean_flag)
Check/uncheck the check box.
Parameters:
{Boolean} boolean_flag
true/false

setDisabled(boolean_disabled)
Disable or enable the check box.
Parameters:
{Boolean} boolean_disabled
true to disable the check box, otherwise false

setHTML(string_html)
Set the check box's label HTML text.
Parameters:
{String} string_html
The check box HTML text.

setLabelPosition(int_position)
Set the label position. The label is placed after the check box initially by default.
Parameters:
{Integer} int_position
The label position, one of zwt.ui.CheckBox.BEFORE or zwt.ui.CheckBox.AFTER

setText(string_text)
Set the text of the check box's label.
Parameters:
{String} string_text
The check box text.

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Nov 09 2011 19:29:07 GMT+0100 (CET)