com.vaadin.ui
Class TextArea

java.lang.Object
  com.vaadin.ui.AbstractComponent
      com.vaadin.ui.AbstractField
          com.vaadin.ui.AbstractTextField
              com.vaadin.ui.TextArea

All Implemented Interfaces:

Buffered, BufferedValidatable, Property, Property.Editor, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer, Validatable, Action.ShortcutNotifier, FieldEvents.BlurNotifier, FieldEvents.FocusNotifier, FieldEvents.TextChangeNotifier, MethodEventSource, Paintable, Sizeable, VariableOwner, Component, Component.Focusable, Field, Serializable, EventListener

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 class com.vaadin.ui.AbstractTextField

AbstractTextField.TextChangeEventImpl, AbstractTextField.TextChangeEventMode

Nested classes/interfaces inherited from class com.vaadin.ui.AbstractField

AbstractField.FocusShortcut, AbstractField.ReadOnlyStatusChangeEvent

Nested classes/interfaces inherited from class com.vaadin.ui.AbstractComponent

AbstractComponent.ComponentErrorEvent, AbstractComponent.ComponentErrorHandler

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

Field.ValueChangeEvent

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

Buffered.SourceException

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

Property.ConversionException, Property.Editor, Property.ReadOnlyException, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer

Constructor Summary

TextArea()
Constructs an empty TextArea.

TextArea(Property dataSource)
Constructs a TextArea with given property data source.

TextArea(String caption)
Constructs an empty TextArea with given caption.

TextArea(String caption, Property dataSource)
Constructs a TextArea with given caption and property data source.

TextArea(String caption, String value)
Constructs a TextArea with given caption and value.

Method Summary

int	getRows() Gets the number of rows in the text area.
boolean	isWordwrap() Tests if the text area is in word-wrap mode.
void	paintContent(PaintTarget target) Paints any needed component-specific things to the given UIDL stream.
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.

Methods inherited from class com.vaadin.ui.AbstractTextField

addListener, addListener, addListener, changeVariables, getColumns, getCursorPosition, getFormat, getFormattedValue, getInputPrompt, getMaxLength, getNullRepresentation, getTextChangeEventMode, getTextChangeTimeout, getType, getValue, isEmpty, isNullSettingAllowed, removeListener, removeListener, removeListener, selectAll, setColumns, setCursorPosition, setFormat, setInputPrompt, setInternalValue, setMaxLength, setNullRepresentation, setNullSettingAllowed, setSelectionRange, setTextChangeEventMode, setTextChangeTimeout, setValue

Methods inherited from class com.vaadin.ui.AbstractField

addListener, addListener, addShortcutListener, addValidator, attach, commit, constructField, detach, discard, fireReadOnlyStatusChange, fireValueChange, focus, getActionManager, getErrorMessage, getPropertyDataSource, getRequiredError, getTabIndex, getValidators, isInvalidAllowed, isInvalidCommitted, isModified, isReadOnly, isReadThrough, isRequired, isValid, isValidationVisible, isWriteThrough, readOnlyStatusChange, removeAllValidators, removeListener, removeListener, removeShortcutListener, removeValidator, setCurrentBufferedSourceException, setInvalidAllowed, setInvalidCommitted, setPropertyDataSource, setReadOnly, setReadThrough, setRequired, setRequiredError, setTabIndex, setValidationVisible, setValue, setWriteThrough, shouldHideErrors, toString, validate, valueChange

Methods inherited from class com.vaadin.ui.AbstractComponent

addListener, addListener, addListener, addListener, addListener, addStyleName, childRequestedRepaint, fireComponentErrorEvent, fireComponentEvent, fireEvent, getApplication, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorHandler, getHeight, getHeightUnits, getIcon, getListeners, getLocale, getParent, getStyle, getStyleName, getWidth, getWidthUnits, getWindow, handleError, hasListeners, isEnabled, isImmediate, isVisible, paint, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeStyleName, requestRepaint, requestRepaintRequests, setCaption, setComponentError, setData, setDebugId, setDescription, setEnabled, setErrorHandler, setHeight, setHeight, setHeight, setHeightUnits, setIcon, setImmediate, setLocale, setParent, setSizeFull, setSizeUndefined, setStyle, setStyleName, setVisible, setWidth, setWidth, setWidth, setWidthUnits

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.ui.Field

getDescription, setCaption, setDescription

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

Constructs a TextArea with given property data source.

Parameters:

dataSource - the data source for the field

TextArea

public TextArea(String caption,
                Property dataSource)

Constructs a TextArea with given caption and property data source.

Parameters:

caption - the caption for the field

dataSource - the data source 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

Method Detail

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 - the boolean value specifying if the text area should be in word-wrap mode.

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.

paintContent

public void paintContent(PaintTarget target)
                  throws PaintException

Description copied from class: AbstractComponent

Paints any needed component-specific things to the given UIDL stream. The more general AbstractComponent.paint(PaintTarget) method handles all general attributes common to all components, and it calls this method to paint any component-specific attributes to the UIDL stream.

Overrides:

paintContent in class AbstractTextField

Parameters:

target - the target UIDL stream where the component should paint itself to

Throws:

PaintException - if the paint operation failed.