org.zkoss.zul.api
Interface Textbox

All Superinterfaces:
java.lang.Cloneable, Component, Constrainted, HtmlBasedComponent, InputElement, Scope, java.io.Serializable, XulElement
All Known Subinterfaces:
Bandbox, Combobox
All Known Implementing Classes:
Bandbox, Combobox, Textbox

public interface Textbox
extends InputElement

A textbox.

See Specification.

Default HtmlBasedComponent.getZclass(): z-textbox.(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 getRows()
          Returns the rows.
 java.lang.String getValue()
          Returns the value.
 void setMultiline(boolean multiline)
          Sets whether it is multiline.
 void setRows(int rows)
          Sets the rows.
 void setType(java.lang.String type)
          Sets the type.
 void setValue(java.lang.String value)
          Sets the value.
 
Methods inherited from interface org.zkoss.zul.impl.api.InputElement
clearErrorMessage, clearErrorMessage, 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, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, unsetVariable
 
Methods inherited from interface org.zkoss.zk.ui.ext.Scope
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute
 
Methods inherited from interface org.zkoss.zul.ext.Constrainted
getConstraint, setConstraint
 

Method Detail

getValue

java.lang.String getValue()
                          throws WrongValueException
Returns the value. The same as InputElement.getText().

Default: "".

Throws:
WrongValueException - if user entered a wrong value

setValue

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

setType

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 redudant because it is enabled as long as onChanging is added.
Throws:
WrongValueException

getRows

int getRows()
Returns the rows.

Default: 1.


setRows

void setRows(int rows)
             throws WrongValueException
Sets the rows.

Throws:
WrongValueException

setMultiline

void setMultiline(boolean multiline)
Sets whether it is multiline.



Copyright © 2005-2009 Potix Corporation. All Rights Reserved. SourceForge.net Logo