com.vaadin.ui.TextArea Maven / Gradle / Ivy
/*
* Vaadin Framework 7
*
* 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.data.Property;
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() {
setValue("");
}
/**
* 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 property data source.
*
* @param dataSource
* the data source for the field
*/
public TextArea(Property dataSource) {
this();
setPropertyDataSource(dataSource);
}
/**
* Constructs a TextArea with given caption and property data source.
*
* @param caption
* the caption for the field
* @param dataSource
* the data source for the field
*/
public TextArea(String caption, Property dataSource) {
this(dataSource);
setCaption(caption);
}
/**
* Constructs a TextArea with given caption and value.
*
* @param caption
* the caption for the field
* @param value
* the value for the field
*/
public TextArea(String caption, String value) {
this(caption);
setValue(value);
}
@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.
*
* @param rows
* the number of rows for this text area.
*/
public void setRows(int rows) {
if (rows < 0) {
rows = 0;
}
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
* the boolean value specifying if the text area should be in
* word-wrap mode.
*/
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;
}
/*
* (non-Javadoc)
*
* @see com.vaadin.ui.AbstractField#readDesign(org.jsoup.nodes.Element ,
* com.vaadin.ui.declarative.DesignContext)
*/
@Override
public void readDesign(Element design, DesignContext designContext) {
super.readDesign(design, designContext);
setValue(DesignFormatter.decodeFromTextNode(design.html()), false,
true);
}
/*
* (non-Javadoc)
*
* @see com.vaadin.ui.AbstractTextField#writeDesign(org.jsoup.nodes.Element
* , com.vaadin.ui.declarative.DesignContext)
*/
@Override
public void writeDesign(Element design, DesignContext designContext) {
super.writeDesign(design, designContext);
design.html(DesignFormatter.encodeForTextNode(getValue()));
}
@Override
public void clear() {
setValue("");
}
}