1 /*
2  * Copyright (c) 2003 World Wide Web Consortium,
3  * (Massachusetts Institute of Technology, Institut National de
4  * Recherche en Informatique et en Automatique, Keio University). All
5  * Rights Reserved. This program is distributed under the W3C's Software
6  * Intellectual Property License. This program is distributed in the
7  * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
8  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
9  * PURPOSE.
10  * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
11  */
12 
13 package org.w3c.dom.html2;
14 
15 /**
16  * Multi-line text field. See the TEXTAREA element definition in HTML 4.01.
17  * <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>.
18  */
19 public interface HTMLTextAreaElement extends HTMLElement {
20     /**
21      * Represents the contents of the element. The value of this attribute
22      * does not change if the contents of the corresponding form control, in
23      * an interactive user agent, changes.
24      * @version DOM Level 2
25      */
getDefaultValue()26     public String getDefaultValue();
27     /**
28      * Represents the contents of the element. The value of this attribute
29      * does not change if the contents of the corresponding form control, in
30      * an interactive user agent, changes.
31      * @version DOM Level 2
32      */
setDefaultValue(String defaultValue)33     public void setDefaultValue(String defaultValue);
34 
35     /**
36      * Returns the <code>FORM</code> element containing this control. Returns
37      * <code>null</code> if this control is not within the context of a
38      * form.
39      */
getForm()40     public HTMLFormElement getForm();
41 
42     /**
43      * A single character access key to give access to the form control. See
44      * the accesskey attribute definition in HTML 4.01.
45      */
getAccessKey()46     public String getAccessKey();
47     /**
48      * A single character access key to give access to the form control. See
49      * the accesskey attribute definition in HTML 4.01.
50      */
setAccessKey(String accessKey)51     public void setAccessKey(String accessKey);
52 
53     /**
54      * Width of control (in characters). See the cols attribute definition in
55      * HTML 4.01.
56      */
getCols()57     public int getCols();
58     /**
59      * Width of control (in characters). See the cols attribute definition in
60      * HTML 4.01.
61      */
setCols(int cols)62     public void setCols(int cols);
63 
64     /**
65      * The control is unavailable in this context. See the disabled attribute
66      * definition in HTML 4.01.
67      */
getDisabled()68     public boolean getDisabled();
69     /**
70      * The control is unavailable in this context. See the disabled attribute
71      * definition in HTML 4.01.
72      */
setDisabled(boolean disabled)73     public void setDisabled(boolean disabled);
74 
75     /**
76      * Form control or object name when submitted with a form. See the name
77      * attribute definition in HTML 4.01.
78      */
getName()79     public String getName();
80     /**
81      * Form control or object name when submitted with a form. See the name
82      * attribute definition in HTML 4.01.
83      */
setName(String name)84     public void setName(String name);
85 
86     /**
87      * This control is read-only. See the readonly attribute definition in
88      * HTML 4.01.
89      */
getReadOnly()90     public boolean getReadOnly();
91     /**
92      * This control is read-only. See the readonly attribute definition in
93      * HTML 4.01.
94      */
setReadOnly(boolean readOnly)95     public void setReadOnly(boolean readOnly);
96 
97     /**
98      * Number of text rows. See the rows attribute definition in HTML 4.01.
99      */
getRows()100     public int getRows();
101     /**
102      * Number of text rows. See the rows attribute definition in HTML 4.01.
103      */
setRows(int rows)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      */
getTabIndex()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      */
setTabIndex(int tabIndex)115     public void setTabIndex(int tabIndex);
116 
117     /**
118      * The type of this form control. This the string "textarea".
119      */
getType()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      */
getValue()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      */
setValue(String value)137     public void setValue(String value);
138 
139     /**
140      * Removes keyboard focus from this element.
141      */
blur()142     public void blur();
143 
144     /**
145      * Gives keyboard focus to this element.
146      */
focus()147     public void focus();
148 
149     /**
150      * Select the contents of the <code>TEXTAREA</code>.
151      */
select()152     public void select();
153 
154 }
155