zul.wgt

Class Checkbox

java.lang.Object

zk.Object

zk.Widget

zul.Widget

zul.LabelImageWidget

zul.wgt.Checkbox

Direct Known Subclasses:

Radio

public class Checkbox
extends LabelImageWidget

A checkbox.

Event:

1. onCheck is sent when a checkbox is checked or unchecked by user.

Field Summary

Fields inherited from class zk.Widget

$weave, auDelay, autag, bindLevel, className, desktop, effects_, firstChild, id, insertingBefore_, inServer, lastChild, nChildren, nextSibling, parent, previousSibling, uuid, widgetName

Fields inherited from class zk.Object

$class, $oid

Method Summary

Modifier and Type	Method and Description
String	getAutodisable() Returns a list of checkbox component IDs that shall be disabled when the user clicks this checkbox.
String	getName() Returns the name of this component.
java.lang.Boolean	getState() Returns the current state according to isIndeterminate() and isChecked().
int	getTabindex() Returns the tab order of this component.
String	getValue() Returns the value.
boolean	isChecked() Returns whether it is checked.
boolean	isDisabled() Returns whether it is disabled.
boolean	isIndeterminate() Return whether checkbox is in indeterminate state.
void	setAutodisable(String autodisable) Sets whether to disable the checkbox after the user clicks it.
void	setChecked(boolean checked) Sets whether it is checked, changing checked will set indeterminate to false.
void	setDisabled(boolean disabled) Sets whether it is disabled.
void	setIndeterminate(boolean indeterminate) Set whether checkbox is in indeterminate state.
void	setName(String name) Sets the name of this component.
void	setTabindex(int tabindex) Sets the tab order of this component.
void	setValue(String value) Sets the value.

Methods inherited from class zul.LabelImageWidget

domContent_, domIcon_, domImage_, domLabel_, getHoverImage, getIconSclass, getImage, getImageNode, getLabel, setHoverImage, setIconSclass, setImage, setLabel, updateDomContent_

Methods inherited from class zul.Widget

afterKeyDown_, beforeCtrlKeys_, getContext, getCtrlKeys, getOpenTooltip, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from class zk.Widget

$, $f, $f, $f, $init, $n, $n, $o, $s, $service, afterAnima_, afterParentChanged_, appendChild, appendChild, beforeParentChanged_, beforeSendAU_, bind_, bind, bindChildren_, bindDoubleTap_, bindMissingAncestors, bindSwipe_, bindTapHold_, canActivate, cleanDrag_, clear, clearCache, cloneDrag_, deferRedraw_, deferRedrawHTML_, detach, doBlur_, doClick_, doDoubleClick_, doFocus_, doKeyDown_, doKeyPress_, doKeyUp_, domAttrs_, domClass_, domListen_, doMouseDown_, doMouseMove_, doMouseOut_, doMouseOver_, doMouseUp_, domStyle_, domTextStyleAttr_, domTooltiptext_, domUnlisten_, doPaste_, doResizeScroll_, doRightClick_, doSelect_, doSwipe_, doTooltipOut_, doTooltipOver_, dropEffect_, extraBind_, fire, fireX, focus_, focus, forcerender, fromPageCoord, get, getAction, getCaveNode, getChildAt, getChildIndex, getClass, getCssflex, getDraggable, getDragMessage_, getDragNode, getDragOptions_, getDrop_, getDroppable, getElementsById, getElementsByName, getFirstNode_, getFloatZIndex_, getHeight, getHflex, getId, getLeft, getMold, getOldWidget_, getPage, getRenderdefer, getSclass, getScrollLeft, getScrollTop, getStyle, getTextNode, getTooltiptext, getTop, getTopWidget, getVflex, getWidth, getZclass, getZIndex, hide, ignoreDescendantFloatUp_, ignoreDrag_, initDrag_, insertBefore, insertChildHTML_, isAutoId, isBinding, isFloating_, isListen, isRealElement, isRealVisible, isRealVisible, isVisible, isVisible, isWatchable_, listen, listenOnFitSize_, mimicMouseDown_, newInstance, nextUuid, onAfterSize, onChildAdded_, onChildRemoved_, onChildRenderDefer_, onChildReplaced_, onChildVisible_, onDrop_, redraw, redrawHTML_, register, removeChild, removeChild, removeChildHTML_, removeHTML_, replaceCavedChildren_, replaceChildHTML_, replaceHTML, replaceWidget, rerender, rerender, rerenderLater_, rerenderNow_, scrollIntoView, sendAU_, set, set, setAction, setChildren, setCssflex, setDomVisible_, setDraggable, setDroppable, setFloating_, setFloatZIndex_, setHeight, setHflex, setId, setLeft, setListener, setListener, setListeners, setMold, setRenderdefer, setSclass, setScrollLeft, setScrollTop, setStyle, setTooltiptext, setTop, setTopmost, setVflex, setVisible, setWidth, setZclass, setZIndex, shallChildROD_, shallFireSizedLaterWhenAddChd_, shallIgnoreClick_, show, smartUpdate, unbind_, unbind, unbindChildren_, unbindDoubleTap_, unbindSwipe_, unbindTapHold_, uncloneDrag_, unlisten, unlistenOnFitSize_, updateDomClass_, updateDomStyle_, uuid, zsync

Methods inherited from class zk.Object

$init, $instanceof, $super, $super, $supers, $supers, afterInit, isAssignableFrom, isInstance, proxy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setDisabled

public void setDisabled(boolean disabled)

Sets whether it is disabled.

Parameters:

disabled -

isDisabled

public boolean isDisabled()

Returns whether it is disabled.

Default: false.

Returns:

boolean

setChecked

public void setChecked(boolean checked)

Sets whether it is checked, changing checked will set indeterminate to false.

Parameters:

checked -

isChecked

public boolean isChecked()

Returns whether it is checked.

Default: false.

Returns:

boolean

setName

public void setName(String name)

Sets the name of this component.

Don't use this method if your application is purely based on ZK's event-driven model.

The name is used only to work with "legacy" Web application that handles user's request by servlets. It works only with HTTP/HTML-based browsers. It doesn't work with other kind of clients.

Parameters:

name - the name of this component.

getName

public String getName()

Returns the name of this component.

Default: null.

Don't use this method if your application is purely based on ZK's event-driven model.

The name is used only to work with "legacy" Web application that handles user's request by servlets. It works only with HTTP/HTML-based browsers. It doesn't work with other kind of clients.

Returns:

String

setTabindex

public void setTabindex(int tabindex)

Sets the tab order of this component.

Overrides:

setTabindex in class Widget

Parameters:

tabindex -

getTabindex

public int getTabindex()

Returns the tab order of this component.

Default: -1 (means the same as browser's default).

Overrides:

getTabindex in class Widget

Returns:

int

setValue

public void setValue(String value)

Sets the value.

Parameters:

value - the value; If null, it is considered as empty.

Since:

5.0.4

getValue

public String getValue()

Returns the value.

Default: "".

Returns:

String

Since:

5.0.4

setAutodisable

public void setAutodisable(String autodisable)

Sets whether to disable the checkbox after the user clicks it.

Parameters:

autodisable -

getAutodisable

public String getAutodisable()

Returns a list of checkbox component IDs that shall be disabled when the user clicks this checkbox.

To represent the checkbox itself, the developer can specify self. For example,

 checkbox.setId('ok');
 wgt.setAutodisable('self,cancel');
 

is the same as

 checkbox.setId('ok');
 wgt.setAutodisable('ok,cancel');
 

that will disable both the ok and cancel checkboxes when an user clicks it.

The checkbox being disabled will be enabled automatically once the client receives a response from the server or a fixed timeout. In other words, the server doesn't notice if a checkbox is disabled with this method.

However, if you prefer to enable them later manually, you can prefix with '+'. For example,

 checkbox.setId('ok');
 wgt.setAutodisable('+self,+cancel');
 

Then, you have to enable them manually such as

if (something_happened){
  ok.setDisabled(false);
  cancel.setDisabled(false);

Default: null.

Returns:

String

setIndeterminate

public void setIndeterminate(boolean indeterminate)

Set whether checkbox is in indeterminate state.

Parameters:

indeterminate - whether checkbox is indeterminate

Since:

8.6.0

isIndeterminate

public boolean isIndeterminate()

Return whether checkbox is in indeterminate state. Default: false.

Returns:

boolean

Since:

8.6.0

getState

public java.lang.Boolean getState()

Returns the current state according to isIndeterminate() and isChecked().

Returns:

Boolean

Since:

9.0.0