org.zkoss.zul.api
Interface Checkbox

All Superinterfaces:

java.lang.Cloneable, Component, HtmlBasedComponent, LabelElement, LabelImageElement, Scope, java.io.Serializable, XulElement

All Known Subinterfaces:

Radio

All Known Implementing Classes:

Checkbox, Radio

public interface Checkbox
extends LabelImageElement

A checkbox.

Event:

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

Since:

3.5.2

Author:

tomyeh

Field Summary

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

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

Method Summary

java.lang.String	getName() Returns the name of this component.
int	getTabindex() Returns the tab order of this component.
boolean	isChecked() Returns whether it is checked.
boolean	isDisabled() Returns whether it is disabled.
void	setChecked(boolean checked) Sets whether it is checked.
void	setDisabled(boolean disabled) Sets whether it is disabled.
void	setName(java.lang.String name) Sets the name of this component.
void	setTabindex(int tabindex) Sets the tab order of this component.

Methods inherited from interface org.zkoss.zul.impl.api.LabelImageElement

getHoverImage, getImage, getImageContent, setHoverImage, setHoverImageContent, setHoverImageContent, setImage, setImageContent, setImageContent

Methods inherited from interface org.zkoss.zul.impl.api.LabelElement

getLabel, setLabel

Methods inherited from interface org.zkoss.zul.impl.api.XulElement

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

Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent

focus, getHeight, getLeft, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZclass, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex

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

addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, containsVariable, detach, getAttribute, getAttribute, getAttributes, getAttributes, getChildren, getDefinition, getDesktop, getFellow, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, redraw, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, unsetVariable

Method Detail

isDisabled

boolean isDisabled()

Returns whether it is disabled.

Default: false.

setDisabled

void setDisabled(boolean disabled)

Sets whether it is disabled.

isChecked

boolean isChecked()

Returns whether it is checked.

Default: false.

setChecked

void setChecked(boolean checked)

Sets whether it is checked.

getName

java.lang.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

void setName(java.lang.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

int getTabindex()

Returns the tab order of this component.

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

setTabindex

void setTabindex(int tabindex)
                 throws WrongValueException

Sets the tab order of this component.

Throws:

WrongValueException