org.zkoss.zul.api
Interface Comboitem

All Superinterfaces:

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

All Known Implementing Classes:

Comboitem

public interface Comboitem
extends LabelImageElement

An item of a combo box.

Non-XUL extension. Refer to Combobox.

Default HtmlBasedComponent.getZclass(): z-combo-item. (since 3.5.0)

Since:

3.5.2

Author:

tomyeh

See Also:

Combobox

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	getContent() Returns the embedded content (i.e., HTML tags) that is shown as part of the description.
java.lang.String	getDescription() Returns the description (never null).
java.lang.Object	getValue() Returns the value associated with this combo item.
boolean	isDisabled() Returns whether it is disabled.
void	setContent(java.lang.String content) Sets the embedded content (i.e., HTML tags) that is shown as part of the description.
void	setDescription(java.lang.String desc) Sets the description.
void	setDisabled(boolean disabled) Sets whether it is disabled.
void	setValue(java.lang.Object value) Associate the value with this combo item.

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

setDisabled

void setDisabled(boolean disabled)

Sets whether it is disabled.

isDisabled

boolean isDisabled()

Returns whether it is disabled.

Default: false.

getDescription

java.lang.String getDescription()

Returns the description (never null). The description is used to provide extra information such that users is easy to make a selection.

Default: "".

setDescription

void setDescription(java.lang.String desc)

Sets the description.

getContent

java.lang.String getContent()

Returns the embedded content (i.e., HTML tags) that is shown as part of the description.

It is useful to show the description in more versatile way.

Default: empty ("").

See Also:

getDescription()

setContent

void setContent(java.lang.String content)

Sets the embedded content (i.e., HTML tags) that is shown as part of the description.

It is useful to show the description in more versatile way.

See Also:

setDescription(java.lang.String)

getValue

java.lang.Object getValue()

Returns the value associated with this combo item. The value is application dependent. It can be anything.

It is usually used with Combobox.getSelectedItemApi(). For example, combobox.getSelectedItem().getValue()

See Also:

Combobox.getSelectedItem(), setValue(java.lang.Object)

setValue

void setValue(java.lang.Object value)

Associate the value with this combo item. The value is application dependent. It can be anything.

See Also:

Combobox.getSelectedItem(), getValue()