ZK Component Reference/Input/Textbox

Textbox

• Demonstration: Various Form Demo
• Java API: Textbox
• JavaScript API: Textbox

Employment/Purpose

A textbox is used to let users input text data.

You colud assign value, type, constraint, rows, cols to a textbox by the corresponding properties. When you assigns the property type to a string value 「password」 when multiline is false( multiline will be true if You set rows large then 1 or sets multiline to true directly) then any character in this component will replace by '*'.

You colud also assign a constraint value with a regular expression string or a default constraint expression(available value is 「no empty」). When user change the value of textbox, will cause a validating preocess to valdate the value. If valdation fail, then a notification will poped up.

Example

<textbox value="text..." />
<textbox value="secret" type="password" />
<textbox constraint="/.+@.+\.[a-z]+/: Please enter an e-mail address" />
<textbox rows="5" cols="40">
	<attribute name="value">
		text line1... 
		text line2...
	</attribute>
</textbox>

Supported events

Name	Event Type
onChange	[#InputEvent org.zkoss.zk.ui.event.InputEvent] Description: Denotes the content of an input component has been modified by the user.
onChanging	[#InputEvent org.zkoss.zk.ui.event.InputEvent] Description: Denotes that user is changing the content of an input component. Notice that the component's content (at the server) won't be changed until onChange is received. Thus, you have to invoke the getValue method in the InputEvent class to retrieve the temporary value.
onSelection	[#SelectionEvent org.zkoss.zk.ui.event.SelectionEvent] Description: Denotes that user is selecting a portion of the text of an input component. You can retrieve the start and end position of the selected text by use of the getStart and getEnd methods.
onFocus	[#Event org.zkoss.zk.ui.event.Event] Description: Denotes when a component gets the focus. Remember event listeners execute at the server, so the focus at the client might be changed when the event listener for onFocus got executed.
onBlur	[#Event org.zkoss.zk.ui.event.Event] Description: Denotes when a component loses the focus. Remember event listeners execute at the server, so the focus at the client might be changed when the event listener for onBlur got executed.
onCreate	[#CreateEvent org.zkoss.ui.zk.ui.event.CreateEvent] Description: Denotes a component is created when rendering a ZUML page.
onDrop	[#DropEvent org.zkoss.ui.zk.ui.event.DropEvent] Description: Denotes another component is dropped to the component that receives this event.

Supported Children

*NONE

Use cases

Version	Description	Example Location
5.0+

Version History

Version	Date	Content
5.0.1	05/11/2010	Initialization