|
1 /* |
|
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
|
3 * |
|
4 * This code is free software; you can redistribute it and/or modify it |
|
5 * under the terms of the GNU General Public License version 2 only, as |
|
6 * published by the Free Software Foundation. Sun designates this |
|
7 * particular file as subject to the "Classpath" exception as provided |
|
8 * by Sun in the LICENSE file that accompanied this code. |
|
9 * |
|
10 * This code is distributed in the hope that it will be useful, but WITHOUT |
|
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
13 * version 2 for more details (a copy is included in the LICENSE file that |
|
14 * accompanied this code). |
|
15 * |
|
16 * You should have received a copy of the GNU General Public License version |
|
17 * 2 along with this work; if not, write to the Free Software Foundation, |
|
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
19 * |
|
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
|
21 * CA 95054 USA or visit www.sun.com if you need additional information or |
|
22 * have any questions. |
|
23 */ |
|
24 |
|
25 /* |
|
26 * This file is available under and governed by the GNU General Public |
|
27 * License version 2 only, as published by the Free Software Foundation. |
|
28 * However, the following notice accompanied the original version of this |
|
29 * file and, per its terms, should not be removed: |
|
30 * |
|
31 * Copyright (c) 2000 World Wide Web Consortium, |
|
32 * (Massachusetts Institute of Technology, Institut National de |
|
33 * Recherche en Informatique et en Automatique, Keio University). All |
|
34 * Rights Reserved. This program is distributed under the W3C's Software |
|
35 * Intellectual Property License. This program is distributed in the |
|
36 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even |
|
37 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR |
|
38 * PURPOSE. See W3C License http://www.w3.org/Consortium/Legal/ for more |
|
39 * details. |
|
40 */ |
|
41 |
|
42 package org.w3c.dom.html; |
|
43 |
|
44 /** |
|
45 * Form control. Note. Depending upon the environment in which the page is |
|
46 * being viewed, the value property may be read-only for the file upload |
|
47 * input type. For the "password" input type, the actual value returned may |
|
48 * be masked to prevent unauthorized use. See the INPUT element definition |
|
49 * in HTML 4.0. |
|
50 * <p>See also the <a href='http://www.w3.org/TR/2000/CR-DOM-Level-2-20000510'>Document Object Model (DOM) Level 2 Specification</a>. |
|
51 */ |
|
52 public interface HTMLInputElement extends HTMLElement { |
|
53 /** |
|
54 * When the <code>type</code> attribute of the element has the value |
|
55 * "Text", "File" or "Password", this represents the HTML value attribute |
|
56 * of the element. The value of this attribute does not change if the |
|
57 * contents of the corresponding form control, in an interactive user |
|
58 * agent, changes. Changing this attribute, however, resets the contents |
|
59 * of the form control. See the value attribute definition in HTML 4.0. |
|
60 */ |
|
61 public String getDefaultValue(); |
|
62 public void setDefaultValue(String defaultValue); |
|
63 |
|
64 /** |
|
65 * When <code>type</code> has the value "Radio" or "Checkbox", this |
|
66 * represents the HTML checked attribute of the element. The value of |
|
67 * this attribute does not change if the state of the corresponding form |
|
68 * control, in an interactive user agent, changes. Changes to this |
|
69 * attribute, however, resets the state of the form control. See the |
|
70 * checked attribute definition in HTML 4.0. |
|
71 */ |
|
72 public boolean getDefaultChecked(); |
|
73 public void setDefaultChecked(boolean defaultChecked); |
|
74 |
|
75 /** |
|
76 * Returns the <code>FORM</code> element containing this control. Returns |
|
77 * <code>null</code> if this control is not within the context of a form. |
|
78 */ |
|
79 public HTMLFormElement getForm(); |
|
80 |
|
81 /** |
|
82 * A comma-separated list of content types that a server processing this |
|
83 * form will handle correctly. See the accept attribute definition in |
|
84 * HTML 4.0. |
|
85 */ |
|
86 public String getAccept(); |
|
87 public void setAccept(String accept); |
|
88 |
|
89 /** |
|
90 * A single character access key to give access to the form control. See |
|
91 * the accesskey attribute definition in HTML 4.0. |
|
92 */ |
|
93 public String getAccessKey(); |
|
94 public void setAccessKey(String accessKey); |
|
95 |
|
96 /** |
|
97 * Aligns this object (vertically or horizontally) with respect to its |
|
98 * surrounding text. See the align attribute definition in HTML 4.0. |
|
99 * This attribute is deprecated in HTML 4.0. |
|
100 */ |
|
101 public String getAlign(); |
|
102 public void setAlign(String align); |
|
103 |
|
104 /** |
|
105 * Alternate text for user agents not rendering the normal content of |
|
106 * this element. See the alt attribute definition in HTML 4.0. |
|
107 */ |
|
108 public String getAlt(); |
|
109 public void setAlt(String alt); |
|
110 |
|
111 /** |
|
112 * When the <code>type</code> attribute of the element has the value |
|
113 * "Radio" or "Checkbox", this represents the current state of the form |
|
114 * control, in an interactive user agent. Changes to this attribute |
|
115 * change the state of the form control, but do not change the value of |
|
116 * the HTML value attribute of the element. |
|
117 */ |
|
118 public boolean getChecked(); |
|
119 public void setChecked(boolean checked); |
|
120 |
|
121 /** |
|
122 * The control is unavailable in this context. See the disabled |
|
123 * attribute definition in HTML 4.0. |
|
124 */ |
|
125 public boolean getDisabled(); |
|
126 public void setDisabled(boolean disabled); |
|
127 |
|
128 /** |
|
129 * Maximum number of characters for text fields, when <code>type</code> |
|
130 * has the value "Text" or "Password". See the maxlength attribute |
|
131 * definition in HTML 4.0. |
|
132 */ |
|
133 public int getMaxLength(); |
|
134 public void setMaxLength(int maxLength); |
|
135 |
|
136 /** |
|
137 * Form control or object name when submitted with a form. See the name |
|
138 * attribute definition in HTML 4.0. |
|
139 */ |
|
140 public String getName(); |
|
141 public void setName(String name); |
|
142 |
|
143 /** |
|
144 * This control is read-only. Relevant only when <code>type</code> has |
|
145 * the value "Text" or "Password". See the readonly attribute definition |
|
146 * in HTML 4.0. |
|
147 */ |
|
148 public boolean getReadOnly(); |
|
149 public void setReadOnly(boolean readOnly); |
|
150 |
|
151 /** |
|
152 * Size information. The precise meaning is specific to each type of |
|
153 * field. See the size attribute definition in HTML 4.0. |
|
154 */ |
|
155 public String getSize(); |
|
156 public void setSize(String size); |
|
157 |
|
158 /** |
|
159 * When the <code>type</code> attribute has the value "Image", this |
|
160 * attribute specifies the location of the image to be used to decorate |
|
161 * the graphical submit button. See the src attribute definition in HTML |
|
162 * 4.0. |
|
163 */ |
|
164 public String getSrc(); |
|
165 public void setSrc(String src); |
|
166 |
|
167 /** |
|
168 * Index that represents the element's position in the tabbing order. See |
|
169 * the tabindex attribute definition in HTML 4.0. |
|
170 */ |
|
171 public int getTabIndex(); |
|
172 public void setTabIndex(int tabIndex); |
|
173 |
|
174 /** |
|
175 * The type of control created. See the type attribute definition in |
|
176 * HTML 4.0. |
|
177 */ |
|
178 public String getType(); |
|
179 |
|
180 /** |
|
181 * Use client-side image map. See the usemap attribute definition in |
|
182 * HTML 4.0. |
|
183 */ |
|
184 public String getUseMap(); |
|
185 public void setUseMap(String useMap); |
|
186 |
|
187 /** |
|
188 * When the <code>type</code> attribute of the element has the value |
|
189 * "Text", "File" or "Password", this represents the current contents of |
|
190 * the corresponding form control, in an interactive user agent. Changing |
|
191 * this attribute changes the contents of the form control, but does not |
|
192 * change the value of the HTML value attribute of the element. When the |
|
193 * <code>type</code> attribute of the element has the value "Button", |
|
194 * "Hidden", "Submit", "Reset", "Image", "Checkbox" or "Radio", this |
|
195 * represents the HTML value attribute of the element. See the value |
|
196 * attribute definition in HTML 4.0. |
|
197 */ |
|
198 public String getValue(); |
|
199 public void setValue(String value); |
|
200 |
|
201 /** |
|
202 * Removes keyboard focus from this element. |
|
203 */ |
|
204 public void blur(); |
|
205 |
|
206 /** |
|
207 * Gives keyboard focus to this element. |
|
208 */ |
|
209 public void focus(); |
|
210 |
|
211 /** |
|
212 * Select the contents of the text area. For <code>INPUT</code> elements |
|
213 * whose <code>type</code> attribute has one of the following values: |
|
214 * "Text", "File", or "Password". |
|
215 */ |
|
216 public void select(); |
|
217 |
|
218 /** |
|
219 * Simulate a mouse-click. For <code>INPUT</code> elements whose |
|
220 * <code>type</code> attribute has one of the following values: "Button", |
|
221 * "Checkbox", "Radio", "Reset", or "Submit". |
|
222 */ |
|
223 public void click(); |
|
224 |
|
225 } |