Package eu.webtoolkit.jwt

Class WTextArea

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.WTextArea

Direct Known Subclasses:

WTextEdit

public class WTextArea
extends WFormWidget

A widget that provides a multi-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.

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

WTextArea is an inline widget.

CSS

The widget corresponds to an HTML <textarea> tag can be styled using inline or external CSS as appropriate. The emptyText style can be configured via .Wt-edit-emptyText.

See Also:

• WLineEdit

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_

Constructor Summary

Constructors

Constructor	Description
WTextArea()	Creates a text area with empty content and optional parent.
WTextArea(WContainerWidget parentContainer)	Creates a text area with empty content and optional parent.
WTextArea(String text)	Creates a text area with given content and optional parent.
WTextArea(String text, WContainerWidget parentContainer)	Creates a text area with given content and optional parent.

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.
int	getColumns()	Returns the number of columns.
int	getCursorPosition()	Returns the current cursor position.
int	getRows()	Returns the number of rows.
String	getSelectedText()	Returns the currently selected text.
int	getSelectionStart()	Returns the current selection start.
String	getText()	Returns the current content.
String	getValueText()	Returns the current value.
boolean	hasSelectedText()	Returns whether there is selected text.
void	setColumns(int columns)	Sets the number of columns.
protected void	setFormData(WObject.FormData formData)
void	setRows(int rows)	Sets the number of rows.
void	setText(String text)	Sets the content of the text area.
void	setValueText(String value)	Sets the current value.
EventSignal	textInput()	Event signal emitted when the text in the input field changed.

Methods inherited from class eu.webtoolkit.jwt.WFormWidget

changed, enableAjax, getLabel, getPlaceholderText, getTabIndex, getValidator, isCanReceiveFocus, isReadOnly, propagateSetEnabled, refresh, remove, render, setEnabled, setHidden, setPlaceholderText, setReadOnly, setToolTip, setValidator, validate, 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, getDomChanges, getFloatSide, getHeight, getHtmlTagName, getId, getJavaScriptMember, getLineHeight, getMargin, getMaximumHeight, getMaximumWidth, getMinimumHeight, getMinimumWidth, getOffset, getPositionScheme, getScrollVisibilityMargin, getStyleClass, getToolTip, getVerticalAlignment, getVerticalAlignmentLength, getWidth, hasFocus, hasStyleClass, 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, unescapeText, updateSignalConnection, voidEventSignal, widgetAdded, widgetRemoved

Methods inherited from class eu.webtoolkit.jwt.WWidget

acceptDrops, acceptDrops, addCssRule, addCssRule, addJSignal, addStyleClass, animateHide, animateShow, createJavaScript, disable, dropEvent, enable, getDropTouch, getJsRef, getParent, hide, htmlText, isExposed, isGlobalWidget, isLayoutSizeAware, layoutSizeChanged, needsRerender, positionAt, positionAt, removeFromParent, removeStyleClass, removeWidget, render, resize, scheduleRender, scheduleRender, scheduleRender, 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

WTextArea

public WTextArea(WContainerWidget parentContainer)

Creates a text area with empty content and optional parent.

WTextArea

public WTextArea()

Creates a text area with empty content and optional parent.

Calls this((WContainerWidget)null)

WTextArea

public WTextArea(String text,
 WContainerWidget parentContainer)

Creates a text area with given content and optional parent.

WTextArea

public WTextArea(String text)

Creates a text area with given content and optional parent.

Calls this(text, (WContainerWidget)null)

Method Details

setColumns

public void setColumns(int columns)

Sets the number of columns.

The default value is 20.

setRows

public void setRows(int rows)

Sets the number of rows.

The default value is 5.

getColumns

public int getColumns()

Returns the number of columns.

See Also:

• setColumns(int columns)

getRows

public int getRows()

Returns the number of rows.

See Also:

• setRows(int rows)

getText

public String getText()

Returns the current content.

setText

public void setText(String text)

Sets the content of the text area.

The default text is "".

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.

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

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()

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)