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:

java.io.Serializable, java.lang.Cloneable, Component, Disable, Readonly, Scope, 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

HtmlBasedComponent.ExtraCtrl

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

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

Textbox()

Textbox(java.lang.String value)

Method Summary

java.lang.Object	clone() Clones the component.
protected java.lang.Object	coerceFromString(java.lang.String value) Coerces the value passed to setValue(java.lang.String).
protected java.lang.String	coerceToString(java.lang.Object value) Coerces the value passed to setValue(java.lang.String).
int	getRows() Returns the rows.
java.lang.String	getType() Returns the type.
java.lang.String	getValue() Returns the value.
java.lang.String	getZclass() Returns the ZK Cascading Style class(es) for this component.
boolean	isMultiline() Returns whether it is multiline.
boolean	isTabbable() Returns whether TAB is allowed.
protected void	renderProperties(ContentRenderer renderer) Renders the content of this component, excluding the enclosing tags and children.
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(java.lang.String type) Sets the type.
void	setValue(java.lang.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, 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, addScopeListener, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, 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(java.lang.String value)
        throws WrongValueException

Throws:

WrongValueException

Method Detail

getValue

public java.lang.String getValue()
                          throws WrongValueException

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

Default: "".

Throws:

WrongValueException - if user entered a wrong value

setValue

public void setValue(java.lang.String value)
              throws WrongValueException

Sets the value.

Parameters:

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

Throws:

WrongValueException - if value is wrong

coerceFromString

protected java.lang.Object coerceFromString(java.lang.String value)
                                     throws WrongValueException

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

Default: convert null to an empty string.

Specified by:

coerceFromString in class InputElement

Throws:

WrongValueException

coerceToString

protected java.lang.String coerceToString(java.lang.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 java.lang.String getType()

Returns the type.

Default: text.

Overrides:

getType in class InputElement

setType

public void setType(java.lang.String type)
             throws 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:

WrongValueException

getRows

public int getRows()

Returns the rows.

Default: 1.

setRows

public void setRows(int rows)
             throws WrongValueException

Sets the rows.

Throws:

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 java.lang.Object clone()

Description copied from interface: Component

Clones the component. All of its children and descendants are cloned. Also, ID are preserved.

Specified by:

clone in interface Component

Overrides:

clone in class InputElement

Returns:

the new component. Notice that it doesn't belong to any page, nor desktop. It doesn't have a parent, either.

renderProperties

protected void renderProperties(ContentRenderer renderer)
                         throws java.io.IOException

Description copied from class: HtmlBasedComponent

Renders the content of this component, excluding the enclosing tags and children.

See also ZK Client-side Reference: Property Rendering

Overrides:

renderProperties in class InputElement

Throws:

java.io.IOException

getZclass

public java.lang.String getZclass()

Description copied from class: HtmlBasedComponent

Returns the ZK Cascading Style class(es) for this component. It usually depends on the implementation of the mold (@{link #getMold}).

Default: null (the default value depends on element).

HtmlBasedComponent.setZclass(java.lang.String)) will completely replace the default style of a component. In other words, the default style of a component is associated with the default value of HtmlBasedComponent.getZclass(). Once it is changed, the default style won't be applied at all. If you want to perform small adjustments, use HtmlBasedComponent.setSclass(java.lang.String) instead.

Overrides:

getZclass in class HtmlBasedComponent

See Also:

HtmlBasedComponent.getSclass()