com.google.gwt.dom.client.TextAreaElement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwt-mock-2.5.1 Show documentation
A mocked implementation for GWT-2.5.1 that can run in the JVM to allow integration testing
The newest version!
/*
 * Copyright 2008 Google Inc.
 * 
 * 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.google.gwt.dom.client;

/**
 * Multi-line text field.
 * 
 * @see W3C HTML Specification
 */
@TagName(TextAreaElement.TAG)
public class TextAreaElement extends Element {
	
	public static final String TAG = "textarea";
	
	/**
	 * Assert that the given {@link Element} is compatible with this class and
	 * automatically typecast it.
	 */
	public static TextAreaElement as(Element elem) {
		assert elem.getTagName().equalsIgnoreCase(TAG);
		return (TextAreaElement) elem;
	}
	
	public TextAreaElement() {
	}
	
	/**
	 * A single character access key to give access to the form control.
	 * 
	 * @see W3C HTML Specification
	 */
	public final native String getAccessKey() /*-{
															return this.accessKey;
															}-*/;
	
	/**
	 * Width of control (in characters).
	 * 
	 * @see W3C HTML Specification
	 */
	public final native int getCols() /*-{
													return this.cols;
													}-*/;
	
	/**
	 * Represents the contents of the element. The value of this attribute does
	 * not change if the contents of the corresponding form control, in an
	 * interactive user agent, changes.
	 */
	public final native String getDefaultValue() /*-{
																return this.defaultValue;
																}-*/;
	
	/**
	 * @deprecated use {@link #isDisabled()} instead
	 */
	@Deprecated
	public final native boolean getDisabled() /*-{
															return !!this.disabled;
															}-*/;
	
	/**
	 * Returns the FORM element containing this control. Returns null if this
	 * control is not within the context of a form.
	 */
	public final native FormElement getForm() /*-{
															return this.form;
															}-*/;
	
	/**
	 * Form control or object name when submitted with a form.
	 * 
	 * @see W3C HTML Specification
	 */
	public final native String getName() /*-{
														return this.name;
														}-*/;
	
	/**
	 * @deprecated use {@link #isReadOnly()} instead.
	 */
	@Deprecated
	public final native boolean getReadOnly() /*-{
															return !!this.readOnly;
															}-*/;
	
	/**
	 * Number of text rows.
	 * 
	 * @see W3C HTML Specification
	 */
	public final native int getRows() /*-{
													return this.rows;
													}-*/;
	
	/**
	 * The type of this form control. This the string "textarea".
	 */
	public final native String getType() /*-{
														return this.type;
														}-*/;
	
	/**
	 * Represents the current contents of the corresponding form control, in an
	 * interactive user agent. Changing this attribute changes the contents of the
	 * form control, but does not change the contents of the element. If the
	 * entirety of the data can not fit into a single string, the implementation
	 * may truncate the data.
	 */
	public final native String getValue() /*-{
														return this.value;
														}-*/;
	
	/**
	 * The control is unavailable in this context.
	 * 
	 * @see W3C HTML Specification
	 */
	public final native boolean isDisabled() /*-{
															return !!this.disabled;
															}-*/;
	
	/**
	 * This control is read-only.
	 * 
	 * @see W3C HTML Specification
	 */
	public final native boolean isReadOnly() /*-{
															return !!this.readOnly;
															}-*/;
	
	/**
	 * Select the contents of the TEXTAREA.
	 */
	public final native void select() /*-{
													this.select();
													}-*/;
	
	/**
	 * A single character access key to give access to the form control.
	 * 
	 * @see W3C HTML Specification
	 */
	public final native void setAccessKey(String accessKey) /*-{
																				this.accessKey = accessKey;
																				}-*/;
	
	/**
	 * Width of control (in characters).
	 * 
	 * @see W3C HTML Specification
	 */
	public final native void setCols(int cols) /*-{
																this.cols = cols;
																}-*/;
	
	/**
	 * Represents the contents of the element. The value of this attribute does
	 * not change if the contents of the corresponding form control, in an
	 * interactive user agent, changes.
	 */
	public final native void setDefaultValue(String defaultValue) /*-{
																						this.defaultValue = defaultValue;
																						}-*/;
	
	/**
	 * The control is unavailable in this context.
	 * 
	 * @see W3C HTML Specification
	 */
	public final native void setDisabled(boolean disabled) /*-{
																				this.disabled = disabled;
																				}-*/;
	
	/**
	 * Form control or object name when submitted with a form.
	 * 
	 * @see W3C HTML Specification
	 */
	public final native void setName(String name) /*-{
																	this.name = name;
																	}-*/;
	
	/**
	 * This control is read-only.
	 * 
	 * @see W3C HTML Specification
	 */
	public final native void setReadOnly(boolean readOnly) /*-{
																				this.readOnly = readOnly;
																				}-*/;
	
	/**
	 * Number of text rows.
	 * 
	 * @see W3C HTML Specification
	 */
	public final native void setRows(int rows) /*-{
																this.rows = rows;
																}-*/;
	
	/**
	 * Represents the current contents of the corresponding form control, in an
	 * interactive user agent. Changing this attribute changes the contents of the
	 * form control, but does not change the contents of the element. If the
	 * entirety of the data can not fit into a single string, the implementation
	 * may truncate the data.
	 */
	public final native void setValue(String value) /*-{
																	this.value = value;
																	}-*/;
}