001/*
002 * Copyright (c) 2003 World Wide Web Consortium,
003 * (Massachusetts Institute of Technology, Institut National de
004 * Recherche en Informatique et en Automatique, Keio University). All
005 * Rights Reserved. This program is distributed under the W3C's Software
006 * Intellectual Property License. This program is distributed in the
007 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
008 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
009 * PURPOSE.
010 * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
011 */
012
013package org.w3c.dom.html2;
014
015/**
016 * Multi-line text field. See the TEXTAREA element definition in HTML 4.01.
017 * <p>See also the <a href='http://www.w3.org/TR/2003/REC-DOM-Level-2-HTML-20030109'>Document Object Model (DOM) Level 2 HTML Specification</a>.
018 */
019public interface HTMLTextAreaElement extends HTMLElement {
020    /**
021     * Represents the contents of the element. The value of this attribute 
022     * does not change if the contents of the corresponding form control, in 
023     * an interactive user agent, changes.
024     * @version DOM Level 2
025     */
026    public String getDefaultValue();
027    /**
028     * Represents the contents of the element. The value of this attribute 
029     * does not change if the contents of the corresponding form control, in 
030     * an interactive user agent, changes.
031     * @version DOM Level 2
032     */
033    public void setDefaultValue(String defaultValue);
034
035    /**
036     * Returns the <code>FORM</code> element containing this control. Returns 
037     * <code>null</code> if this control is not within the context of a 
038     * form. 
039     */
040    public HTMLFormElement getForm();
041
042    /**
043     * A single character access key to give access to the form control. See 
044     * the accesskey attribute definition in HTML 4.01.
045     */
046    public String getAccessKey();
047    /**
048     * A single character access key to give access to the form control. See 
049     * the accesskey attribute definition in HTML 4.01.
050     */
051    public void setAccessKey(String accessKey);
052
053    /**
054     * Width of control (in characters). See the cols attribute definition in 
055     * HTML 4.01.
056     */
057    public int getCols();
058    /**
059     * Width of control (in characters). See the cols attribute definition in 
060     * HTML 4.01.
061     */
062    public void setCols(int cols);
063
064    /**
065     * The control is unavailable in this context. See the disabled attribute 
066     * definition in HTML 4.01.
067     */
068    public boolean getDisabled();
069    /**
070     * The control is unavailable in this context. See the disabled attribute 
071     * definition in HTML 4.01.
072     */
073    public void setDisabled(boolean disabled);
074
075    /**
076     * Form control or object name when submitted with a form. See the name 
077     * attribute definition in HTML 4.01.
078     */
079    public String getName();
080    /**
081     * Form control or object name when submitted with a form. See the name 
082     * attribute definition in HTML 4.01.
083     */
084    public void setName(String name);
085
086    /**
087     * This control is read-only. See the readonly attribute definition in 
088     * HTML 4.01.
089     */
090    public boolean getReadOnly();
091    /**
092     * This control is read-only. See the readonly attribute definition in 
093     * HTML 4.01.
094     */
095    public void setReadOnly(boolean readOnly);
096
097    /**
098     * Number of text rows. See the rows attribute definition in HTML 4.01.
099     */
100    public int getRows();
101    /**
102     * Number of text rows. See the rows attribute definition in HTML 4.01.
103     */
104    public void setRows(int rows);
105
106    /**
107     * Index that represents the element's position in the tabbing order. See 
108     * the tabindex attribute definition in HTML 4.01.
109     */
110    public int getTabIndex();
111    /**
112     * Index that represents the element's position in the tabbing order. See 
113     * the tabindex attribute definition in HTML 4.01.
114     */
115    public void setTabIndex(int tabIndex);
116
117    /**
118     * The type of this form control. This the string "textarea".
119     */
120    public String getType();
121
122    /**
123     * Represents the current contents of the corresponding form control, in 
124     * an interactive user agent. Changing this attribute changes the 
125     * contents of the form control, but does not change the contents of the 
126     * element. If the entirety of the data can not fit into a single 
127     * <code>DOMString</code>, the implementation may truncate the data.
128     */
129    public String getValue();
130    /**
131     * Represents the current contents of the corresponding form control, in 
132     * an interactive user agent. Changing this attribute changes the 
133     * contents of the form control, but does not change the contents of the 
134     * element. If the entirety of the data can not fit into a single 
135     * <code>DOMString</code>, the implementation may truncate the data.
136     */
137    public void setValue(String value);
138
139    /**
140     * Removes keyboard focus from this element.
141     */
142    public void blur();
143
144    /**
145     * Gives keyboard focus to this element.
146     */
147    public void focus();
148
149    /**
150     * Select the contents of the <code>TEXTAREA</code>.
151     */
152    public void select();
153
154}