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

Field Summary

Fields inherited from class eu.webtoolkit.jwt.WWidget

WT_GETPS_JS

Constructor Summary

WTextArea()
Creates a text area with empty content and optional parent.

WTextArea(java.lang.String text)
Creates a text area with given content and optional parent.

WTextArea(java.lang.String text, WContainerWidget parent)
Creates a text area with given content and optional parent.

WTextArea(WContainerWidget parent)
Creates a text area with empty content and optional parent.

Method Summary

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.
java.lang.String	getSelectedText() Returns the currently selected text.
int	getSelectionStart() Returns the current selection start.
java.lang.String	getText() Returns the current content.
java.lang.String	getValueText() Returns the current value.
boolean	hasSelectedText() Returns whether there is selected text.
void	setColumns(int columns) Sets the number of columns.
void	setRows(int rows) Sets the number of rows.
void	setText(java.lang.String text) Sets the content of the text area.
void	setValueText(java.lang.String value) Sets the current value.

Methods inherited from class eu.webtoolkit.jwt.WFormWidget

blurred, changed, enableAjax, focussed, getEmptyText, getLabel, getTabIndex, getValidator, hasFocus, isReadOnly, propagateSetEnabled, refresh, remove, render, selected, setEmptyText, setEnabled, setFocus, setFocus, setHidden, setReadOnly, setTabIndex, setToolTip, setValidator, validate, validated

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, touchEnded, touchMoved, touchStarted

Methods inherited from class eu.webtoolkit.jwt.WWebWidget

addStyleClass, callJavaScriptMember, childrenChanged, createActualElement, doJavaScript, escapeText, escapeText, escapeText, escapeText, find, findById, getAttributeValue, getChildren, getClearSides, getDecorationStyle, getFloatSide, getHeight, getId, getJavaScriptMember, getLineHeight, getMargin, getMaximumHeight, getMaximumWidth, getMinimumHeight, getMinimumWidth, getOffset, getPositionScheme, getSelfWidget, getStyleClass, getToolTip, getVerticalAlignment, getVerticalAlignmentLength, getWidth, hasStyleClass, isDisabled, isHidden, isHiddenKeepsGeometry, isInline, isLoaded, isPopup, isRendered, isVisible, jsStringLiteral, jsStringLiteral, removeScript, removeStyleClass, resize, setAttributeValue, setClearSides, setDecorationStyle, setDisabled, setFloatSide, setHiddenKeepsGeometry, setId, setInline, setJavaScriptMember, setLineHeight, setLoadLaterWhenInvisible, setMargin, setMaximumSize, setMinimumSize, setOffsets, setPopup, setPositionScheme, setSelectable, setStyleClass, setVerticalAlignment, updateSignalConnection

Methods inherited from class eu.webtoolkit.jwt.WWidget

acceptDrops, acceptDrops, addCssRule, addCssRule, addStyleClass, animateHide, animateShow, createJavaScript, disable, dropEvent, enable, getDrop, getJsRef, getParent, hide, htmlText, isExposed, isLayoutSizeAware, layoutSizeChanged, positionAt, positionAt, removeStyleClass, resize, scheduleRender, scheduleRerender, setClearSides, 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

addChild, getObjectName, setObjectName

Methods inherited from class java.lang.Object

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

Constructor Detail

WTextArea

public WTextArea(WContainerWidget parent)

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(java.lang.String text,
                 WContainerWidget parent)

Creates a text area with given content and optional parent.

WTextArea

public WTextArea(java.lang.String text)

Creates a text area with given content and optional parent.

Calls this(text, (WContainerWidget)null)

Method Detail

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 java.lang.String getText()

Returns the current content.

setText

public void setText(java.lang.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 java.lang.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 java.lang.String getValueText()

Returns the current value.

Returns getText().

Specified by:

getValueText in class WFormWidget

setValueText

public void setValueText(java.lang.String value)

Sets the current value.

Calls setText().

Specified by:

setValueText in class WFormWidget

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)