org.zkoss.zul.api
Interface Bandbox

All Superinterfaces:

java.lang.Cloneable, Component, Constrainted, HtmlBasedComponent, InputElement, Scope, java.io.Serializable, Textbox, XulElement

All Known Implementing Classes:

Bandbox

public interface Bandbox
extends Textbox

A band box. A bank box consists of an input box (Textbox and a popup window Bandpopup. It is similar to Combobox except the popup window could have any kind of children. For example, you could place a textbox in the popup to let user search particular items.

Default HtmlBasedComponent.getZclass(): z-bandbox.(since 3.5.0)

Events: onOpen
Developers can listen to the onOpen event and initializes it when OpenEvent.isOpen() is true, and/or clean up if false.

Note: to have better performance, onOpen is sent only if a non-deferrable event listener is registered (see Deferrable).

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

void	close() Closes the child if it was dropped down.
void	closeDropdown() Closes the popup (getDropdownApi()).
Bandpopup	getDropdownApi() Returns the dropdown window belonging to this band box.
boolean	isButtonVisible() Returns whether the button (on the right of the textbox) is visible.
void	open() Drops down the child.
void	setAutodrop(boolean autodrop) Sets whether to automatically drop the list if users is changing this text box.
void	setButtonVisible(boolean visible) Sets whether the button (on the right of the textbox) is visible.
void	setOpen(boolean open) Drops down or closes the child.

Methods inherited from interface org.zkoss.zul.api.Textbox

getRows, getValue, setMultiline, setRows, setType, setValue

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

clearErrorMessage, clearErrorMessage, getAreaText, getCols, getErrorMessage, getMaxlength, getName, getRawText, getRawValue, getTabindex, getText, getType, isDisabled, isMultiline, isReadonly, isValid, select, setCols, setConstraint, setDisabled, setMaxlength, setName, setRawValue, setReadonly, setSelectedText, setSelectionRange, setTabindex, setText

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

Methods inherited from interface org.zkoss.zul.ext.Constrainted

getConstraint, setConstraint

Method Detail

getDropdownApi

Bandpopup getDropdownApi()

Returns the dropdown window belonging to this band box.

closeDropdown

void closeDropdown()

Closes the popup (getDropdownApi()).

setAutodrop

void setAutodrop(boolean autodrop)

Sets whether to automatically drop the list if users is changing this text box.

isButtonVisible

boolean isButtonVisible()

Returns whether the button (on the right of the textbox) is visible.

Default: true.

setButtonVisible

void setButtonVisible(boolean visible)

Sets whether the button (on the right of the textbox) is visible.

setOpen

void setOpen(boolean open)

Drops down or closes the child.

See Also:

open(), close()

open

void open()

Drops down the child. The same as setOpen(true).

close

void close()

Closes the child if it was dropped down. The same as setOpen(false).