org.zkoss.zul.api
Interface Listcell

All Superinterfaces:

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

All Known Implementing Classes:

Listcell

public interface Listcell
extends LabelImageElement

A list cell.

Default HtmlBasedComponent.getZclass(): z-list-cell. (since 3.5.0)

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

int	getColumnIndex() Returns the column index of this cell, starting from 0.
Listbox	getListboxApi() Returns the list box that it belongs to.
Listheader	getListheaderApi() Returns the list header that is in the same column as this cell, or null if not available.
int	getMaxlength() Returns the maximal length for this cell.
int	getSpan() Returns number of columns to span this cell.
java.lang.Object	getValue() Returns the value.
void	setSpan(int span) Sets the number of columns to span this cell.
void	setValue(java.lang.Object value) Sets the value.

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

getListboxApi

Listbox getListboxApi()

Returns the list box that it belongs to.

getListheaderApi

Listheader getListheaderApi()

Returns the list header that is in the same column as this cell, or null if not available.

getColumnIndex

int getColumnIndex()

Returns the column index of this cell, starting from 0.

getMaxlength

int getMaxlength()

Returns the maximal length for this cell. If listbox's mold is "select", it is the same as Listbox.getMaxlength() If not, it is the same as the correponding getListheaderApi()'s Listheader.getMaxlength() .

Note: Listitem.getMaxlength() is the same as Listbox.getMaxlength().

getValue

java.lang.Object getValue()

Returns the value.

Default: null.

Note: the value is application dependent, you can place whatever value you want.

setValue

void setValue(java.lang.Object value)

Sets the value.

Parameters:

value - the value.

Note: the value is application dependent, you can place whatever value you want.

getSpan

int getSpan()

Returns number of columns to span this cell. Default: 1.

setSpan

void setSpan(int span)

Sets the number of columns to span this cell.

It is the same as the colspan attribute of HTML TD tag.