/* * Copyright 2000-2014 Vaadin Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not * use this file except in compliance with the License. You may obtain a copy of * the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the * License for the specific language governing permissions and limitations under * the License. */ package com.vaadin.ui; import com.vaadin.data.Property; import com.vaadin.shared.ui.textarea.TextAreaState; /** * 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(); } /** * 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().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().wordwrap; } }