org.zkoss.zk.ui.ext.client
Interface InputableX

All Known Implementing Classes:

Calendar.ExtraCtrl, Combobox.ExtraCtrl, InputElement.ExtraCtrl

public interface InputableX

Implemented by the object returned by ComponentCtrl.getExtraCtrl(), if a component allows users to change its content from the client.

InputEvent will be sent wih name as "onChange" after setTextByClient(java.lang.String) is called to notify application developers that it is called by user (rather than by codes).

For components that implement this interface MIGHT also support InputEvent with "onChanging". It is used to notified the server that user is changing its content (changing is on progress and not finished).

The server usually uses onChanging to implement auto-completion and similar feature.

Since:

3.0.3

Author:

tomyeh

See Also:

InputEvent

Method Summary

boolean

setTextByClient(java.lang.String value) Sets the value in string (aka., text) by the client.

Method Detail

setTextByClient

boolean setTextByClient(java.lang.String value)
                        throws WrongValueException

Sets the value in string (aka., text) by the client.

This method is designed to be used by engine. Don't invoke it directly. Otherwise, the client and server might mismatch.

Returns:

false if nothing is changed.

Throws:

WrongValueException