com.vaadin.client.ui

Class VTextField

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.FocusWidget

com.google.gwt.user.client.ui.ValueBoxBase<String>

com.google.gwt.user.client.ui.TextBoxBase

com.vaadin.client.ui.VTextField

All Implemented Interfaces:

com.google.gwt.editor.client.IsEditor<com.google.gwt.editor.ui.client.adapters.ValueBoxEditor<String>>, com.google.gwt.event.dom.client.BlurHandler, com.google.gwt.event.dom.client.ChangeHandler, com.google.gwt.event.dom.client.FocusHandler, com.google.gwt.event.dom.client.HasAllDragAndDropHandlers, com.google.gwt.event.dom.client.HasAllFocusHandlers, com.google.gwt.event.dom.client.HasAllGestureHandlers, com.google.gwt.event.dom.client.HasAllKeyHandlers, com.google.gwt.event.dom.client.HasAllMouseHandlers, com.google.gwt.event.dom.client.HasAllTouchHandlers, com.google.gwt.event.dom.client.HasBlurHandlers, com.google.gwt.event.dom.client.HasChangeHandlers, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasDoubleClickHandlers, com.google.gwt.event.dom.client.HasDragEndHandlers, com.google.gwt.event.dom.client.HasDragEnterHandlers, com.google.gwt.event.dom.client.HasDragHandlers, com.google.gwt.event.dom.client.HasDragLeaveHandlers, com.google.gwt.event.dom.client.HasDragOverHandlers, com.google.gwt.event.dom.client.HasDragStartHandlers, com.google.gwt.event.dom.client.HasDropHandlers, com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.dom.client.HasGestureChangeHandlers, com.google.gwt.event.dom.client.HasGestureEndHandlers, com.google.gwt.event.dom.client.HasGestureStartHandlers, com.google.gwt.event.dom.client.HasKeyDownHandlers, com.google.gwt.event.dom.client.HasKeyPressHandlers, com.google.gwt.event.dom.client.HasKeyUpHandlers, com.google.gwt.event.dom.client.HasMouseDownHandlers, com.google.gwt.event.dom.client.HasMouseMoveHandlers, com.google.gwt.event.dom.client.HasMouseOutHandlers, com.google.gwt.event.dom.client.HasMouseOverHandlers, com.google.gwt.event.dom.client.HasMouseUpHandlers, com.google.gwt.event.dom.client.HasMouseWheelHandlers, com.google.gwt.event.dom.client.HasTouchCancelHandlers, com.google.gwt.event.dom.client.HasTouchEndHandlers, com.google.gwt.event.dom.client.HasTouchMoveHandlers, com.google.gwt.event.dom.client.HasTouchStartHandlers, com.google.gwt.event.dom.client.KeyDownHandler, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasValueChangeHandlers<String>, com.google.gwt.event.shared.EventHandler, com.google.gwt.event.shared.HasHandlers, com.google.gwt.i18n.client.AutoDirectionHandler.Target, com.google.gwt.i18n.client.HasDirection, com.google.gwt.i18n.shared.HasDirectionEstimator, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.TakesValue<String>, com.google.gwt.user.client.ui.Focusable, com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.user.client.ui.HasFocus, com.google.gwt.user.client.ui.HasName, com.google.gwt.user.client.ui.HasText, com.google.gwt.user.client.ui.HasValue<String>, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.SourcesChangeEvents, com.google.gwt.user.client.ui.SourcesClickEvents, com.google.gwt.user.client.ui.SourcesFocusEvents, com.google.gwt.user.client.ui.SourcesKeyboardEvents, com.google.gwt.user.client.ui.SourcesMouseEvents, Field

Direct Known Subclasses:

VPasswordField, VTextArea

public class VTextField
extends com.google.gwt.user.client.ui.TextBoxBase
implements Field, com.google.gwt.event.dom.client.ChangeHandler, com.google.gwt.event.dom.client.FocusHandler, com.google.gwt.event.dom.client.BlurHandler, com.google.gwt.event.dom.client.KeyDownHandler

This class represents a basic text input field with one row.

Author:

Vaadin Ltd.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.TextBoxBase

com.google.gwt.user.client.ui.TextBoxBase.TextAlignConstant

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.ValueBoxBase

com.google.gwt.user.client.ui.ValueBoxBase.TextAlignment

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.i18n.client.HasDirection

com.google.gwt.i18n.client.HasDirection.Direction

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASSNAME The input node CSS classname.
static String	CLASSNAME_FOCUS This CSS classname is added to the input node on hover.
ApplicationConnection	client For internal use only.
boolean	listenTextChangeEvents For internal use only.
String	paintableId For internal use only.
static int	TEXTCHANGE_EVENTS For internal use only.
String	textChangeEventMode For internal use only.
int	textChangeEventTimeout
String	valueBeforeEdit For internal use only.

Fields inherited from class com.google.gwt.user.client.ui.TextBoxBase

ALIGN_CENTER, ALIGN_JUSTIFY, ALIGN_LEFT, ALIGN_RIGHT

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
	VTextField()
protected	VTextField(com.google.gwt.dom.client.Element node)

Method Summary

Modifier and Type	Method and Description
void	attachCutEventListener(com.google.gwt.dom.client.Element el) For internal use only.
protected void	detachCutEventListener(com.google.gwt.dom.client.Element el)
static void	flushChangesFromFocusedTextField()
int	getMaxLength()
protected boolean	isWordwrap()
protected void	onAttach()
void	onBlur(com.google.gwt.event.dom.client.BlurEvent event)
void	onBrowserEvent(com.google.gwt.user.client.Event event)
void	onChange(com.google.gwt.event.dom.client.ChangeEvent event)
protected void	onCut()
protected void	onDetach()
void	onFocus(com.google.gwt.event.dom.client.FocusEvent event)
void	onKeyDown(com.google.gwt.event.dom.client.KeyDownEvent event)
void	setColumns(int columns)
void	setImmediate(boolean immediate)
void	setInputPrompt(String inputPrompt)
void	setMaxLength(int newMaxLength) For internal use only.
protected void	setMaxLengthToElement(int newMaxLength)
void	setReadOnly(boolean readOnly)
protected boolean	updateCursorPosition() Updates the cursor position variable if it has changed since the last update.
void	updateFieldContent(String text) For internal use only.
protected void	updateMaxLength(int maxLength) This method is responsible for updating the DOM or otherwise ensuring that the given max length is enforced.
void	valueChange(boolean blurred) Called when the field value might have changed and/or the field was blurred.

Methods inherited from class com.google.gwt.user.client.ui.TextBoxBase

addChangeListener, getValue, setTextAlignment

Methods inherited from class com.google.gwt.user.client.ui.ValueBoxBase

addChangeHandler, addValueChangeHandler, asEditor, cancelKey, getCursorPos, getDirection, getDirectionEstimator, getImpl, getName, getSelectedText, getSelectionLength, getText, getValueOrThrow, isReadOnly, onLoad, removeChangeListener, selectAll, setAlignment, setCursorPos, setDirection, setDirectionEstimator, setDirectionEstimator, setKey, setName, setSelectionRange, setText, setValue, setValue

Methods inherited from class com.google.gwt.user.client.ui.FocusWidget

addBlurHandler, addClickHandler, addClickListener, addDoubleClickHandler, addDragEndHandler, addDragEnterHandler, addDragHandler, addDragLeaveHandler, addDragOverHandler, addDragStartHandler, addDropHandler, addFocusHandler, addFocusListener, addGestureChangeHandler, addGestureEndHandler, addGestureStartHandler, addKeyboardListener, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addMouseDownHandler, addMouseListener, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMouseWheelHandler, addMouseWheelListener, addTouchCancelHandler, addTouchEndHandler, addTouchMoveHandler, addTouchStartHandler, getFocusImpl, getTabIndex, isEnabled, removeClickListener, removeFocusListener, removeKeyboardListener, removeMouseListener, removeMouseWheelListener, setAccessKey, setEnabled, setFocus, setTabIndex

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.user.client.ui.SourcesChangeEvents

removeChangeListener

Methods inherited from interface com.google.gwt.event.dom.client.HasKeyUpHandlers

addKeyUpHandler

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Field Detail

CLASSNAME

public static final String CLASSNAME

The input node CSS classname.

See Also:

Constant Field Values

CLASSNAME_FOCUS

public static final String CLASSNAME_FOCUS

This CSS classname is added to the input node on hover.

See Also:

Constant Field Values

paintableId

public String paintableId

For internal use only. May be removed or replaced in the future.

client

public ApplicationConnection client

For internal use only. May be removed or replaced in the future.

valueBeforeEdit

public String valueBeforeEdit

For internal use only. May be removed or replaced in the future.

TEXTCHANGE_EVENTS

public static final int TEXTCHANGE_EVENTS

For internal use only. May be removed or replaced in the future.

TODO When GWT adds ONCUT, add it there and remove workaround. See http://code.google.com/p/google-web-toolkit/issues/detail?id=4030

Also note that the cut/paste are not totally crossbrowsers compatible. E.g. in Opera mac works via context menu, but on via File->Paste/Cut. Opera might need the polling method for 100% working textchanceevents. Eager polling for a change is bit dum and heavy operation, so I guess we should first try to survive without.

See Also:

Constant Field Values

listenTextChangeEvents

public boolean listenTextChangeEvents

For internal use only. May be removed or replaced in the future.

textChangeEventMode

public String textChangeEventMode

For internal use only. May be removed or replaced in the future.

textChangeEventTimeout

public int textChangeEventTimeout

Constructor Detail

VTextField

public VTextField()

VTextField

protected VTextField(com.google.gwt.dom.client.Element node)

Method Detail

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)

Specified by:

onBrowserEvent in interface com.google.gwt.user.client.EventListener

Overrides:

onBrowserEvent in class com.google.gwt.user.client.ui.ValueBoxBase<String>

setReadOnly

public void setReadOnly(boolean readOnly)

Overrides:

setReadOnly in class com.google.gwt.user.client.ui.ValueBoxBase<String>

updateFieldContent

public void updateFieldContent(String text)

For internal use only. May be removed or replaced in the future.

onCut

protected void onCut()

attachCutEventListener

public void attachCutEventListener(com.google.gwt.dom.client.Element el)

For internal use only. May be removed or replaced in the future.

detachCutEventListener

protected void detachCutEventListener(com.google.gwt.dom.client.Element el)

onDetach

protected void onDetach()

Overrides:

onDetach in class com.google.gwt.user.client.ui.Widget

onAttach

protected void onAttach()

Overrides:

onAttach in class com.google.gwt.user.client.ui.FocusWidget

setMaxLength

public void setMaxLength(int newMaxLength)

For internal use only. May be removed or replaced in the future.

updateMaxLength

protected void updateMaxLength(int maxLength)

This method is responsible for updating the DOM or otherwise ensuring that the given max length is enforced. Called when the max length for the field has changed.

Parameters:

maxLength - The new max length

setMaxLengthToElement

protected void setMaxLengthToElement(int newMaxLength)

getMaxLength

public int getMaxLength()

onChange

public void onChange(com.google.gwt.event.dom.client.ChangeEvent event)

Specified by:

onChange in interface com.google.gwt.event.dom.client.ChangeHandler

valueChange

public void valueChange(boolean blurred)

Called when the field value might have changed and/or the field was blurred. These are combined so the blur event is sent in the same batch as a possible value change event (these are often connected).

Parameters:

blurred - true if the field was blurred

updateCursorPosition

protected boolean updateCursorPosition()

Updates the cursor position variable if it has changed since the last update.

Returns:

true iff the value was updated

flushChangesFromFocusedTextField

public static void flushChangesFromFocusedTextField()

onFocus

public void onFocus(com.google.gwt.event.dom.client.FocusEvent event)

Specified by:

onFocus in interface com.google.gwt.event.dom.client.FocusHandler

onBlur

public void onBlur(com.google.gwt.event.dom.client.BlurEvent event)

Specified by:

onBlur in interface com.google.gwt.event.dom.client.BlurHandler

setColumns

public void setColumns(int columns)

onKeyDown

public void onKeyDown(com.google.gwt.event.dom.client.KeyDownEvent event)

Specified by:

onKeyDown in interface com.google.gwt.event.dom.client.KeyDownHandler

setImmediate

public void setImmediate(boolean immediate)

setInputPrompt

public void setInputPrompt(String inputPrompt)

isWordwrap

protected boolean isWordwrap()