public class Checkbox extends LabelImageElement implements org.zkoss.zk.ui.ext.Disable
Event:
Modifier and Type | Class and Description |
---|---|
static class |
Checkbox.State
This class is the return state for getState()
|
LabelImageElement.ExtraCtrl
Constructor and Description |
---|
Checkbox() |
Checkbox(String label) |
Checkbox(String label,
String image) |
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.
|
Checkbox.State |
getState()
Returns the current state according to isIndeterminate() and isChecked().
|
<T> T |
getValue()
Returns the value.
|
String |
getZclass()
Returns the Style of checkbox label
|
boolean |
isChecked()
Returns whether it is checked.
|
protected boolean |
isChildable()
Default: not childable.
|
boolean |
isDisabled()
Returns whether it is disabled.
|
boolean |
isIndeterminate()
Return whether checkbox is in indeterminate state.
|
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,
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 |
setMold(String mold) |
void |
setName(String name)
Sets the name of this component.
|
<T> void |
setValue(T value)
Sets the value.
|
protected void |
updateByClient(String name,
Object value) |
clone, getExtraCtrl, getHoverImage, getHoverImageContent, getIconSclass, getImage, getImageContent, getPropertyAccess, getSrc, isImageAssigned, setHoverImage, setHoverImageContent, setHoverImageContent, setIconSclass, setImage, setImageContent, setImageContent, setSrc
getLabel, renderCrawlable, setLabel
getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes
addSclass, evalCSSFlex, focus, getAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex, setVflex0, setVflexDirectly, setWidth, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly
addAnnotation, addAnnotation, addCallback, 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, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getCallback, 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, getShadowFellowIfAny, getShadowRoots, getShadowVariable, 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, invalidatePartial, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, 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, 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
public Checkbox()
public Checkbox(String label)
public boolean isIndeterminate()
public void setIndeterminate(boolean indeterminate)
indeterminate
- whether checkbox is indeterminatepublic String getAutodisable()
public void setAutodisable(String autodisable)
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.
public boolean isDisabled()
Default: false.
isDisabled
in interface org.zkoss.zk.ui.ext.Disable
public void setDisabled(boolean disabled)
setDisabled
in interface org.zkoss.zk.ui.ext.Disable
public boolean isChecked()
Default: false.
public void setChecked(boolean checked)
public Checkbox.State getState()
public <T> T getValue()
Default: null. (since 6.5.0)
public <T> void setValue(T value)
value
- the value;public String getName()
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.
public void setName(String name)
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.
name
- the name of this component.protected boolean isChildable()
isChildable
in class org.zkoss.zk.ui.AbstractComponent
public void setMold(String mold)
setMold
in interface org.zkoss.zk.ui.Component
setMold
in class org.zkoss.zk.ui.AbstractComponent
public String getZclass()
Default: "z-checkbox"
Since 3.5.1
getZclass
in class org.zkoss.zk.ui.HtmlBasedComponent
protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer) throws IOException
renderProperties
in class LabelImageElement
IOException
public void service(org.zkoss.zk.au.AuRequest request, boolean everError)
Default: in addition to what are handled by HtmlBasedComponent.service(org.zkoss.zk.au.AuRequest, boolean)
,
it also handles onCheck.
service
in interface org.zkoss.zk.ui.sys.ComponentCtrl
service
in class org.zkoss.zk.ui.HtmlBasedComponent
Copyright © 2020. All rights reserved.