org.zkoss.zul.api
Interface Listfooter

All Superinterfaces:

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

All Known Implementing Classes:

Listfooter

public interface Listfooter
extends LabelImageElement

A column of the footer of a list box (Listbox). Its parent must be Listfoot.

Unlike Listheader, you could place any child in a list footer.

Note: Listcell also accepts children.

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

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

int	getColumnIndex() Returns the column index, starting from 0.
Listbox	getListboxApi() Returns the listbox that this belongs to.
Listheader	getListheaderApi() Returns the list header that is in the same column as this footer, or null if not available.
int	getSpan() Returns number of columns to span this footer.
void	setSpan(int span) Sets the number of columns to span this footer.

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 listbox that this belongs to.

getColumnIndex

int getColumnIndex()

Returns the column index, starting from 0.

getListheaderApi

Listheader getListheaderApi()

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

getSpan

int getSpan()

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

setSpan

void setSpan(int span)

Sets the number of columns to span this footer.

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