org.zkoss.zul

Class Checkbox

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.impl.XulElement

org.zkoss.zul.impl.LabelElement

org.zkoss.zul.impl.LabelImageElement

org.zkoss.zul.Checkbox

All Implemented Interfaces:

Serializable, Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Disable, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl

Direct Known Subclasses:

Radio

public class Checkbox
extends LabelImageElement
implements org.zkoss.zk.ui.ext.Disable

A checkbox.

Event:

1. org.zkoss.zk.ui.event.CheckEvent is sent when a checkbox is checked or unchecked by user.

Author:

tomyeh

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zul.impl.LabelImageElement

LabelImageElement.ExtraCtrl

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.AbstractComponent.Children

Field Summary

Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

_zclass

Fields inherited from interface org.zkoss.zk.ui.Component

APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor and Description
Checkbox()
Checkbox(String label)
Checkbox(String label, String image)

Method Summary

Methods

Modifier and Type	Method and Description
String	getAutodisable() Returns a list of component IDs that shall be disabled when the user clicks this checkbox.
String	getName() Returns the name of this component.
int	getTabindex() Returns the tab order of this component.
<T> T	getValue() Returns the value.
String	getZclass() Returns the Style of checkbox label Default: "z-checkbox" Since 3.5.1
boolean	isChecked() Returns whether it is checked.
protected boolean	isChildable() Default: not childable.
boolean	isDisabled() Returns whether it is disabled.
protected void	renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
void	service(org.zkoss.zk.au.AuRequest request, boolean everError) Processes an AU request.
void	setAutodisable(String autodisable) Sets a list of component IDs that shall be disabled when the user clicks this checkbox.
void	setChecked(boolean checked) Sets whether it is checked.
void	setDisabled(boolean disabled) Sets whether it is disabled.
void	setName(String name) Sets the name of this component.
void	setTabindex(int tabindex) Sets the tab order of this component.
<T> void	setValue(T value) Sets the value.
protected void	updateByClient(String name, Object value)

Methods inherited from class org.zkoss.zul.impl.LabelImageElement

clone, getExtraCtrl, getHoverImage, getHoverImageContent, getIconSclass, getImage, getImageContent, getPropertyAccess, getSrc, isImageAssigned, setHoverImage, setHoverImageContent, setHoverImageContent, setIconSclass, setImage, setImageContent, setImageContent, setSrc

Methods inherited from class org.zkoss.zul.impl.LabelElement

getLabel, renderCrawlable, setLabel

Methods inherited from class org.zkoss.zul.impl.XulElement

getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

focus, getAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeightDirectly, setHflex, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setTopDirectly, setVflex, setWidth, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowRoots, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Checkbox

public Checkbox()

Checkbox

public Checkbox(String label)

Checkbox

public Checkbox(String label,
        String image)

Method Detail

getAutodisable

public String getAutodisable()

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

Since:

6.0.0

setAutodisable

public void setAutodisable(String autodisable)

Sets a list of 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 id="ok" autodisable="self,cancel"/> is the same as <checkbox id="ok" autodisable="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. 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 id="ok" autodisable="+self,+cancel"/>

Then, you have to enable them manually such as

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

Default: null.

Since:

5.0.0

isDisabled

public boolean isDisabled()

Returns whether it is disabled.

Default: false.

Specified by:

isDisabled in interface org.zkoss.zk.ui.ext.Disable

setDisabled

public void setDisabled(boolean disabled)

Sets whether it is disabled.

Specified by:

setDisabled in interface org.zkoss.zk.ui.ext.Disable

isChecked

public boolean isChecked()

Returns whether it is checked.

Default: false.

setChecked

public void setChecked(boolean checked)

Sets whether it is checked.

getValue

public <T> T getValue()

Returns the value.

Default: null. (since 6.5.0)

Since:

5.0.4

setValue

public <T> void setValue(T value)

Sets the value.

Parameters:

value - the value;

Since:

5.0.4

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.

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.

getTabindex

public int getTabindex()

Returns the tab order of this component.

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

setTabindex

public void setTabindex(int tabindex)
                 throws org.zkoss.zk.ui.WrongValueException

Sets the tab order of this component.

Throws:

org.zkoss.zk.ui.WrongValueException

isChildable

protected boolean isChildable()

Default: not childable.

Overrides:

isChildable in class org.zkoss.zk.ui.AbstractComponent

getZclass

public String getZclass()

Returns the Style of checkbox label

Default: "z-checkbox"

Since 3.5.1

Overrides:

getZclass in class org.zkoss.zk.ui.HtmlBasedComponent

renderProperties

protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
                         throws IOException

Overrides:

renderProperties in class LabelImageElement

Throws:

IOException

service

public void service(org.zkoss.zk.au.AuRequest request,
           boolean everError)

Processes an AU request.

Default: in addition to what are handled by HtmlBasedComponent.service(org.zkoss.zk.au.AuRequest, boolean), it also handles onCheck.

Specified by:

service in interface org.zkoss.zk.ui.sys.ComponentCtrl

Overrides:

service in class org.zkoss.zk.ui.HtmlBasedComponent

Since:

5.0.0

updateByClient

protected void updateByClient(String name,
                  Object value)

Overrides:

updateByClient in class org.zkoss.zk.ui.AbstractComponent