org.zkoss.zul

Class Textbox

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.impl.XulElement

org.zkoss.zul.impl.InputElement

org.zkoss.zul.Textbox

All Implemented Interfaces:

Serializable, Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Disable, org.zkoss.zk.ui.ext.Readonly, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl, Constrainted

Direct Known Subclasses:

Bandbox, Combobox

public class Textbox
extends InputElement

A textbox.

See Specification.

Default getZclass(): z-textbox.(since 3.5.0)

When multiline is true, only default mold is available.

Author:

tomyeh

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.AbstractComponent.Children

Field Summary

Fields inherited from class org.zkoss.zul.impl.InputElement

_value

Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

_zclass

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

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

Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor and Description
Textbox()
Textbox(String value)

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone()
protected Object	coerceFromString(String value) Coerces the value passed to setValue(java.lang.String).
protected String	coerceToString(Object value) Coerces the value passed to setValue(java.lang.String).
org.zkoss.zk.ui.sys.PropertyAccess	getPropertyAccess(String prop)
int	getRows() Returns the rows.
String	getType() Returns the type.
String	getValue() Returns the value.
String	getZclass()
boolean	isMultiline() Returns whether it is multiline.
boolean	isTabbable() Returns whether TAB is allowed.
protected void	renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
void	setMultiline(boolean multiline) Sets whether it is multiline.
void	setRows(int rows) Sets the rows.
void	setTabbable(boolean tabbable) Sets whether TAB is allowed.
void	setType(String type) Sets the type.
void	setValue(String value) Sets the value.

Methods inherited from class org.zkoss.zul.impl.InputElement

checkUserError, clearErrorMessage, clearErrorMessage, getCols, getConstraint, getErrorMessage, getInstant, getMaxlength, getName, getPlaceholder, getRawText, getRawValue, getTabindex, getTargetValue, getText, isChildable, isDisabled, isInplace, isInstant, isReadonly, isValid, marshall, onWrongValue, select, service, setCols, setConstraint, setConstraint, setDisabled, setErrorMessage, setInplace, setInstant, setMaxlength, setName, setPlaceholder, setRawValue, setReadonly, setSelectedText, setSelectionRange, setTabindex, setText, setValueDirectly, showCustomError, unmarshall, validate

Methods inherited from class org.zkoss.zul.impl.XulElement

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

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeightDirectly, setHflex, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setTopDirectly, setVflex, setWidth, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowRoots, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Textbox

public Textbox()

Textbox

public Textbox(String value)
        throws org.zkoss.zk.ui.WrongValueException

Throws:

org.zkoss.zk.ui.WrongValueException

Method Detail

getValue

public String getValue()
                throws org.zkoss.zk.ui.WrongValueException

Returns the value. The same as InputElement.getText().

Default: "".

Throws:

org.zkoss.zk.ui.WrongValueException - if user entered a wrong value

setValue

public void setValue(String value)
              throws org.zkoss.zk.ui.WrongValueException

Sets the value.

Parameters:

value - the value; If null, it is considered as empty.

Throws:

org.zkoss.zk.ui.WrongValueException - if value is wrong

coerceFromString

protected Object coerceFromString(String value)
                           throws org.zkoss.zk.ui.WrongValueException

Coerces the value passed to setValue(java.lang.String).

Default: convert null to an empty string.

Specified by:

coerceFromString in class InputElement

Throws:

org.zkoss.zk.ui.WrongValueException

coerceToString

protected String coerceToString(Object value)

Coerces the value passed to setValue(java.lang.String).

Default: convert null to an empty string.

Specified by:

coerceToString in class InputElement

getType

public String getType()

Returns the type.

Default: text.

Overrides:

getType in class InputElement

setType

public void setType(String type)
             throws org.zkoss.zk.ui.WrongValueException

Sets the type.

Parameters:

type - the type. Acceptable values are "text" and "password". Unlike XUL, "timed" is redundant because it is enabled as long as onChanging is added. Since 6.5.0 type also support tel, email and url.

Throws:

org.zkoss.zk.ui.WrongValueException

getRows

public int getRows()

Returns the rows.

Default: 1.

setRows

public void setRows(int rows)
             throws org.zkoss.zk.ui.WrongValueException

Sets the rows.

Throws:

org.zkoss.zk.ui.WrongValueException

isMultiline

public boolean isMultiline()

Returns whether it is multiline.

Default: false.

Overrides:

isMultiline in class InputElement

setMultiline

public void setMultiline(boolean multiline)

Sets whether it is multiline.

isTabbable

public boolean isTabbable()

Returns whether TAB is allowed. If true, the user can enter TAB in the textbox, rather than change focus.

Default: false.

Since:

3.6.0

setTabbable

public void setTabbable(boolean tabbable)

Sets whether TAB is allowed. If true, the user can enter TAB in the textbox, rather than change focus.

Default: false.

Since:

3.6.0

clone

public Object clone()

Specified by:

clone in interface org.zkoss.zk.ui.Component

Overrides:

clone in class InputElement

getPropertyAccess

public org.zkoss.zk.ui.sys.PropertyAccess getPropertyAccess(String prop)

Specified by:

getPropertyAccess in interface org.zkoss.zk.ui.sys.ComponentCtrl

Overrides:

getPropertyAccess in class InputElement

renderProperties

protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
                         throws IOException

Overrides:

renderProperties in class InputElement

Throws:

IOException

getZclass

public String getZclass()

Overrides:

getZclass in class org.zkoss.zk.ui.HtmlBasedComponent