001 /*
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
003 *
004 * This code is free software; you can redistribute it and/or modify it
005 * under the terms of the GNU General Public License version 2 only, as
006 * published by the Free Software Foundation. Sun designates this
007 * particular file as subject to the "Classpath" exception as provided
008 * by Sun in the LICENSE file that accompanied this code.
009 *
010 * This code is distributed in the hope that it will be useful, but WITHOUT
011 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
012 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
013 * version 2 for more details (a copy is included in the LICENSE file that
014 * accompanied this code).
015 *
016 * You should have received a copy of the GNU General Public License version
017 * 2 along with this work; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
019 *
020 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
021 * CA 95054 USA or visit www.sun.com if you need additional information or
022 * have any questions.
023 */
024
025 /*
026 * This file is available under and governed by the GNU General Public
027 * License version 2 only, as published by the Free Software Foundation.
028 * However, the following notice accompanied the original version of this
029 * file and, per its terms, should not be removed:
030 *
031 * Copyright (c) 2000 World Wide Web Consortium,
032 * (Massachusetts Institute of Technology, Institut National de
033 * Recherche en Informatique et en Automatique, Keio University). All
034 * Rights Reserved. This program is distributed under the W3C's Software
035 * Intellectual Property License. This program is distributed in the
036 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
037 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
038 * PURPOSE. See W3C License http://www.w3.org/Consortium/Legal/ for more
039 * details.
040 */
041
042 package org.w3c.dom.html;
043
044 /**
045 * Form control. Note. Depending upon the environment in which the page is
046 * being viewed, the value property may be read-only for the file upload
047 * input type. For the "password" input type, the actual value returned may
048 * be masked to prevent unauthorized use. See the INPUT element definition
049 * in HTML 4.0.
050 * <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>.
051 */
052 public interface HTMLInputElement extends HTMLElement {
053 /**
054 * When the <code>type</code> attribute of the element has the value
055 * "Text", "File" or "Password", this represents the HTML value attribute
056 * of the element. The value of this attribute does not change if the
057 * contents of the corresponding form control, in an interactive user
058 * agent, changes. Changing this attribute, however, resets the contents
059 * of the form control. See the value attribute definition in HTML 4.0.
060 */
061 public String getDefaultValue();
062
063 public void setDefaultValue(String defaultValue);
064
065 /**
066 * When <code>type</code> has the value "Radio" or "Checkbox", this
067 * represents the HTML checked attribute of the element. The value of
068 * this attribute does not change if the state of the corresponding form
069 * control, in an interactive user agent, changes. Changes to this
070 * attribute, however, resets the state of the form control. See the
071 * checked attribute definition in HTML 4.0.
072 */
073 public boolean getDefaultChecked();
074
075 public void setDefaultChecked(boolean defaultChecked);
076
077 /**
078 * Returns the <code>FORM</code> element containing this control. Returns
079 * <code>null</code> if this control is not within the context of a form.
080 */
081 public HTMLFormElement getForm();
082
083 /**
084 * A comma-separated list of content types that a server processing this
085 * form will handle correctly. See the accept attribute definition in
086 * HTML 4.0.
087 */
088 public String getAccept();
089
090 public void setAccept(String accept);
091
092 /**
093 * A single character access key to give access to the form control. See
094 * the accesskey attribute definition in HTML 4.0.
095 */
096 public String getAccessKey();
097
098 public void setAccessKey(String accessKey);
099
100 /**
101 * Aligns this object (vertically or horizontally) with respect to its
102 * surrounding text. See the align attribute definition in HTML 4.0.
103 * This attribute is deprecated in HTML 4.0.
104 */
105 public String getAlign();
106
107 public void setAlign(String align);
108
109 /**
110 * Alternate text for user agents not rendering the normal content of
111 * this element. See the alt attribute definition in HTML 4.0.
112 */
113 public String getAlt();
114
115 public void setAlt(String alt);
116
117 /**
118 * When the <code>type</code> attribute of the element has the value
119 * "Radio" or "Checkbox", this represents the current state of the form
120 * control, in an interactive user agent. Changes to this attribute
121 * change the state of the form control, but do not change the value of
122 * the HTML value attribute of the element.
123 */
124 public boolean getChecked();
125
126 public void setChecked(boolean checked);
127
128 /**
129 * The control is unavailable in this context. See the disabled
130 * attribute definition in HTML 4.0.
131 */
132 public boolean getDisabled();
133
134 public void setDisabled(boolean disabled);
135
136 /**
137 * Maximum number of characters for text fields, when <code>type</code>
138 * has the value "Text" or "Password". See the maxlength attribute
139 * definition in HTML 4.0.
140 */
141 public int getMaxLength();
142
143 public void setMaxLength(int maxLength);
144
145 /**
146 * Form control or object name when submitted with a form. See the name
147 * attribute definition in HTML 4.0.
148 */
149 public String getName();
150
151 public void setName(String name);
152
153 /**
154 * This control is read-only. Relevant only when <code>type</code> has
155 * the value "Text" or "Password". See the readonly attribute definition
156 * in HTML 4.0.
157 */
158 public boolean getReadOnly();
159
160 public void setReadOnly(boolean readOnly);
161
162 /**
163 * Size information. The precise meaning is specific to each type of
164 * field. See the size attribute definition in HTML 4.0.
165 */
166 public String getSize();
167
168 public void setSize(String size);
169
170 /**
171 * When the <code>type</code> attribute has the value "Image", this
172 * attribute specifies the location of the image to be used to decorate
173 * the graphical submit button. See the src attribute definition in HTML
174 * 4.0.
175 */
176 public String getSrc();
177
178 public void setSrc(String src);
179
180 /**
181 * Index that represents the element's position in the tabbing order. See
182 * the tabindex attribute definition in HTML 4.0.
183 */
184 public int getTabIndex();
185
186 public void setTabIndex(int tabIndex);
187
188 /**
189 * The type of control created. See the type attribute definition in
190 * HTML 4.0.
191 */
192 public String getType();
193
194 /**
195 * Use client-side image map. See the usemap attribute definition in
196 * HTML 4.0.
197 */
198 public String getUseMap();
199
200 public void setUseMap(String useMap);
201
202 /**
203 * When the <code>type</code> attribute of the element has the value
204 * "Text", "File" or "Password", this represents the current contents of
205 * the corresponding form control, in an interactive user agent. Changing
206 * this attribute changes the contents of the form control, but does not
207 * change the value of the HTML value attribute of the element. When the
208 * <code>type</code> attribute of the element has the value "Button",
209 * "Hidden", "Submit", "Reset", "Image", "Checkbox" or "Radio", this
210 * represents the HTML value attribute of the element. See the value
211 * attribute definition in HTML 4.0.
212 */
213 public String getValue();
214
215 public void setValue(String value);
216
217 /**
218 * Removes keyboard focus from this element.
219 */
220 public void blur();
221
222 /**
223 * Gives keyboard focus to this element.
224 */
225 public void focus();
226
227 /**
228 * Select the contents of the text area. For <code>INPUT</code> elements
229 * whose <code>type</code> attribute has one of the following values:
230 * "Text", "File", or "Password".
231 */
232 public void select();
233
234 /**
235 * Simulate a mouse-click. For <code>INPUT</code> elements whose
236 * <code>type</code> attribute has one of the following values: "Button",
237 * "Checkbox", "Radio", "Reset", or "Submit".
238 */
239 public void click();
240
241 }
|