Package eu.webtoolkit.jwt

Class WLineEdit

java.lang.Object

eu.webtoolkit.jwt.WObject

eu.webtoolkit.jwt.WWidget

eu.webtoolkit.jwt.WWebWidget

eu.webtoolkit.jwt.WInteractWidget

eu.webtoolkit.jwt.WFormWidget

eu.webtoolkit.jwt.WLineEdit

Direct Known Subclasses:

WAbstractSpinBox, WDateEdit, WPasswordEdit, WTimeEdit

public class WLineEdit
extends WFormWidget

A widget that provides a single line edit.

To act upon text changes, connect a slot to the WFormWidget.changed() signal. This signal is emitted when the user changed the content, and subsequently removes the focus from the line edit.

To act upon editing, connect a slot to the WInteractWidget.keyWentUp() signal because the WInteractWidget.keyPressed() signal is fired before the line edit has interpreted the keypress to change its text.

At all times, the current content may be accessed with the getText() method.

You may specify a maximum length for the input using setMaxLength(). If you wish to provide more detailed input validation, you may set a validator using the WFormWidget#setValidator() method. Validators provide, in general, both client-side validation (as visual feed-back only) and server-side validation when calling validate().

The widget corresponds to the HTML <input type="text"> or <input type="password"> tag.

WLineEdit is an inline widget.

CSS

The emptyText style can be configured via .Wt-edit-emptyText, other styling can be done using inline or external CSS as appropriate.

See Also:

• WTextArea

Nested Class Summary

Nested classes/interfaces inherited from class eu.webtoolkit.jwt.WObject

WObject.FormData

Field Summary

Fields inherited from class eu.webtoolkit.jwt.WInteractWidget

dragTouchEndSlot_, dragTouchSlot_, noDefault

Fields inherited from class eu.webtoolkit.jwt.WWidget

WT_GETEXTRAMS_JS

Constructor Summary

Constructors

Constructor	Description
WLineEdit()	Creates a line edit with empty content.
WLineEdit(WContainerWidget parentContainer)	Creates a line edit with empty content.
WLineEdit(String text)	Creates a line edit with given content.
WLineEdit(String text, WContainerWidget parentContainer)	Creates a line edit with given content.

Method Summary

Modifier and Type	Method	Description
protected int	boxBorder(Orientation orientation)	Returns the widget's built-in border width.
protected int	boxPadding(Orientation orientation)	Returns the widget's built-in padding.
AutoCompleteMode	getAutoCompleteToken()	Returns auto-completion support.
int	getCursorPosition()	Returns the current cursor position.
String	getDisplayText()	Returns the displayed text.
protected void	getDomChanges(List<DomElement> result, WApplication app)	Get DOM changes for this widget.
EchoMode	getEchoMode()	Deprecated. For EchoMode.Password, use WPasswordEdit instead.
String	getInputMask()	Returns the input mask.
InputMode	getInputMode()	Returns inputMode support.
int	getMaxLength()	Returns the maximum length of text that can be entered.
String	getSelectedText()	Returns the currently selected text.
int	getSelectionStart()	Returns the current selection start.
String	getText()	Returns the current content.
int	getTextSize()	Returns the current width of the line edit in number of characters.
protected String	getType()
String	getValueText()	Returns the current value.
boolean	hasSelectedText()	Returns whether there is selected text.
boolean	isAutoComplete()	Returns if auto-completion support is not off.
protected void	render(EnumSet<RenderFlag> flags)	Renders the widget.
void	setAutoComplete(boolean enabled)	Sets (built-in browser) autocomplete support.
void	setAutoComplete(AutoCompleteMode token)	Sets (built-in browser) autocomplete support.
void	setEchoMode(EchoMode echoMode)	Deprecated. For EchoMode.Password, use WPasswordEdit instead.
protected void	setFormData(WObject.FormData formData)
final void	setInputMask()	Sets the input mask.
final void	setInputMask(String mask)	Sets the input mask.
final void	setInputMask(String mask, InputMaskFlag flag, InputMaskFlag... flags)	Sets the input mask.
void	setInputMask(String mask, EnumSet<InputMaskFlag> flags)	Sets the input mask.
void	setInputMode(InputMode mode)	Sets (built-in browser) input mode support.
void	setMaxLength(int chars)	Specifies the maximum length of text that can be entered.
void	setSelection(int start, int length)	Selects length characters starting from the start position.
void	setText(String text)	Sets the content of the line edit.
void	setTextSize(int chars)	Specifies the width of the line edit in number of characters.
void	setValueText(String value)	Sets the current value.
EventSignal	textInput()	Event signal emitted when the text in the input field changed.
ValidationState	validate()	Validates the field.

Methods inherited from class eu.webtoolkit.jwt.WFormWidget

changed, enableAjax, getLabel, getPlaceholderText, getRealValidator, getTabIndex, getValidator, hasValidatorChanged, isCanReceiveFocus, isReadOnly, propagateSetEnabled, refresh, remove, setEnabled, setHidden, setPlaceholderText, setReadOnly, setToolTip, setValidator, validated, validatorChanged

Methods inherited from class eu.webtoolkit.jwt.WInteractWidget

clicked, doubleClicked, enterPressed, escapePressed, gestureChanged, gestureEnded, gestureStarted, getMouseOverDelay, isEnabled, keyPressed, keyWentDown, keyWentUp, load, mouseDragged, mouseMoved, mouseWentDown, mouseWentOut, mouseWentOver, mouseWentUp, mouseWheel, setDraggable, setDraggable, setDraggable, setDraggable, setMouseOverDelay, setPopup, touchEnded, touchMoved, touchStarted, unsetDraggable

Methods inherited from class eu.webtoolkit.jwt.WWebWidget

addStyleClass, beingDeleted, blurred, callJavaScriptMember, childrenChanged, createDomElement, doJavaScript, escapeText, escapeText, escapeText, escapeText, find, findById, focussed, getAttributeValue, getBaseZIndex, getChildren, getClearSides, getDecorationStyle, getFloatSide, getHeight, getHtmlTagName, getId, getJavaScriptMember, getLineHeight, getMargin, getMaximumHeight, getMaximumWidth, getMinimumHeight, getMinimumWidth, getOffset, getPositionScheme, getScrollVisibilityMargin, getStyleClass, getToolTip, getVerticalAlignment, getVerticalAlignmentLength, getWidth, hasFocus, hasStyleClass, hideToolTip, isDisabled, isHidden, isHiddenKeepsGeometry, isInline, isLoaded, isPopup, isRendered, isScrollVisibilityEnabled, isScrollVisible, isSetFirstFocus, isThemeStyleEnabled, isVisible, iterateChildren, jsStringLiteral, jsStringLiteral, manageWidget, parentResized, parentResized, propagateSetVisible, removeScript, removeStyleClass, resize, scrollVisibilityChanged, setAttributeValue, setBaseZIndex, setCanReceiveFocus, setClearSides, setDecorationStyle, setDeferredToolTip, setDisabled, setFlexBox, setFloatSide, setFocus, setHiddenKeepsGeometry, setHtmlTagName, setId, setInline, setJavaScriptMember, setLineHeight, setLoadLaterWhenInvisible, setMargin, setMaximumSize, setMinimumSize, setObjectName, setOffsets, setParentWidget, setPositionScheme, setScrollVisibilityEnabled, setScrollVisibilityMargin, setSelectable, setStyleClass, setTabIndex, setThemeStyleEnabled, setVerticalAlignment, showToolTip, showToolTipOnHover, unescapeText, updateSignalConnection, voidEventSignal, widgetAdded, widgetRemoved

Methods inherited from class eu.webtoolkit.jwt.WWidget

acceptDrops, acceptDrops, addCssRule, addCssRule, addJSignal, addStyleClass, animateHide, animateShow, applyThemeStyles, createJavaScript, disable, dropEvent, enable, getDropTouch, getJsRef, getParent, hide, htmlText, isExposed, isGlobalWidget, isLayoutSizeAware, layoutSizeChanged, needsRerender, positionAt, positionAt, positionAt, positionAt, removeFromParent, removeStyleClass, removeWidget, render, resize, scheduleRender, scheduleRender, scheduleRender, scheduleThemeStyleApply, setClearSides, setDeferredToolTip, setFocus, setHeight, setHidden, setLayoutSizeAware, setMargin, setMargin, setMargin, setMargin, setMargin, setOffsets, setOffsets, setOffsets, setOffsets, setOffsets, setToolTip, setVerticalAlignment, setWidth, show, stopAcceptDrops, toggleStyleClass, toggleStyleClass, tr

Methods inherited from class eu.webtoolkit.jwt.WObject

getObjectName

Methods inherited from class java.lang.Object

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

Constructor Details

WLineEdit

public WLineEdit(WContainerWidget parentContainer)

Creates a line edit with empty content.

WLineEdit

public WLineEdit()

Creates a line edit with empty content.

Calls this((WContainerWidget)null)

WLineEdit

public WLineEdit(String text,
 WContainerWidget parentContainer)

Creates a line edit with given content.

WLineEdit

public WLineEdit(String text)

Creates a line edit with given content.

Calls this(text, (WContainerWidget)null)

Method Details

setTextSize

public void setTextSize(int chars)

Specifies the width of the line edit in number of characters.

This specifies the width of the line edit that is roughly equivalent with chars characters. This does not limit the maximum length of a string that may be entered, which may be set using setMaxLength().

The default value is 10.

getTextSize

public int getTextSize()

Returns the current width of the line edit in number of characters.

See Also:

• setTextSize(int chars)

setText

public void setText(String text)

Sets the content of the line edit.

The default value is "".

See Also:

• getText()

getText

public String getText()

Returns the current content.

See Also:

• setText(String text)

getDisplayText

public String getDisplayText()

Returns the displayed text.

If getEchoMode() is set to Normal, and no input mask is defined, this returns the same as getText().

If an input mask is defined, then the text is returned including space characters.

If getEchoMode() is set to Password, then a string of asterisks is returned equal to the length of the text.

See Also:

• setText(String text)

setMaxLength

public void setMaxLength(int chars)

Specifies the maximum length of text that can be entered.

A value <= 0 indicates that there is no limit.

The default value is -1.

getMaxLength

public int getMaxLength()

Returns the maximum length of text that can be entered.

See Also:

• setMaxLength(int chars)

setEchoMode

public void setEchoMode(EchoMode echoMode)

Deprecated.

For EchoMode.Password, use WPasswordEdit instead.

Sets the echo mode.

The default echo mode is Normal.

getEchoMode

public EchoMode getEchoMode()

Deprecated.

For EchoMode.Password, use WPasswordEdit instead.

Returns the echo mode.

See Also:

• setEchoMode(EchoMode echoMode)

setAutoComplete

public void setAutoComplete(boolean enabled)

Sets (built-in browser) autocomplete support.

Depending on the user agent, this may assist the user in filling in text for common input fields (e.g. address information) based on some heuristics.

The default value is true.

setAutoComplete

public void setAutoComplete(AutoCompleteMode token)

Sets (built-in browser) autocomplete support.

Depending on the user agent, this may assist the user in filling in text for common input fields (e.g. address information) based on some heuristics.

The default value is AutoCompleteMode.On.

isAutoComplete

public boolean isAutoComplete()

Returns if auto-completion support is not off.

See Also:

• setAutoComplete(boolean enabled)

getAutoCompleteToken

public AutoCompleteMode getAutoCompleteToken()

Returns auto-completion support.

See Also:

• setAutoComplete(boolean enabled)

setInputMode

public void setInputMode(InputMode mode)

Sets (built-in browser) input mode support.

The input mode suggest what type of virtual keyboard should be used when applicable (mainly for phone users).

When InputMode.Off is used, the inputmode field is not specified. Not to be confused with InputMode.None, which suggest the browser to not use any virtual keybord.

The default value is InputMode.Off.

getInputMode

public InputMode getInputMode()

Returns inputMode support.

See Also:

• setInputMode(InputMode mode)

getSelectionStart

public int getSelectionStart()

Returns the current selection start.

Returns -1 if there is no selected text.

See Also:

• hasSelectedText()
• getSelectedText()

getSelectedText

public String getSelectedText()

Returns the currently selected text.

Returns an empty string if there is currently no selected text.

See Also:

• hasSelectedText()

hasSelectedText

public boolean hasSelectedText()

Returns whether there is selected text.

setSelection

public void setSelection(int start,
 int length)

Selects length characters starting from the start position.

getCursorPosition

public int getCursorPosition()

Returns the current cursor position.

Returns -1 if the widget does not have the focus.

getValueText

public String getValueText()

Returns the current value.

Returns getText().

Specified by:

getValueText in class WFormWidget

setValueText

public void setValueText(String value)

Sets the current value.

Calls setText().

Specified by:

setValueText in class WFormWidget

getInputMask

public String getInputMask()

Returns the input mask.

See Also:

• setInputMask(String mask, EnumSet flags)

setInputMask

public void setInputMask(String mask,
 EnumSet<InputMaskFlag> flags)

Sets the input mask.

If no input mask is supplied, or the given input mask is empty, no input mask is applied.

The following characters can be used in the input mask:

Character	Description
A	ASCII alphabetic character: A-Z, a-z (required)
a	ASCII alphabetic character: A-Z, a-z (optional)
N	ASCII alphanumeric character: A-Z, a-z, 0-9 (required)
n	ASCII alphanumeric character: A-Z, a-z, 0-9 (optional)
X	Any character (required)
x	Any character (optional)
9	Digit: 0-9 (required)
0	Digit: 0-9 (optional)
D	Nonzero digit: 1-9 (required)
d	Nonzero digit: 1-9 (optional)
#	Digit or sign: 0-9, -, + (required)
H	Hexadecimal character: A-F, a-f, 0-9 (required)
h	Hexadecimal character: A-F, a-f, 0-9 (optional)
B	Binary digit: 0-1 (required)
b	Binary digit: 0-1 (optional)

The distinction between required and optional characters won't be apparent on the client side, but will affect the result of validate().

There are also a few special characters, that won't be checked against, but modify the value in some way:

Character	Description
>	The following characters are uppercased
<	The following characters are lowercased
!	The casing of the following characters remains the same

A backslash ('\') can be used to escape any of the mask characters or modifiers, so that they can be used verbatim in the input mask.

If the mask ends with a semicolon (';') followed by a character, this character will be used on the client side to display spaces. This defaults to the space (' ') character. The space character will be removed from the value of this WLineEdit.

Examples:

Input mask	Notes
009.009.009.009;_	IP address. Spaces are denoted by '_'. Will validate if there is at least one digit per segment.
9999-99-99	Date, in yyyy-MM-dd notation. Spaces are denoted by ' '. Will validate if all digits are filled in.
>HH:HH:HH:HH:HH:HH;_	MAC address. Spaces are denoted by '_'. Will validate if all hexadecimal characters are filled in. All characters will be formatted in uppercase.

Input masks are enforced by JavaScript on the client side. Without JavaScript or using setText(), however, non-compliant strings can be entered. This does not result in an error: any non-compliant characters will be removed from the input and this action will be logged.

setInputMask

public final void setInputMask(String mask,
 InputMaskFlag flag,
 InputMaskFlag... flags)

Sets the input mask.

Calls setInputMask(mask, EnumSet.of(flag, flags))

setInputMask

public final void setInputMask()

Sets the input mask.

Calls setInputMask("", EnumSet.noneOf(InputMaskFlag.class))

setInputMask

public final void setInputMask(String mask)

Sets the input mask.

Calls setInputMask(mask, EnumSet.noneOf(InputMaskFlag.class))

validate

public ValidationState validate()

Description copied from class: WFormWidget

Validates the field.

Overrides:

validate in class WFormWidget

See Also:

• WFormWidget.validated()

textInput

public EventSignal textInput()

Event signal emitted when the text in the input field changed.

This signal is emitted whenever the text contents has changed. Unlike the WFormWidget.changed() signal, the signal is fired on every change, not only when the focus is lost. Unlike the WInteractWidget.keyPressed() signal, this signal is fired also for other events that change the text, such as paste actions.

See Also:

• WInteractWidget.keyPressed()
• WFormWidget.changed()

getDomChanges

protected void getDomChanges(List<DomElement> result,
 WApplication app)

Description copied from class: WWebWidget

Get DOM changes for this widget.

This is an internal function, and should not be called directly, or be overridden!

Overrides:

getDomChanges in class WWebWidget

setFormData

protected void setFormData(WObject.FormData formData)

Overrides:

setFormData in class WObject

boxPadding

protected int boxPadding(Orientation orientation)

Description copied from class: WWidget

Returns the widget's built-in padding.

This is used by the layout managers to correct for a built-in padding which interferes with setting a widget's width (or height) to 100%.

A layout manager needs to set the width to 100% only for form widgets (WTextArea, WLineEdit, WComboBox, etc...). Therefore, only for those widgets this needs to return the padding (the default implementation returns 0).

For form widgets, the padding depends on the specific browser/platform combination, unless an explicit padding is set for the widget.

When setting an explicit padding for the widget using a style class, you will want to reimplement this method to return this padding in case you want to set the widget inside a layout manager.

Overrides:

boxPadding in class WWidget

See Also:

• WWidget.boxBorder(Orientation orientation)

boxBorder

protected int boxBorder(Orientation orientation)

Description copied from class: WWidget

Returns the widget's built-in border width.

This is used by the layout managers to correct for a built-in border which interferes with setting a widget's width (or height) to 100%.

A layout manager needs to set the width to 100% only for form widgets (WTextArea, WLineEdit, WComboBox, etc...). Therefore, only for those widgets this needs to return the border width (the default implementation returns 0).

For form widgets, the border width depends on the specific browser/platform combination, unless an explicit border is set for the widget.

When setting an explicit border for the widget using a style class, you will want to reimplement this method to return this border width, in case you want to set the widget inside a layout manager.

Overrides:

boxBorder in class WWidget

See Also:

• WWidget.boxPadding(Orientation orientation)

render

protected void render(EnumSet<RenderFlag> flags)

Description copied from class: WWidget

Renders the widget.

This function renders the widget (or an update for the widget), after this has been scheduled using scheduleRender().

The default implementation will render the widget by serializing changes to JavaScript and HTML. You may want to reimplement this widget if you have been postponing some of the layout / rendering implementation until the latest moment possible. In that case you should make sure you call the base implementation however.

Overrides:

render in class WFormWidget

getType

protected String getType()