com.vaadin.ui.TextArea Maven / Gradle / Ivy
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.ui;
import org.jsoup.nodes.Element;
import com.vaadin.shared.ui.textarea.TextAreaServerRpc;
import com.vaadin.shared.ui.textarea.TextAreaState;
import com.vaadin.ui.declarative.DesignContext;
import com.vaadin.ui.declarative.DesignFormatter;
/**
* A text field that supports multi line editing.
*/
public class TextArea extends AbstractTextField {
/**
* Constructs an empty TextArea.
*/
public TextArea() {
registerRpc(new TextAreaServerRpc() {
@Override
public void setHeight(String height) {
TextArea.this.setHeight(height);
}
@Override
public void setWidth(String width) {
TextArea.this.setWidth(width);
}
});
clear();
}
/**
* Constructs an empty TextArea with given caption.
*
* @param caption
* the caption for the field.
*/
public TextArea(String caption) {
this();
setCaption(caption);
}
/**
* Constructs a TextArea with given caption and value.
*
* @param caption
* the caption for the field
* @param value
* the value for the field, not {@code null}
*/
public TextArea(String caption, String value) {
this(caption);
setValue(value);
}
/**
* Constructs a new {@code TextArea} with a value change listener.
*
* The listener is called when the value of this {@code TextArea} is changed
* either by the user or programmatically.
*
* @param valueChangeListener
* the value change listener, not {@code null}
* @since 8.0
*/
public TextArea(ValueChangeListener valueChangeListener) {
addValueChangeListener(valueChangeListener);
}
/**
* Constructs a new {@code TextArea} with the given caption and a value
* change listener.
*
* The listener is called when the value of this {@code TextArea} is changed
* either by the user or programmatically.
*
* @param caption
* the caption for the field
* @param valueChangeListener
* the value change listener, not {@code null}
* @since 8.0
*/
public TextArea(String caption,
ValueChangeListener valueChangeListener) {
this(valueChangeListener);
setCaption(caption);
}
/**
* Constructs a new {@code TextArea} with the given caption, initial text
* contents and a value change listener.
*
* The listener is called when the value of this {@code TextArea} is changed
* either by the user or programmatically.
*
* @param caption
* the caption for the field
* @param value
* the value for the field, not {@code null}
* @param valueChangeListener
* the value change listener, not {@code null}
* @since 8.0
*/
public TextArea(String caption, String value,
ValueChangeListener valueChangeListener) {
this(caption, value);
addValueChangeListener(valueChangeListener);
}
@Override
protected TextAreaState getState() {
return (TextAreaState) super.getState();
}
@Override
protected TextAreaState getState(boolean markAsDirty) {
return (TextAreaState) super.getState(markAsDirty);
}
/**
* Sets the number of rows in the text area.
*
* Note: it's not possible to display less than one row via this height
* setting method, so minimum number of rows has been set to 1.
*
* @param rows
* the number of rows for this text area.
*/
public void setRows(int rows) {
if (rows < 1) {
rows = 1;
}
getState().rows = rows;
}
/**
* Gets the number of rows in the text area.
*
* @return number of explicitly set rows.
*/
public int getRows() {
return getState(false).rows;
}
/**
* Sets the text area's word-wrap mode on or off.
*
* @param wordWrap
* true to use word-wrap mode false
* otherwise.
*/
public void setWordWrap(boolean wordWrap) {
getState().wordWrap = wordWrap;
}
/**
* Tests if the text area is in word-wrap mode.
*
* @return true if the component is in word-wrap mode,
* false if not.
*/
public boolean isWordWrap() {
return getState(false).wordWrap;
}
@Override
public void readDesign(Element design, DesignContext designContext) {
super.readDesign(design, designContext);
doSetValue(DesignFormatter.decodeFromTextNode(design.html()));
}
@Override
public void writeDesign(Element design, DesignContext designContext) {
super.writeDesign(design, designContext);
design.html(DesignFormatter.encodeForTextNode(getValue()));
}
}