com.vaadin.ui

Class TextArea

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractField<String>

com.vaadin.ui.AbstractTextField

com.vaadin.ui.TextArea

All Implemented Interfaces:

HasValue<String>, ContextClickEvent.ContextClickNotifier, MethodEventSource, ClientConnector, Sizeable, Connector, Component, Component.Focusable, HasValueChangeMode, Serializable

public class TextArea
extends AbstractTextField

A text field that supports multi line editing.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

Component.ErrorEvent, Component.Event, Component.Focusable, Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

Sizeable.Unit

Nested classes/interfaces inherited from interface com.vaadin.data.HasValue

HasValue.ValueChangeEvent<V>, HasValue.ValueChangeListener<V>

Field Summary

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor and Description
TextArea() Constructs an empty TextArea.
TextArea(HasValue.ValueChangeListener<String> valueChangeListener) Constructs a new TextArea with a value change listener.
TextArea(String caption) Constructs an empty TextArea with given caption.
TextArea(String caption, HasValue.ValueChangeListener<String> valueChangeListener) Constructs a new TextArea with the given caption and a value change listener.
TextArea(String caption, String value) Constructs a TextArea with given caption and value.
TextArea(String caption, String value, HasValue.ValueChangeListener<String> valueChangeListener) Constructs a new TextArea with the given caption, initial text contents and a value change listener.

Method Summary

Modifier and Type	Method and Description
int	getRows() Gets the number of rows in the text area.
protected TextAreaState	getState() Returns the shared state bean with information to be sent from the server to the client.
protected TextAreaState	getState(boolean markAsDirty) Returns the shared state for this connector.
boolean	isWordWrap() Tests if the text area is in word-wrap mode.
void	readDesign(org.jsoup.nodes.Element design, DesignContext designContext) Reads the component state from the given design.
void	setRows(int rows) Sets the number of rows in the text area.
void	setWordWrap(boolean wordWrap) Sets the text area's word-wrap mode on or off.
void	writeDesign(org.jsoup.nodes.Element design, DesignContext designContext) Writes the component state to the given design.

Methods inherited from class com.vaadin.ui.AbstractTextField

addBlurListener, addFocusListener, doSetValue, getCursorPosition, getCustomAttributes, getEmptyValue, getMaxLength, getPlaceholder, getValue, getValueChangeMode, getValueChangeTimeout, selectAll, setCursorPosition, setMaxLength, setPlaceholder, setSelection, setValue, setValueChangeMode, setValueChangeTimeout

Methods inherited from class com.vaadin.ui.AbstractField

addValueChangeListener, createValueChange, focus, getTabIndex, isDifferentValue, isReadOnly, isRequiredIndicatorVisible, setReadOnly, setRequiredIndicatorVisible, setTabIndex, setValue

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setStyleName, setVisible, setWidth, setWidth, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, removeListener, removeStyleName, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setVisible

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Methods inherited from interface com.vaadin.data.HasValue

clear, getOptionalValue, isEmpty

Constructor Detail

TextArea

public TextArea()

Constructs an empty TextArea.

TextArea

public TextArea(String caption)

Constructs an empty TextArea with given caption.

Parameters:

caption - the caption for the field.

TextArea

public TextArea(String caption,
                String value)

Constructs a TextArea with given caption and value.

Parameters:

caption - the caption for the field

value - the value for the field, not null

TextArea

public TextArea(HasValue.ValueChangeListener<String> valueChangeListener)

Constructs a new TextArea with a value change listener.

The listener is called when the value of this TextArea is changed either by the user or programmatically.

Parameters:

valueChangeListener - the value change listener, not null

Since:

8.0

TextArea

public TextArea(String caption,
                HasValue.ValueChangeListener<String> valueChangeListener)

Constructs a new TextArea with the given caption and a value change listener.

The listener is called when the value of this TextArea is changed either by the user or programmatically.

Parameters:

caption - the caption for the field

valueChangeListener - the value change listener, not null

Since:

8.0

TextArea

public TextArea(String caption,
                String value,
                HasValue.ValueChangeListener<String> valueChangeListener)

Constructs a new TextArea with the given caption, initial text contents and a value change listener.

The listener is called when the value of this TextArea is changed either by the user or programmatically.

Parameters:

caption - the caption for the field

value - the value for the field, not null

valueChangeListener - the value change listener, not null

Since:

8.0

Method Detail

getState

protected TextAreaState getState()

Description copied from class: AbstractComponent

Returns the shared state bean with information to be sent from the server to the client. Subclasses should override this method and set any relevant fields of the state returned by super.getState().

Overrides:

getState in class AbstractTextField

Returns:

updated component shared state

getState

protected TextAreaState getState(boolean markAsDirty)

Description copied from class: AbstractClientConnector

Returns the shared state for this connector.

Overrides:

getState in class AbstractTextField

Parameters:

markAsDirty - true if the connector should automatically be marked dirty, false otherwise

Returns:

The shared state for this connector. Never null.

See Also:

AbstractClientConnector.getState()

setRows

public void setRows(int rows)

Sets the number of rows in the text area.

Parameters:

rows - the number of rows for this text area.

getRows

public int getRows()

Gets the number of rows in the text area.

Returns:

number of explicitly set rows.

setWordWrap

public void setWordWrap(boolean wordWrap)

Sets the text area's word-wrap mode on or off.

Parameters:

wordWrap - true to use word-wrap mode false otherwise.

isWordWrap

public boolean isWordWrap()

Tests if the text area is in word-wrap mode.

Returns:

true if the component is in word-wrap mode, false if not.

readDesign

public void readDesign(org.jsoup.nodes.Element design,
                       DesignContext designContext)

Description copied from interface: Component

Reads the component state from the given design.

The component is responsible not only for updating its own state but also for ensuring that its children update their state based on the design.

It is assumed that the component is in its default state when this method is called. Reading should only take into consideration attributes specified in the design and not reset any unspecified attributes to their defaults.

This method must not modify the design.

Specified by:

readDesign in interface Component

Overrides:

readDesign in class AbstractTextField

Parameters:

design - The element to obtain the state from

designContext - The DesignContext instance used for parsing the design

writeDesign

public void writeDesign(org.jsoup.nodes.Element design,
                        DesignContext designContext)

Description copied from interface: Component

Writes the component state to the given design.

The component is responsible not only for writing its own state but also for ensuring that its children write their state to the design.

This method must not modify the component state.

Specified by:

writeDesign in interface Component

Overrides:

writeDesign in class AbstractTextField

Parameters:

design - The element to write the component state to. Any previous attributes or child nodes are not cleared.

designContext - The DesignContext instance used for writing the design